Show / Hide Table of Contents

Class YieldGroupServiceClient

YieldGroupService client wrapper, for convenient use.

Inheritance
object
YieldGroupServiceClient
YieldGroupServiceClientImpl
Inherited Members
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public abstract class YieldGroupServiceClient
Remarks

Provides methods for handling YieldGroup objects.

Properties

DefaultEndpoint

The default endpoint for the YieldGroupService service, which is a host of "admanager.googleapis.com" and a port of 443.

Declaration
public static string DefaultEndpoint { get; }
Property Value
Type Description
string

DefaultScopes

The default YieldGroupService scopes.

Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
Type Description
IReadOnlyList<string>
Remarks

The default YieldGroupService scopes are:

  • https://www.googleapis.com/auth/admanager
  • https://www.googleapis.com/auth/admanager.readonly

GrpcClient

The underlying gRPC YieldGroupService client

Declaration
public virtual YieldGroupService.YieldGroupServiceClient GrpcClient { get; }
Property Value
Type Description
YieldGroupService.YieldGroupServiceClient

ServiceMetadata

The service metadata associated with this client type.

Declaration
public static ServiceMetadata ServiceMetadata { get; }
Property Value
Type Description
ServiceMetadata

Methods

BatchActivateYieldGroups(BatchActivateYieldGroupsRequest, CallSettings)

Activates a list of YieldGroup objects.

Declaration
public virtual BatchActivateYieldGroupsResponse BatchActivateYieldGroups(BatchActivateYieldGroupsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchActivateYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchActivateYieldGroupsResponse

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
BatchActivateYieldGroupsRequest request = new BatchActivateYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    YieldGroupNames =
    {
        YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
    },
};
// Make the request
BatchActivateYieldGroupsResponse response = yieldGroupServiceClient.BatchActivateYieldGroups(request);

BatchActivateYieldGroups(NetworkName, IEnumerable<YieldGroupName>, CallSettings)

Activates a list of YieldGroup objects.

Declaration
public virtual BatchActivateYieldGroupsResponse BatchActivateYieldGroups(NetworkName parent, IEnumerable<YieldGroupName> names, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<YieldGroupName> names

Required. The resource names of the YieldGroups to activate. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchActivateYieldGroupsResponse

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<YieldGroupName> names = new YieldGroupName[]
{
    YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
};
// Make the request
BatchActivateYieldGroupsResponse response = yieldGroupServiceClient.BatchActivateYieldGroups(parent, names);

BatchActivateYieldGroups(string, IEnumerable<string>, CallSettings)

Activates a list of YieldGroup objects.

Declaration
public virtual BatchActivateYieldGroupsResponse BatchActivateYieldGroups(string parent, IEnumerable<string> names, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<string> names

Required. The resource names of the YieldGroups to activate. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchActivateYieldGroupsResponse

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<string> names = new string[]
{
    "networks/[NETWORK_CODE]/yieldGroups/[YIELD_GROUP]",
};
// Make the request
BatchActivateYieldGroupsResponse response = yieldGroupServiceClient.BatchActivateYieldGroups(parent, names);

BatchActivateYieldGroupsAsync(BatchActivateYieldGroupsRequest, CallSettings)

Activates a list of YieldGroup objects.

Declaration
public virtual Task<BatchActivateYieldGroupsResponse> BatchActivateYieldGroupsAsync(BatchActivateYieldGroupsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchActivateYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchActivateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
BatchActivateYieldGroupsRequest request = new BatchActivateYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    YieldGroupNames =
    {
        YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
    },
};
// Make the request
BatchActivateYieldGroupsResponse response = await yieldGroupServiceClient.BatchActivateYieldGroupsAsync(request);

BatchActivateYieldGroupsAsync(BatchActivateYieldGroupsRequest, CancellationToken)

Activates a list of YieldGroup objects.

Declaration
public virtual Task<BatchActivateYieldGroupsResponse> BatchActivateYieldGroupsAsync(BatchActivateYieldGroupsRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
BatchActivateYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchActivateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
BatchActivateYieldGroupsRequest request = new BatchActivateYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    YieldGroupNames =
    {
        YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
    },
};
// Make the request
BatchActivateYieldGroupsResponse response = await yieldGroupServiceClient.BatchActivateYieldGroupsAsync(request);

BatchActivateYieldGroupsAsync(NetworkName, IEnumerable<YieldGroupName>, CallSettings)

Activates a list of YieldGroup objects.

Declaration
public virtual Task<BatchActivateYieldGroupsResponse> BatchActivateYieldGroupsAsync(NetworkName parent, IEnumerable<YieldGroupName> names, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<YieldGroupName> names

Required. The resource names of the YieldGroups to activate. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchActivateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<YieldGroupName> names = new YieldGroupName[]
{
    YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
};
// Make the request
BatchActivateYieldGroupsResponse response = await yieldGroupServiceClient.BatchActivateYieldGroupsAsync(parent, names);

BatchActivateYieldGroupsAsync(NetworkName, IEnumerable<YieldGroupName>, CancellationToken)

Activates a list of YieldGroup objects.

Declaration
public virtual Task<BatchActivateYieldGroupsResponse> BatchActivateYieldGroupsAsync(NetworkName parent, IEnumerable<YieldGroupName> names, CancellationToken cancellationToken)
Parameters
Type Name Description
NetworkName parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<YieldGroupName> names

Required. The resource names of the YieldGroups to activate. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchActivateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<YieldGroupName> names = new YieldGroupName[]
{
    YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
};
// Make the request
BatchActivateYieldGroupsResponse response = await yieldGroupServiceClient.BatchActivateYieldGroupsAsync(parent, names);

BatchActivateYieldGroupsAsync(string, IEnumerable<string>, CallSettings)

Activates a list of YieldGroup objects.

Declaration
public virtual Task<BatchActivateYieldGroupsResponse> BatchActivateYieldGroupsAsync(string parent, IEnumerable<string> names, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<string> names

Required. The resource names of the YieldGroups to activate. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchActivateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<string> names = new string[]
{
    "networks/[NETWORK_CODE]/yieldGroups/[YIELD_GROUP]",
};
// Make the request
BatchActivateYieldGroupsResponse response = await yieldGroupServiceClient.BatchActivateYieldGroupsAsync(parent, names);

BatchActivateYieldGroupsAsync(string, IEnumerable<string>, CancellationToken)

Activates a list of YieldGroup objects.

Declaration
public virtual Task<BatchActivateYieldGroupsResponse> BatchActivateYieldGroupsAsync(string parent, IEnumerable<string> names, CancellationToken cancellationToken)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<string> names

Required. The resource names of the YieldGroups to activate. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchActivateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<string> names = new string[]
{
    "networks/[NETWORK_CODE]/yieldGroups/[YIELD_GROUP]",
};
// Make the request
BatchActivateYieldGroupsResponse response = await yieldGroupServiceClient.BatchActivateYieldGroupsAsync(parent, names);

BatchArchiveYieldGroups(BatchArchiveYieldGroupsRequest, CallSettings)

Archives a list of YieldGroup objects.

Declaration
public virtual BatchArchiveYieldGroupsResponse BatchArchiveYieldGroups(BatchArchiveYieldGroupsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchArchiveYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchArchiveYieldGroupsResponse

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
BatchArchiveYieldGroupsRequest request = new BatchArchiveYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    YieldGroupNames =
    {
        YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
    },
};
// Make the request
BatchArchiveYieldGroupsResponse response = yieldGroupServiceClient.BatchArchiveYieldGroups(request);

BatchArchiveYieldGroups(NetworkName, IEnumerable<YieldGroupName>, CallSettings)

Archives a list of YieldGroup objects.

Declaration
public virtual BatchArchiveYieldGroupsResponse BatchArchiveYieldGroups(NetworkName parent, IEnumerable<YieldGroupName> names, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<YieldGroupName> names

Required. The resource names of the YieldGroups to archive. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchArchiveYieldGroupsResponse

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<YieldGroupName> names = new YieldGroupName[]
{
    YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
};
// Make the request
BatchArchiveYieldGroupsResponse response = yieldGroupServiceClient.BatchArchiveYieldGroups(parent, names);

BatchArchiveYieldGroups(string, IEnumerable<string>, CallSettings)

Archives a list of YieldGroup objects.

Declaration
public virtual BatchArchiveYieldGroupsResponse BatchArchiveYieldGroups(string parent, IEnumerable<string> names, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<string> names

Required. The resource names of the YieldGroups to archive. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchArchiveYieldGroupsResponse

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<string> names = new string[]
{
    "networks/[NETWORK_CODE]/yieldGroups/[YIELD_GROUP]",
};
// Make the request
BatchArchiveYieldGroupsResponse response = yieldGroupServiceClient.BatchArchiveYieldGroups(parent, names);

BatchArchiveYieldGroupsAsync(BatchArchiveYieldGroupsRequest, CallSettings)

Archives a list of YieldGroup objects.

Declaration
public virtual Task<BatchArchiveYieldGroupsResponse> BatchArchiveYieldGroupsAsync(BatchArchiveYieldGroupsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchArchiveYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchArchiveYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
BatchArchiveYieldGroupsRequest request = new BatchArchiveYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    YieldGroupNames =
    {
        YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
    },
};
// Make the request
BatchArchiveYieldGroupsResponse response = await yieldGroupServiceClient.BatchArchiveYieldGroupsAsync(request);

BatchArchiveYieldGroupsAsync(BatchArchiveYieldGroupsRequest, CancellationToken)

Archives a list of YieldGroup objects.

Declaration
public virtual Task<BatchArchiveYieldGroupsResponse> BatchArchiveYieldGroupsAsync(BatchArchiveYieldGroupsRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
BatchArchiveYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchArchiveYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
BatchArchiveYieldGroupsRequest request = new BatchArchiveYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    YieldGroupNames =
    {
        YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
    },
};
// Make the request
BatchArchiveYieldGroupsResponse response = await yieldGroupServiceClient.BatchArchiveYieldGroupsAsync(request);

BatchArchiveYieldGroupsAsync(NetworkName, IEnumerable<YieldGroupName>, CallSettings)

Archives a list of YieldGroup objects.

Declaration
public virtual Task<BatchArchiveYieldGroupsResponse> BatchArchiveYieldGroupsAsync(NetworkName parent, IEnumerable<YieldGroupName> names, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<YieldGroupName> names

Required. The resource names of the YieldGroups to archive. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchArchiveYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<YieldGroupName> names = new YieldGroupName[]
{
    YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
};
// Make the request
BatchArchiveYieldGroupsResponse response = await yieldGroupServiceClient.BatchArchiveYieldGroupsAsync(parent, names);

BatchArchiveYieldGroupsAsync(NetworkName, IEnumerable<YieldGroupName>, CancellationToken)

Archives a list of YieldGroup objects.

Declaration
public virtual Task<BatchArchiveYieldGroupsResponse> BatchArchiveYieldGroupsAsync(NetworkName parent, IEnumerable<YieldGroupName> names, CancellationToken cancellationToken)
Parameters
Type Name Description
NetworkName parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<YieldGroupName> names

Required. The resource names of the YieldGroups to archive. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchArchiveYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<YieldGroupName> names = new YieldGroupName[]
{
    YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
};
// Make the request
BatchArchiveYieldGroupsResponse response = await yieldGroupServiceClient.BatchArchiveYieldGroupsAsync(parent, names);

BatchArchiveYieldGroupsAsync(string, IEnumerable<string>, CallSettings)

Archives a list of YieldGroup objects.

Declaration
public virtual Task<BatchArchiveYieldGroupsResponse> BatchArchiveYieldGroupsAsync(string parent, IEnumerable<string> names, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<string> names

Required. The resource names of the YieldGroups to archive. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchArchiveYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<string> names = new string[]
{
    "networks/[NETWORK_CODE]/yieldGroups/[YIELD_GROUP]",
};
// Make the request
BatchArchiveYieldGroupsResponse response = await yieldGroupServiceClient.BatchArchiveYieldGroupsAsync(parent, names);

BatchArchiveYieldGroupsAsync(string, IEnumerable<string>, CancellationToken)

Archives a list of YieldGroup objects.

Declaration
public virtual Task<BatchArchiveYieldGroupsResponse> BatchArchiveYieldGroupsAsync(string parent, IEnumerable<string> names, CancellationToken cancellationToken)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<string> names

Required. The resource names of the YieldGroups to archive. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchArchiveYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<string> names = new string[]
{
    "networks/[NETWORK_CODE]/yieldGroups/[YIELD_GROUP]",
};
// Make the request
BatchArchiveYieldGroupsResponse response = await yieldGroupServiceClient.BatchArchiveYieldGroupsAsync(parent, names);

BatchCreateYieldGroups(BatchCreateYieldGroupsRequest, CallSettings)

Batch creates YieldGroup objects.

Declaration
public virtual BatchCreateYieldGroupsResponse BatchCreateYieldGroups(BatchCreateYieldGroupsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchCreateYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchCreateYieldGroupsResponse

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
BatchCreateYieldGroupsRequest request = new BatchCreateYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Requests =
    {
        new CreateYieldGroupRequest(),
    },
};
// Make the request
BatchCreateYieldGroupsResponse response = yieldGroupServiceClient.BatchCreateYieldGroups(request);

BatchCreateYieldGroups(NetworkName, IEnumerable<CreateYieldGroupRequest>, CallSettings)

Batch creates YieldGroup objects.

Declaration
public virtual BatchCreateYieldGroupsResponse BatchCreateYieldGroups(NetworkName parent, IEnumerable<CreateYieldGroupRequest> requests, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent resource where YieldGroups will be created. Format: networks/{network_code} The parent field in the CreateYieldGroupRequest must match this field.

IEnumerable<CreateYieldGroupRequest> requests

Required. The YieldGroup objects to create. A maximum of 100 objects can be created in a batch.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchCreateYieldGroupsResponse

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<CreateYieldGroupRequest> requests = new CreateYieldGroupRequest[]
{
    new CreateYieldGroupRequest(),
};
// Make the request
BatchCreateYieldGroupsResponse response = yieldGroupServiceClient.BatchCreateYieldGroups(parent, requests);

BatchCreateYieldGroups(string, IEnumerable<CreateYieldGroupRequest>, CallSettings)

Batch creates YieldGroup objects.

Declaration
public virtual BatchCreateYieldGroupsResponse BatchCreateYieldGroups(string parent, IEnumerable<CreateYieldGroupRequest> requests, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent resource where YieldGroups will be created. Format: networks/{network_code} The parent field in the CreateYieldGroupRequest must match this field.

IEnumerable<CreateYieldGroupRequest> requests

Required. The YieldGroup objects to create. A maximum of 100 objects can be created in a batch.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchCreateYieldGroupsResponse

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<CreateYieldGroupRequest> requests = new CreateYieldGroupRequest[]
{
    new CreateYieldGroupRequest(),
};
// Make the request
BatchCreateYieldGroupsResponse response = yieldGroupServiceClient.BatchCreateYieldGroups(parent, requests);

BatchCreateYieldGroupsAsync(BatchCreateYieldGroupsRequest, CallSettings)

Batch creates YieldGroup objects.

Declaration
public virtual Task<BatchCreateYieldGroupsResponse> BatchCreateYieldGroupsAsync(BatchCreateYieldGroupsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchCreateYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchCreateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
BatchCreateYieldGroupsRequest request = new BatchCreateYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Requests =
    {
        new CreateYieldGroupRequest(),
    },
};
// Make the request
BatchCreateYieldGroupsResponse response = await yieldGroupServiceClient.BatchCreateYieldGroupsAsync(request);

BatchCreateYieldGroupsAsync(BatchCreateYieldGroupsRequest, CancellationToken)

Batch creates YieldGroup objects.

Declaration
public virtual Task<BatchCreateYieldGroupsResponse> BatchCreateYieldGroupsAsync(BatchCreateYieldGroupsRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
BatchCreateYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchCreateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
BatchCreateYieldGroupsRequest request = new BatchCreateYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Requests =
    {
        new CreateYieldGroupRequest(),
    },
};
// Make the request
BatchCreateYieldGroupsResponse response = await yieldGroupServiceClient.BatchCreateYieldGroupsAsync(request);

BatchCreateYieldGroupsAsync(NetworkName, IEnumerable<CreateYieldGroupRequest>, CallSettings)

Batch creates YieldGroup objects.

Declaration
public virtual Task<BatchCreateYieldGroupsResponse> BatchCreateYieldGroupsAsync(NetworkName parent, IEnumerable<CreateYieldGroupRequest> requests, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent resource where YieldGroups will be created. Format: networks/{network_code} The parent field in the CreateYieldGroupRequest must match this field.

IEnumerable<CreateYieldGroupRequest> requests

Required. The YieldGroup objects to create. A maximum of 100 objects can be created in a batch.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchCreateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<CreateYieldGroupRequest> requests = new CreateYieldGroupRequest[]
{
    new CreateYieldGroupRequest(),
};
// Make the request
BatchCreateYieldGroupsResponse response = await yieldGroupServiceClient.BatchCreateYieldGroupsAsync(parent, requests);

BatchCreateYieldGroupsAsync(NetworkName, IEnumerable<CreateYieldGroupRequest>, CancellationToken)

Batch creates YieldGroup objects.

Declaration
public virtual Task<BatchCreateYieldGroupsResponse> BatchCreateYieldGroupsAsync(NetworkName parent, IEnumerable<CreateYieldGroupRequest> requests, CancellationToken cancellationToken)
Parameters
Type Name Description
NetworkName parent

Required. The parent resource where YieldGroups will be created. Format: networks/{network_code} The parent field in the CreateYieldGroupRequest must match this field.

IEnumerable<CreateYieldGroupRequest> requests

Required. The YieldGroup objects to create. A maximum of 100 objects can be created in a batch.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchCreateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<CreateYieldGroupRequest> requests = new CreateYieldGroupRequest[]
{
    new CreateYieldGroupRequest(),
};
// Make the request
BatchCreateYieldGroupsResponse response = await yieldGroupServiceClient.BatchCreateYieldGroupsAsync(parent, requests);

BatchCreateYieldGroupsAsync(string, IEnumerable<CreateYieldGroupRequest>, CallSettings)

Batch creates YieldGroup objects.

Declaration
public virtual Task<BatchCreateYieldGroupsResponse> BatchCreateYieldGroupsAsync(string parent, IEnumerable<CreateYieldGroupRequest> requests, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent resource where YieldGroups will be created. Format: networks/{network_code} The parent field in the CreateYieldGroupRequest must match this field.

IEnumerable<CreateYieldGroupRequest> requests

Required. The YieldGroup objects to create. A maximum of 100 objects can be created in a batch.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchCreateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<CreateYieldGroupRequest> requests = new CreateYieldGroupRequest[]
{
    new CreateYieldGroupRequest(),
};
// Make the request
BatchCreateYieldGroupsResponse response = await yieldGroupServiceClient.BatchCreateYieldGroupsAsync(parent, requests);

BatchCreateYieldGroupsAsync(string, IEnumerable<CreateYieldGroupRequest>, CancellationToken)

Batch creates YieldGroup objects.

Declaration
public virtual Task<BatchCreateYieldGroupsResponse> BatchCreateYieldGroupsAsync(string parent, IEnumerable<CreateYieldGroupRequest> requests, CancellationToken cancellationToken)
Parameters
Type Name Description
string parent

Required. The parent resource where YieldGroups will be created. Format: networks/{network_code} The parent field in the CreateYieldGroupRequest must match this field.

IEnumerable<CreateYieldGroupRequest> requests

Required. The YieldGroup objects to create. A maximum of 100 objects can be created in a batch.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchCreateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<CreateYieldGroupRequest> requests = new CreateYieldGroupRequest[]
{
    new CreateYieldGroupRequest(),
};
// Make the request
BatchCreateYieldGroupsResponse response = await yieldGroupServiceClient.BatchCreateYieldGroupsAsync(parent, requests);

BatchDeactivateYieldGroups(BatchDeactivateYieldGroupsRequest, CallSettings)

Deactivates a list of YieldGroup objects.

Declaration
public virtual BatchDeactivateYieldGroupsResponse BatchDeactivateYieldGroups(BatchDeactivateYieldGroupsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchDeactivateYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchDeactivateYieldGroupsResponse

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
BatchDeactivateYieldGroupsRequest request = new BatchDeactivateYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    YieldGroupNames =
    {
        YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
    },
};
// Make the request
BatchDeactivateYieldGroupsResponse response = yieldGroupServiceClient.BatchDeactivateYieldGroups(request);

BatchDeactivateYieldGroups(NetworkName, IEnumerable<YieldGroupName>, CallSettings)

Deactivates a list of YieldGroup objects.

Declaration
public virtual BatchDeactivateYieldGroupsResponse BatchDeactivateYieldGroups(NetworkName parent, IEnumerable<YieldGroupName> names, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<YieldGroupName> names

Required. The resource names of the YieldGroups to deactivate. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchDeactivateYieldGroupsResponse

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<YieldGroupName> names = new YieldGroupName[]
{
    YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
};
// Make the request
BatchDeactivateYieldGroupsResponse response = yieldGroupServiceClient.BatchDeactivateYieldGroups(parent, names);

BatchDeactivateYieldGroups(string, IEnumerable<string>, CallSettings)

Deactivates a list of YieldGroup objects.

Declaration
public virtual BatchDeactivateYieldGroupsResponse BatchDeactivateYieldGroups(string parent, IEnumerable<string> names, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<string> names

Required. The resource names of the YieldGroups to deactivate. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchDeactivateYieldGroupsResponse

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<string> names = new string[]
{
    "networks/[NETWORK_CODE]/yieldGroups/[YIELD_GROUP]",
};
// Make the request
BatchDeactivateYieldGroupsResponse response = yieldGroupServiceClient.BatchDeactivateYieldGroups(parent, names);

BatchDeactivateYieldGroupsAsync(BatchDeactivateYieldGroupsRequest, CallSettings)

Deactivates a list of YieldGroup objects.

Declaration
public virtual Task<BatchDeactivateYieldGroupsResponse> BatchDeactivateYieldGroupsAsync(BatchDeactivateYieldGroupsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchDeactivateYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchDeactivateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
BatchDeactivateYieldGroupsRequest request = new BatchDeactivateYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    YieldGroupNames =
    {
        YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
    },
};
// Make the request
BatchDeactivateYieldGroupsResponse response = await yieldGroupServiceClient.BatchDeactivateYieldGroupsAsync(request);

BatchDeactivateYieldGroupsAsync(BatchDeactivateYieldGroupsRequest, CancellationToken)

Deactivates a list of YieldGroup objects.

Declaration
public virtual Task<BatchDeactivateYieldGroupsResponse> BatchDeactivateYieldGroupsAsync(BatchDeactivateYieldGroupsRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
BatchDeactivateYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchDeactivateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
BatchDeactivateYieldGroupsRequest request = new BatchDeactivateYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    YieldGroupNames =
    {
        YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
    },
};
// Make the request
BatchDeactivateYieldGroupsResponse response = await yieldGroupServiceClient.BatchDeactivateYieldGroupsAsync(request);

BatchDeactivateYieldGroupsAsync(NetworkName, IEnumerable<YieldGroupName>, CallSettings)

Deactivates a list of YieldGroup objects.

Declaration
public virtual Task<BatchDeactivateYieldGroupsResponse> BatchDeactivateYieldGroupsAsync(NetworkName parent, IEnumerable<YieldGroupName> names, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<YieldGroupName> names

Required. The resource names of the YieldGroups to deactivate. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchDeactivateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<YieldGroupName> names = new YieldGroupName[]
{
    YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
};
// Make the request
BatchDeactivateYieldGroupsResponse response = await yieldGroupServiceClient.BatchDeactivateYieldGroupsAsync(parent, names);

BatchDeactivateYieldGroupsAsync(NetworkName, IEnumerable<YieldGroupName>, CancellationToken)

Deactivates a list of YieldGroup objects.

Declaration
public virtual Task<BatchDeactivateYieldGroupsResponse> BatchDeactivateYieldGroupsAsync(NetworkName parent, IEnumerable<YieldGroupName> names, CancellationToken cancellationToken)
Parameters
Type Name Description
NetworkName parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<YieldGroupName> names

Required. The resource names of the YieldGroups to deactivate. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchDeactivateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<YieldGroupName> names = new YieldGroupName[]
{
    YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
};
// Make the request
BatchDeactivateYieldGroupsResponse response = await yieldGroupServiceClient.BatchDeactivateYieldGroupsAsync(parent, names);

BatchDeactivateYieldGroupsAsync(string, IEnumerable<string>, CallSettings)

Deactivates a list of YieldGroup objects.

Declaration
public virtual Task<BatchDeactivateYieldGroupsResponse> BatchDeactivateYieldGroupsAsync(string parent, IEnumerable<string> names, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<string> names

Required. The resource names of the YieldGroups to deactivate. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchDeactivateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<string> names = new string[]
{
    "networks/[NETWORK_CODE]/yieldGroups/[YIELD_GROUP]",
};
// Make the request
BatchDeactivateYieldGroupsResponse response = await yieldGroupServiceClient.BatchDeactivateYieldGroupsAsync(parent, names);

BatchDeactivateYieldGroupsAsync(string, IEnumerable<string>, CancellationToken)

Deactivates a list of YieldGroup objects.

Declaration
public virtual Task<BatchDeactivateYieldGroupsResponse> BatchDeactivateYieldGroupsAsync(string parent, IEnumerable<string> names, CancellationToken cancellationToken)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

IEnumerable<string> names

Required. The resource names of the YieldGroups to deactivate. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchDeactivateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<string> names = new string[]
{
    "networks/[NETWORK_CODE]/yieldGroups/[YIELD_GROUP]",
};
// Make the request
BatchDeactivateYieldGroupsResponse response = await yieldGroupServiceClient.BatchDeactivateYieldGroupsAsync(parent, names);

BatchUpdateYieldGroups(BatchUpdateYieldGroupsRequest, CallSettings)

Batch updates YieldGroup objects.

Declaration
public virtual BatchUpdateYieldGroupsResponse BatchUpdateYieldGroups(BatchUpdateYieldGroupsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchUpdateYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchUpdateYieldGroupsResponse

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
BatchUpdateYieldGroupsRequest request = new BatchUpdateYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Requests =
    {
        new UpdateYieldGroupRequest(),
    },
};
// Make the request
BatchUpdateYieldGroupsResponse response = yieldGroupServiceClient.BatchUpdateYieldGroups(request);

BatchUpdateYieldGroups(NetworkName, IEnumerable<UpdateYieldGroupRequest>, CallSettings)

Batch updates YieldGroup objects.

Declaration
public virtual BatchUpdateYieldGroupsResponse BatchUpdateYieldGroups(NetworkName parent, IEnumerable<UpdateYieldGroupRequest> requests, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent resource where YieldGroups will be updated. Format: networks/{network_code} The parent field in the UpdateYieldGroupRequest must match this field.

IEnumerable<UpdateYieldGroupRequest> requests

Required. The YieldGroup objects to update. A maximum of 10 objects can be updated in a batch.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchUpdateYieldGroupsResponse

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<UpdateYieldGroupRequest> requests = new UpdateYieldGroupRequest[]
{
    new UpdateYieldGroupRequest(),
};
// Make the request
BatchUpdateYieldGroupsResponse response = yieldGroupServiceClient.BatchUpdateYieldGroups(parent, requests);

BatchUpdateYieldGroups(string, IEnumerable<UpdateYieldGroupRequest>, CallSettings)

Batch updates YieldGroup objects.

Declaration
public virtual BatchUpdateYieldGroupsResponse BatchUpdateYieldGroups(string parent, IEnumerable<UpdateYieldGroupRequest> requests, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent resource where YieldGroups will be updated. Format: networks/{network_code} The parent field in the UpdateYieldGroupRequest must match this field.

IEnumerable<UpdateYieldGroupRequest> requests

Required. The YieldGroup objects to update. A maximum of 10 objects can be updated in a batch.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchUpdateYieldGroupsResponse

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<UpdateYieldGroupRequest> requests = new UpdateYieldGroupRequest[]
{
    new UpdateYieldGroupRequest(),
};
// Make the request
BatchUpdateYieldGroupsResponse response = yieldGroupServiceClient.BatchUpdateYieldGroups(parent, requests);

BatchUpdateYieldGroupsAsync(BatchUpdateYieldGroupsRequest, CallSettings)

Batch updates YieldGroup objects.

Declaration
public virtual Task<BatchUpdateYieldGroupsResponse> BatchUpdateYieldGroupsAsync(BatchUpdateYieldGroupsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchUpdateYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchUpdateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
BatchUpdateYieldGroupsRequest request = new BatchUpdateYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Requests =
    {
        new UpdateYieldGroupRequest(),
    },
};
// Make the request
BatchUpdateYieldGroupsResponse response = await yieldGroupServiceClient.BatchUpdateYieldGroupsAsync(request);

BatchUpdateYieldGroupsAsync(BatchUpdateYieldGroupsRequest, CancellationToken)

Batch updates YieldGroup objects.

Declaration
public virtual Task<BatchUpdateYieldGroupsResponse> BatchUpdateYieldGroupsAsync(BatchUpdateYieldGroupsRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
BatchUpdateYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchUpdateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
BatchUpdateYieldGroupsRequest request = new BatchUpdateYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Requests =
    {
        new UpdateYieldGroupRequest(),
    },
};
// Make the request
BatchUpdateYieldGroupsResponse response = await yieldGroupServiceClient.BatchUpdateYieldGroupsAsync(request);

BatchUpdateYieldGroupsAsync(NetworkName, IEnumerable<UpdateYieldGroupRequest>, CallSettings)

Batch updates YieldGroup objects.

Declaration
public virtual Task<BatchUpdateYieldGroupsResponse> BatchUpdateYieldGroupsAsync(NetworkName parent, IEnumerable<UpdateYieldGroupRequest> requests, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent resource where YieldGroups will be updated. Format: networks/{network_code} The parent field in the UpdateYieldGroupRequest must match this field.

IEnumerable<UpdateYieldGroupRequest> requests

Required. The YieldGroup objects to update. A maximum of 10 objects can be updated in a batch.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchUpdateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<UpdateYieldGroupRequest> requests = new UpdateYieldGroupRequest[]
{
    new UpdateYieldGroupRequest(),
};
// Make the request
BatchUpdateYieldGroupsResponse response = await yieldGroupServiceClient.BatchUpdateYieldGroupsAsync(parent, requests);

BatchUpdateYieldGroupsAsync(NetworkName, IEnumerable<UpdateYieldGroupRequest>, CancellationToken)

Batch updates YieldGroup objects.

Declaration
public virtual Task<BatchUpdateYieldGroupsResponse> BatchUpdateYieldGroupsAsync(NetworkName parent, IEnumerable<UpdateYieldGroupRequest> requests, CancellationToken cancellationToken)
Parameters
Type Name Description
NetworkName parent

Required. The parent resource where YieldGroups will be updated. Format: networks/{network_code} The parent field in the UpdateYieldGroupRequest must match this field.

IEnumerable<UpdateYieldGroupRequest> requests

Required. The YieldGroup objects to update. A maximum of 10 objects can be updated in a batch.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchUpdateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
IEnumerable<UpdateYieldGroupRequest> requests = new UpdateYieldGroupRequest[]
{
    new UpdateYieldGroupRequest(),
};
// Make the request
BatchUpdateYieldGroupsResponse response = await yieldGroupServiceClient.BatchUpdateYieldGroupsAsync(parent, requests);

BatchUpdateYieldGroupsAsync(string, IEnumerable<UpdateYieldGroupRequest>, CallSettings)

Batch updates YieldGroup objects.

Declaration
public virtual Task<BatchUpdateYieldGroupsResponse> BatchUpdateYieldGroupsAsync(string parent, IEnumerable<UpdateYieldGroupRequest> requests, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent resource where YieldGroups will be updated. Format: networks/{network_code} The parent field in the UpdateYieldGroupRequest must match this field.

IEnumerable<UpdateYieldGroupRequest> requests

Required. The YieldGroup objects to update. A maximum of 10 objects can be updated in a batch.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<BatchUpdateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<UpdateYieldGroupRequest> requests = new UpdateYieldGroupRequest[]
{
    new UpdateYieldGroupRequest(),
};
// Make the request
BatchUpdateYieldGroupsResponse response = await yieldGroupServiceClient.BatchUpdateYieldGroupsAsync(parent, requests);

BatchUpdateYieldGroupsAsync(string, IEnumerable<UpdateYieldGroupRequest>, CancellationToken)

Batch updates YieldGroup objects.

Declaration
public virtual Task<BatchUpdateYieldGroupsResponse> BatchUpdateYieldGroupsAsync(string parent, IEnumerable<UpdateYieldGroupRequest> requests, CancellationToken cancellationToken)
Parameters
Type Name Description
string parent

Required. The parent resource where YieldGroups will be updated. Format: networks/{network_code} The parent field in the UpdateYieldGroupRequest must match this field.

IEnumerable<UpdateYieldGroupRequest> requests

Required. The YieldGroup objects to update. A maximum of 10 objects can be updated in a batch.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<BatchUpdateYieldGroupsResponse>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
IEnumerable<UpdateYieldGroupRequest> requests = new UpdateYieldGroupRequest[]
{
    new UpdateYieldGroupRequest(),
};
// Make the request
BatchUpdateYieldGroupsResponse response = await yieldGroupServiceClient.BatchUpdateYieldGroupsAsync(parent, requests);

Create()

Synchronously creates a YieldGroupServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use YieldGroupServiceClientBuilder.

Declaration
public static YieldGroupServiceClient Create()
Returns
Type Description
YieldGroupServiceClient

The created YieldGroupServiceClient.

CreateAsync(CancellationToken)

Asynchronously creates a YieldGroupServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use YieldGroupServiceClientBuilder.

Declaration
public static Task<YieldGroupServiceClient> CreateAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
Task<YieldGroupServiceClient>

The task representing the created YieldGroupServiceClient.

CreateYieldGroup(CreateYieldGroupRequest, CallSettings)

Creates a YieldGroup object.

Declaration
public virtual YieldGroup CreateYieldGroup(CreateYieldGroupRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateYieldGroupRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
YieldGroup

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
CreateYieldGroupRequest request = new CreateYieldGroupRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    YieldGroup = new YieldGroup(),
};
// Make the request
YieldGroup response = yieldGroupServiceClient.CreateYieldGroup(request);

CreateYieldGroup(NetworkName, YieldGroup, CallSettings)

Creates a YieldGroup object.

Declaration
public virtual YieldGroup CreateYieldGroup(NetworkName parent, YieldGroup yieldGroup, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent resource where this YieldGroup will be created. Format: networks/{network_code}

YieldGroup yieldGroup

Required. The YieldGroup to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
YieldGroup

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
YieldGroup yieldGroup = new YieldGroup();
// Make the request
YieldGroup response = yieldGroupServiceClient.CreateYieldGroup(parent, yieldGroup);

CreateYieldGroup(string, YieldGroup, CallSettings)

Creates a YieldGroup object.

Declaration
public virtual YieldGroup CreateYieldGroup(string parent, YieldGroup yieldGroup, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent resource where this YieldGroup will be created. Format: networks/{network_code}

YieldGroup yieldGroup

Required. The YieldGroup to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
YieldGroup

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
YieldGroup yieldGroup = new YieldGroup();
// Make the request
YieldGroup response = yieldGroupServiceClient.CreateYieldGroup(parent, yieldGroup);

CreateYieldGroupAsync(CreateYieldGroupRequest, CallSettings)

Creates a YieldGroup object.

Declaration
public virtual Task<YieldGroup> CreateYieldGroupAsync(CreateYieldGroupRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateYieldGroupRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
CreateYieldGroupRequest request = new CreateYieldGroupRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    YieldGroup = new YieldGroup(),
};
// Make the request
YieldGroup response = await yieldGroupServiceClient.CreateYieldGroupAsync(request);

CreateYieldGroupAsync(CreateYieldGroupRequest, CancellationToken)

Creates a YieldGroup object.

Declaration
public virtual Task<YieldGroup> CreateYieldGroupAsync(CreateYieldGroupRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
CreateYieldGroupRequest request

The request object containing all of the parameters for the API call.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
CreateYieldGroupRequest request = new CreateYieldGroupRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    YieldGroup = new YieldGroup(),
};
// Make the request
YieldGroup response = await yieldGroupServiceClient.CreateYieldGroupAsync(request);

CreateYieldGroupAsync(NetworkName, YieldGroup, CallSettings)

Creates a YieldGroup object.

Declaration
public virtual Task<YieldGroup> CreateYieldGroupAsync(NetworkName parent, YieldGroup yieldGroup, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent resource where this YieldGroup will be created. Format: networks/{network_code}

YieldGroup yieldGroup

Required. The YieldGroup to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
YieldGroup yieldGroup = new YieldGroup();
// Make the request
YieldGroup response = await yieldGroupServiceClient.CreateYieldGroupAsync(parent, yieldGroup);

CreateYieldGroupAsync(NetworkName, YieldGroup, CancellationToken)

Creates a YieldGroup object.

Declaration
public virtual Task<YieldGroup> CreateYieldGroupAsync(NetworkName parent, YieldGroup yieldGroup, CancellationToken cancellationToken)
Parameters
Type Name Description
NetworkName parent

Required. The parent resource where this YieldGroup will be created. Format: networks/{network_code}

YieldGroup yieldGroup

Required. The YieldGroup to create.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
YieldGroup yieldGroup = new YieldGroup();
// Make the request
YieldGroup response = await yieldGroupServiceClient.CreateYieldGroupAsync(parent, yieldGroup);

CreateYieldGroupAsync(string, YieldGroup, CallSettings)

Creates a YieldGroup object.

Declaration
public virtual Task<YieldGroup> CreateYieldGroupAsync(string parent, YieldGroup yieldGroup, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent resource where this YieldGroup will be created. Format: networks/{network_code}

YieldGroup yieldGroup

Required. The YieldGroup to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
YieldGroup yieldGroup = new YieldGroup();
// Make the request
YieldGroup response = await yieldGroupServiceClient.CreateYieldGroupAsync(parent, yieldGroup);

CreateYieldGroupAsync(string, YieldGroup, CancellationToken)

Creates a YieldGroup object.

Declaration
public virtual Task<YieldGroup> CreateYieldGroupAsync(string parent, YieldGroup yieldGroup, CancellationToken cancellationToken)
Parameters
Type Name Description
string parent

Required. The parent resource where this YieldGroup will be created. Format: networks/{network_code}

YieldGroup yieldGroup

Required. The YieldGroup to create.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
YieldGroup yieldGroup = new YieldGroup();
// Make the request
YieldGroup response = await yieldGroupServiceClient.CreateYieldGroupAsync(parent, yieldGroup);

GetYieldGroup(GetYieldGroupRequest, CallSettings)

Retrieves a YieldGroup object.

Declaration
public virtual YieldGroup GetYieldGroup(GetYieldGroupRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetYieldGroupRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
YieldGroup

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
GetYieldGroupRequest request = new GetYieldGroupRequest
{
    YieldGroupName = YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
};
// Make the request
YieldGroup response = yieldGroupServiceClient.GetYieldGroup(request);

GetYieldGroup(YieldGroupName, CallSettings)

Retrieves a YieldGroup object.

Declaration
public virtual YieldGroup GetYieldGroup(YieldGroupName name, CallSettings callSettings = null)
Parameters
Type Name Description
YieldGroupName name

Required. The resource name of the YieldGroup. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
YieldGroup

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
YieldGroupName name = YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]");
// Make the request
YieldGroup response = yieldGroupServiceClient.GetYieldGroup(name);

GetYieldGroup(string, CallSettings)

Retrieves a YieldGroup object.

Declaration
public virtual YieldGroup GetYieldGroup(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The resource name of the YieldGroup. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
YieldGroup

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/yieldGroups/[YIELD_GROUP]";
// Make the request
YieldGroup response = yieldGroupServiceClient.GetYieldGroup(name);

GetYieldGroupAsync(GetYieldGroupRequest, CallSettings)

Retrieves a YieldGroup object.

Declaration
public virtual Task<YieldGroup> GetYieldGroupAsync(GetYieldGroupRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetYieldGroupRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
GetYieldGroupRequest request = new GetYieldGroupRequest
{
    YieldGroupName = YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
};
// Make the request
YieldGroup response = await yieldGroupServiceClient.GetYieldGroupAsync(request);

GetYieldGroupAsync(GetYieldGroupRequest, CancellationToken)

Retrieves a YieldGroup object.

Declaration
public virtual Task<YieldGroup> GetYieldGroupAsync(GetYieldGroupRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetYieldGroupRequest request

The request object containing all of the parameters for the API call.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
GetYieldGroupRequest request = new GetYieldGroupRequest
{
    YieldGroupName = YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]"),
};
// Make the request
YieldGroup response = await yieldGroupServiceClient.GetYieldGroupAsync(request);

GetYieldGroupAsync(YieldGroupName, CallSettings)

Retrieves a YieldGroup object.

Declaration
public virtual Task<YieldGroup> GetYieldGroupAsync(YieldGroupName name, CallSettings callSettings = null)
Parameters
Type Name Description
YieldGroupName name

Required. The resource name of the YieldGroup. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
YieldGroupName name = YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]");
// Make the request
YieldGroup response = await yieldGroupServiceClient.GetYieldGroupAsync(name);

GetYieldGroupAsync(YieldGroupName, CancellationToken)

Retrieves a YieldGroup object.

Declaration
public virtual Task<YieldGroup> GetYieldGroupAsync(YieldGroupName name, CancellationToken cancellationToken)
Parameters
Type Name Description
YieldGroupName name

Required. The resource name of the YieldGroup. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
YieldGroupName name = YieldGroupName.FromNetworkCodeYieldGroup("[NETWORK_CODE]", "[YIELD_GROUP]");
// Make the request
YieldGroup response = await yieldGroupServiceClient.GetYieldGroupAsync(name);

GetYieldGroupAsync(string, CallSettings)

Retrieves a YieldGroup object.

Declaration
public virtual Task<YieldGroup> GetYieldGroupAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The resource name of the YieldGroup. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/yieldGroups/[YIELD_GROUP]";
// Make the request
YieldGroup response = await yieldGroupServiceClient.GetYieldGroupAsync(name);

GetYieldGroupAsync(string, CancellationToken)

Retrieves a YieldGroup object.

Declaration
public virtual Task<YieldGroup> GetYieldGroupAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
string name

Required. The resource name of the YieldGroup. Format: networks/{network_code}/yieldGroups/{yield_group_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/yieldGroups/[YIELD_GROUP]";
// Make the request
YieldGroup response = await yieldGroupServiceClient.GetYieldGroupAsync(name);

ListYieldGroups(ListYieldGroupsRequest, CallSettings)

Lists YieldGroup objects.

Declaration
public virtual PagedEnumerable<ListYieldGroupsResponse, YieldGroup> ListYieldGroups(ListYieldGroupsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListYieldGroupsResponse, YieldGroup>

A pageable sequence of YieldGroup resources.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
ListYieldGroupsRequest request = new ListYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedEnumerable<ListYieldGroupsResponse, YieldGroup> response = yieldGroupServiceClient.ListYieldGroups(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (YieldGroup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListYieldGroupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (YieldGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<YieldGroup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (YieldGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListYieldGroups(NetworkName, string, int?, CallSettings)

Lists YieldGroup objects.

Declaration
public virtual PagedEnumerable<ListYieldGroupsResponse, YieldGroup> ListYieldGroups(NetworkName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListYieldGroupsResponse, YieldGroup>

A pageable sequence of YieldGroup resources.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedEnumerable<ListYieldGroupsResponse, YieldGroup> response = yieldGroupServiceClient.ListYieldGroups(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (YieldGroup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListYieldGroupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (YieldGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<YieldGroup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (YieldGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListYieldGroups(string, string, int?, CallSettings)

Lists YieldGroup objects.

Declaration
public virtual PagedEnumerable<ListYieldGroupsResponse, YieldGroup> ListYieldGroups(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListYieldGroupsResponse, YieldGroup>

A pageable sequence of YieldGroup resources.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedEnumerable<ListYieldGroupsResponse, YieldGroup> response = yieldGroupServiceClient.ListYieldGroups(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (YieldGroup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListYieldGroupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (YieldGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<YieldGroup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (YieldGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListYieldGroupsAsync(ListYieldGroupsRequest, CallSettings)

Lists YieldGroup objects.

Declaration
public virtual PagedAsyncEnumerable<ListYieldGroupsResponse, YieldGroup> ListYieldGroupsAsync(ListYieldGroupsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListYieldGroupsRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListYieldGroupsResponse, YieldGroup>

A pageable asynchronous sequence of YieldGroup resources.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
ListYieldGroupsRequest request = new ListYieldGroupsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedAsyncEnumerable<ListYieldGroupsResponse, YieldGroup> response = yieldGroupServiceClient.ListYieldGroupsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (YieldGroup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListYieldGroupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (YieldGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<YieldGroup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (YieldGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListYieldGroupsAsync(NetworkName, string, int?, CallSettings)

Lists YieldGroup objects.

Declaration
public virtual PagedAsyncEnumerable<ListYieldGroupsResponse, YieldGroup> ListYieldGroupsAsync(NetworkName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListYieldGroupsResponse, YieldGroup>

A pageable asynchronous sequence of YieldGroup resources.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedAsyncEnumerable<ListYieldGroupsResponse, YieldGroup> response = yieldGroupServiceClient.ListYieldGroupsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (YieldGroup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListYieldGroupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (YieldGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<YieldGroup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (YieldGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListYieldGroupsAsync(string, string, int?, CallSettings)

Lists YieldGroup objects.

Declaration
public virtual PagedAsyncEnumerable<ListYieldGroupsResponse, YieldGroup> ListYieldGroupsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of YieldGroups. Format: networks/{network_code}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListYieldGroupsResponse, YieldGroup>

A pageable asynchronous sequence of YieldGroup resources.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedAsyncEnumerable<ListYieldGroupsResponse, YieldGroup> response = yieldGroupServiceClient.ListYieldGroupsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (YieldGroup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListYieldGroupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (YieldGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<YieldGroup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (YieldGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Declaration
public static Task ShutdownDefaultChannelsAsync()
Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateYieldGroup(UpdateYieldGroupRequest, CallSettings)

Updates a YieldGroup object.

Declaration
public virtual YieldGroup UpdateYieldGroup(UpdateYieldGroupRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateYieldGroupRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
YieldGroup

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
UpdateYieldGroupRequest request = new UpdateYieldGroupRequest
{
    YieldGroup = new YieldGroup(),
    UpdateMask = new FieldMask(),
};
// Make the request
YieldGroup response = yieldGroupServiceClient.UpdateYieldGroup(request);

UpdateYieldGroup(YieldGroup, FieldMask, CallSettings)

Updates a YieldGroup object.

Declaration
public virtual YieldGroup UpdateYieldGroup(YieldGroup yieldGroup, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
YieldGroup yieldGroup

Required. The YieldGroup to update.

The YieldGroup's name is used to identify the YieldGroup to update.

FieldMask updateMask

Optional. The list of fields to update.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
YieldGroup

The RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.Create();
// Initialize request argument(s)
YieldGroup yieldGroup = new YieldGroup();
FieldMask updateMask = new FieldMask();
// Make the request
YieldGroup response = yieldGroupServiceClient.UpdateYieldGroup(yieldGroup, updateMask);

UpdateYieldGroupAsync(UpdateYieldGroupRequest, CallSettings)

Updates a YieldGroup object.

Declaration
public virtual Task<YieldGroup> UpdateYieldGroupAsync(UpdateYieldGroupRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateYieldGroupRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateYieldGroupRequest request = new UpdateYieldGroupRequest
{
    YieldGroup = new YieldGroup(),
    UpdateMask = new FieldMask(),
};
// Make the request
YieldGroup response = await yieldGroupServiceClient.UpdateYieldGroupAsync(request);

UpdateYieldGroupAsync(UpdateYieldGroupRequest, CancellationToken)

Updates a YieldGroup object.

Declaration
public virtual Task<YieldGroup> UpdateYieldGroupAsync(UpdateYieldGroupRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
UpdateYieldGroupRequest request

The request object containing all of the parameters for the API call.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateYieldGroupRequest request = new UpdateYieldGroupRequest
{
    YieldGroup = new YieldGroup(),
    UpdateMask = new FieldMask(),
};
// Make the request
YieldGroup response = await yieldGroupServiceClient.UpdateYieldGroupAsync(request);

UpdateYieldGroupAsync(YieldGroup, FieldMask, CallSettings)

Updates a YieldGroup object.

Declaration
public virtual Task<YieldGroup> UpdateYieldGroupAsync(YieldGroup yieldGroup, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
YieldGroup yieldGroup

Required. The YieldGroup to update.

The YieldGroup's name is used to identify the YieldGroup to update.

FieldMask updateMask

Optional. The list of fields to update.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
YieldGroup yieldGroup = new YieldGroup();
FieldMask updateMask = new FieldMask();
// Make the request
YieldGroup response = await yieldGroupServiceClient.UpdateYieldGroupAsync(yieldGroup, updateMask);

UpdateYieldGroupAsync(YieldGroup, FieldMask, CancellationToken)

Updates a YieldGroup object.

Declaration
public virtual Task<YieldGroup> UpdateYieldGroupAsync(YieldGroup yieldGroup, FieldMask updateMask, CancellationToken cancellationToken)
Parameters
Type Name Description
YieldGroup yieldGroup

Required. The YieldGroup to update.

The YieldGroup's name is used to identify the YieldGroup to update.

FieldMask updateMask

Optional. The list of fields to update.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<YieldGroup>

A Task containing the RPC response.

Sample code
// Create client
YieldGroupServiceClient yieldGroupServiceClient = await YieldGroupServiceClient.CreateAsync();
// Initialize request argument(s)
YieldGroup yieldGroup = new YieldGroup();
FieldMask updateMask = new FieldMask();
// Make the request
YieldGroup response = await yieldGroupServiceClient.UpdateYieldGroupAsync(yieldGroup, updateMask);
In this article
Back to top Generated by DocFX