Class YieldGroupServiceClient (0.62.0)

GitHub RepositoryProduct Reference

Service Description: Provides methods for handling YieldGroup objects.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   YieldGroupName name = YieldGroupName.of("[NETWORK_CODE]", "[YIELD_GROUP]");
   YieldGroup response = yieldGroupServiceClient.getYieldGroup(name);
 }
 

Note: close() needs to be called on the YieldGroupServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

GetYieldGroup

Retrieves a YieldGroup object.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getYieldGroup(GetYieldGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getYieldGroup(YieldGroupName name)

  • getYieldGroup(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getYieldGroupCallable()

ListYieldGroups

Lists YieldGroup objects.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listYieldGroups(ListYieldGroupsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listYieldGroups(NetworkName parent)

  • listYieldGroups(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listYieldGroupsPagedCallable()

  • listYieldGroupsCallable()

CreateYieldGroup

Creates a YieldGroup object.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createYieldGroup(CreateYieldGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createYieldGroup(NetworkName parent, YieldGroup yieldGroup)

  • createYieldGroup(String parent, YieldGroup yieldGroup)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createYieldGroupCallable()

BatchCreateYieldGroups

Batch creates YieldGroup objects.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchCreateYieldGroups(NetworkName parent, List<CreateYieldGroupRequest> requests)

  • batchCreateYieldGroups(String parent, List<CreateYieldGroupRequest> requests)

  • batchCreateYieldGroups(BatchCreateYieldGroupsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchCreateYieldGroupsCallable()

UpdateYieldGroup

Updates a YieldGroup object.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateYieldGroup(UpdateYieldGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateYieldGroup(YieldGroup yieldGroup, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateYieldGroupCallable()

BatchUpdateYieldGroups

Batch updates YieldGroup objects.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchUpdateYieldGroups(NetworkName parent, List<UpdateYieldGroupRequest> requests)

  • batchUpdateYieldGroups(String parent, List<UpdateYieldGroupRequest> requests)

  • batchUpdateYieldGroups(BatchUpdateYieldGroupsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchUpdateYieldGroupsCallable()

BatchActivateYieldGroups

Activates a list of YieldGroup objects.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchActivateYieldGroups(BatchActivateYieldGroupsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • batchActivateYieldGroups(NetworkName parent, List<String> names)

  • batchActivateYieldGroups(String parent, List<String> names)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchActivateYieldGroupsCallable()

BatchDeactivateYieldGroups

Deactivates a list of YieldGroup objects.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchDeactivateYieldGroups(BatchDeactivateYieldGroupsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • batchDeactivateYieldGroups(NetworkName parent, List<String> names)

  • batchDeactivateYieldGroups(String parent, List<String> names)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchDeactivateYieldGroupsCallable()

BatchArchiveYieldGroups

Archives a list of YieldGroup objects.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchArchiveYieldGroups(BatchArchiveYieldGroupsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • batchArchiveYieldGroups(NetworkName parent, List<String> names)

  • batchArchiveYieldGroups(String parent, List<String> names)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchArchiveYieldGroupsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of YieldGroupServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 YieldGroupServiceSettings yieldGroupServiceSettings =
     YieldGroupServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 YieldGroupServiceClient yieldGroupServiceClient =
     YieldGroupServiceClient.create(yieldGroupServiceSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 YieldGroupServiceSettings yieldGroupServiceSettings =
     YieldGroupServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 YieldGroupServiceClient yieldGroupServiceClient =
     YieldGroupServiceClient.create(yieldGroupServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > YieldGroupServiceClient

Static Methods

create()

public static final YieldGroupServiceClient create()

Constructs an instance of YieldGroupServiceClient with default settings.

Returns
Type Description
YieldGroupServiceClient
Exceptions
Type Description
IOException

create(YieldGroupServiceSettings settings)

public static final YieldGroupServiceClient create(YieldGroupServiceSettings settings)

Constructs an instance of YieldGroupServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings YieldGroupServiceSettings
Returns
Type Description
YieldGroupServiceClient
Exceptions
Type Description
IOException

create(YieldGroupServiceStub stub)

public static final YieldGroupServiceClient create(YieldGroupServiceStub stub)

Constructs an instance of YieldGroupServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(YieldGroupServiceSettings).

Parameter
Name Description
stub YieldGroupServiceStub
Returns
Type Description
YieldGroupServiceClient

Constructors

YieldGroupServiceClient(YieldGroupServiceSettings settings)

protected YieldGroupServiceClient(YieldGroupServiceSettings settings)

Constructs an instance of YieldGroupServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings YieldGroupServiceSettings

YieldGroupServiceClient(YieldGroupServiceStub stub)

protected YieldGroupServiceClient(YieldGroupServiceStub stub)
Parameter
Name Description
stub YieldGroupServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

batchActivateYieldGroups(@Nullable NetworkName parent, List<String> names)

public final BatchActivateYieldGroupsResponse batchActivateYieldGroups(@Nullable NetworkName parent, List<String> names)

Activates a list of YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<String> names = new ArrayList<>();
   BatchActivateYieldGroupsResponse response =
       yieldGroupServiceClient.batchActivateYieldGroups(parent, names);
 }
 
Parameters
Name Description
parent @org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName

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

names List<String>

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

Returns
Type Description
BatchActivateYieldGroupsResponse

batchActivateYieldGroups(BatchActivateYieldGroupsRequest request)

public final BatchActivateYieldGroupsResponse batchActivateYieldGroups(BatchActivateYieldGroupsRequest request)

Activates a list of YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   BatchActivateYieldGroupsRequest request =
       BatchActivateYieldGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   BatchActivateYieldGroupsResponse response =
       yieldGroupServiceClient.batchActivateYieldGroups(request);
 }
 
Parameter
Name Description
request BatchActivateYieldGroupsRequest

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

Returns
Type Description
BatchActivateYieldGroupsResponse

batchActivateYieldGroups(String parent, List<String> names)

public final BatchActivateYieldGroupsResponse batchActivateYieldGroups(String parent, List<String> names)

Activates a list of YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<String> names = new ArrayList<>();
   BatchActivateYieldGroupsResponse response =
       yieldGroupServiceClient.batchActivateYieldGroups(parent, names);
 }
 
Parameters
Name Description
parent String

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

names List<String>

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

Returns
Type Description
BatchActivateYieldGroupsResponse

batchActivateYieldGroupsCallable()

public final UnaryCallable<BatchActivateYieldGroupsRequest,BatchActivateYieldGroupsResponse> batchActivateYieldGroupsCallable()

Activates a list of YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   BatchActivateYieldGroupsRequest request =
       BatchActivateYieldGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   ApiFuture<BatchActivateYieldGroupsResponse> future =
       yieldGroupServiceClient.batchActivateYieldGroupsCallable().futureCall(request);
   // Do something.
   BatchActivateYieldGroupsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<BatchActivateYieldGroupsRequest,BatchActivateYieldGroupsResponse>

batchArchiveYieldGroups(@Nullable NetworkName parent, List<String> names)

public final BatchArchiveYieldGroupsResponse batchArchiveYieldGroups(@Nullable NetworkName parent, List<String> names)

Archives a list of YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<String> names = new ArrayList<>();
   BatchArchiveYieldGroupsResponse response =
       yieldGroupServiceClient.batchArchiveYieldGroups(parent, names);
 }
 
Parameters
Name Description
parent @org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName

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

names List<String>

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

Returns
Type Description
BatchArchiveYieldGroupsResponse

batchArchiveYieldGroups(BatchArchiveYieldGroupsRequest request)

public final BatchArchiveYieldGroupsResponse batchArchiveYieldGroups(BatchArchiveYieldGroupsRequest request)

Archives a list of YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   BatchArchiveYieldGroupsRequest request =
       BatchArchiveYieldGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   BatchArchiveYieldGroupsResponse response =
       yieldGroupServiceClient.batchArchiveYieldGroups(request);
 }
 
Parameter
Name Description
request BatchArchiveYieldGroupsRequest

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

Returns
Type Description
BatchArchiveYieldGroupsResponse

batchArchiveYieldGroups(String parent, List<String> names)

public final BatchArchiveYieldGroupsResponse batchArchiveYieldGroups(String parent, List<String> names)

Archives a list of YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<String> names = new ArrayList<>();
   BatchArchiveYieldGroupsResponse response =
       yieldGroupServiceClient.batchArchiveYieldGroups(parent, names);
 }
 
Parameters
Name Description
parent String

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

names List<String>

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

Returns
Type Description
BatchArchiveYieldGroupsResponse

batchArchiveYieldGroupsCallable()

public final UnaryCallable<BatchArchiveYieldGroupsRequest,BatchArchiveYieldGroupsResponse> batchArchiveYieldGroupsCallable()

Archives a list of YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   BatchArchiveYieldGroupsRequest request =
       BatchArchiveYieldGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   ApiFuture<BatchArchiveYieldGroupsResponse> future =
       yieldGroupServiceClient.batchArchiveYieldGroupsCallable().futureCall(request);
   // Do something.
   BatchArchiveYieldGroupsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<BatchArchiveYieldGroupsRequest,BatchArchiveYieldGroupsResponse>

batchCreateYieldGroups(@Nullable NetworkName parent, List<CreateYieldGroupRequest> requests)

public final BatchCreateYieldGroupsResponse batchCreateYieldGroups(@Nullable NetworkName parent, List<CreateYieldGroupRequest> requests)

Batch creates YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<CreateYieldGroupRequest> requests = new ArrayList<>();
   BatchCreateYieldGroupsResponse response =
       yieldGroupServiceClient.batchCreateYieldGroups(parent, requests);
 }
 
Parameters
Name Description
parent @org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName

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

requests List<CreateYieldGroupRequest>

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

Returns
Type Description
BatchCreateYieldGroupsResponse

batchCreateYieldGroups(BatchCreateYieldGroupsRequest request)

public final BatchCreateYieldGroupsResponse batchCreateYieldGroups(BatchCreateYieldGroupsRequest request)

Batch creates YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   BatchCreateYieldGroupsRequest request =
       BatchCreateYieldGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<CreateYieldGroupRequest>())
           .build();
   BatchCreateYieldGroupsResponse response =
       yieldGroupServiceClient.batchCreateYieldGroups(request);
 }
 
Parameter
Name Description
request BatchCreateYieldGroupsRequest

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

Returns
Type Description
BatchCreateYieldGroupsResponse

batchCreateYieldGroups(String parent, List<CreateYieldGroupRequest> requests)

public final BatchCreateYieldGroupsResponse batchCreateYieldGroups(String parent, List<CreateYieldGroupRequest> requests)

Batch creates YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<CreateYieldGroupRequest> requests = new ArrayList<>();
   BatchCreateYieldGroupsResponse response =
       yieldGroupServiceClient.batchCreateYieldGroups(parent, requests);
 }
 
Parameters
Name Description
parent String

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

requests List<CreateYieldGroupRequest>

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

Returns
Type Description
BatchCreateYieldGroupsResponse

batchCreateYieldGroupsCallable()

public final UnaryCallable<BatchCreateYieldGroupsRequest,BatchCreateYieldGroupsResponse> batchCreateYieldGroupsCallable()

Batch creates YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   BatchCreateYieldGroupsRequest request =
       BatchCreateYieldGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<CreateYieldGroupRequest>())
           .build();
   ApiFuture<BatchCreateYieldGroupsResponse> future =
       yieldGroupServiceClient.batchCreateYieldGroupsCallable().futureCall(request);
   // Do something.
   BatchCreateYieldGroupsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<BatchCreateYieldGroupsRequest,BatchCreateYieldGroupsResponse>

batchDeactivateYieldGroups(@Nullable NetworkName parent, List<String> names)

public final BatchDeactivateYieldGroupsResponse batchDeactivateYieldGroups(@Nullable NetworkName parent, List<String> names)

Deactivates a list of YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<String> names = new ArrayList<>();
   BatchDeactivateYieldGroupsResponse response =
       yieldGroupServiceClient.batchDeactivateYieldGroups(parent, names);
 }
 
Parameters
Name Description
parent @org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName

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

names List<String>

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

Returns
Type Description
BatchDeactivateYieldGroupsResponse

batchDeactivateYieldGroups(BatchDeactivateYieldGroupsRequest request)

public final BatchDeactivateYieldGroupsResponse batchDeactivateYieldGroups(BatchDeactivateYieldGroupsRequest request)

Deactivates a list of YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   BatchDeactivateYieldGroupsRequest request =
       BatchDeactivateYieldGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   BatchDeactivateYieldGroupsResponse response =
       yieldGroupServiceClient.batchDeactivateYieldGroups(request);
 }
 
Parameter
Name Description
request BatchDeactivateYieldGroupsRequest

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

Returns
Type Description
BatchDeactivateYieldGroupsResponse

batchDeactivateYieldGroups(String parent, List<String> names)

public final BatchDeactivateYieldGroupsResponse batchDeactivateYieldGroups(String parent, List<String> names)

Deactivates a list of YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<String> names = new ArrayList<>();
   BatchDeactivateYieldGroupsResponse response =
       yieldGroupServiceClient.batchDeactivateYieldGroups(parent, names);
 }
 
Parameters
Name Description
parent String

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

names List<String>

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

Returns
Type Description
BatchDeactivateYieldGroupsResponse

batchDeactivateYieldGroupsCallable()

public final UnaryCallable<BatchDeactivateYieldGroupsRequest,BatchDeactivateYieldGroupsResponse> batchDeactivateYieldGroupsCallable()

Deactivates a list of YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   BatchDeactivateYieldGroupsRequest request =
       BatchDeactivateYieldGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   ApiFuture<BatchDeactivateYieldGroupsResponse> future =
       yieldGroupServiceClient.batchDeactivateYieldGroupsCallable().futureCall(request);
   // Do something.
   BatchDeactivateYieldGroupsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<BatchDeactivateYieldGroupsRequest,BatchDeactivateYieldGroupsResponse>

batchUpdateYieldGroups(@Nullable NetworkName parent, List<UpdateYieldGroupRequest> requests)

public final BatchUpdateYieldGroupsResponse batchUpdateYieldGroups(@Nullable NetworkName parent, List<UpdateYieldGroupRequest> requests)

Batch updates YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<UpdateYieldGroupRequest> requests = new ArrayList<>();
   BatchUpdateYieldGroupsResponse response =
       yieldGroupServiceClient.batchUpdateYieldGroups(parent, requests);
 }
 
Parameters
Name Description
parent @org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName

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

requests List<UpdateYieldGroupRequest>

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

Returns
Type Description
BatchUpdateYieldGroupsResponse

batchUpdateYieldGroups(BatchUpdateYieldGroupsRequest request)

public final BatchUpdateYieldGroupsResponse batchUpdateYieldGroups(BatchUpdateYieldGroupsRequest request)

Batch updates YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   BatchUpdateYieldGroupsRequest request =
       BatchUpdateYieldGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<UpdateYieldGroupRequest>())
           .build();
   BatchUpdateYieldGroupsResponse response =
       yieldGroupServiceClient.batchUpdateYieldGroups(request);
 }
 
Parameter
Name Description
request BatchUpdateYieldGroupsRequest

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

Returns
Type Description
BatchUpdateYieldGroupsResponse

batchUpdateYieldGroups(String parent, List<UpdateYieldGroupRequest> requests)

public final BatchUpdateYieldGroupsResponse batchUpdateYieldGroups(String parent, List<UpdateYieldGroupRequest> requests)

Batch updates YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<UpdateYieldGroupRequest> requests = new ArrayList<>();
   BatchUpdateYieldGroupsResponse response =
       yieldGroupServiceClient.batchUpdateYieldGroups(parent, requests);
 }
 
Parameters
Name Description
parent String

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

requests List<UpdateYieldGroupRequest>

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

Returns
Type Description
BatchUpdateYieldGroupsResponse

batchUpdateYieldGroupsCallable()

public final UnaryCallable<BatchUpdateYieldGroupsRequest,BatchUpdateYieldGroupsResponse> batchUpdateYieldGroupsCallable()

Batch updates YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   BatchUpdateYieldGroupsRequest request =
       BatchUpdateYieldGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<UpdateYieldGroupRequest>())
           .build();
   ApiFuture<BatchUpdateYieldGroupsResponse> future =
       yieldGroupServiceClient.batchUpdateYieldGroupsCallable().futureCall(request);
   // Do something.
   BatchUpdateYieldGroupsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<BatchUpdateYieldGroupsRequest,BatchUpdateYieldGroupsResponse>

close()

public final void close()

createYieldGroup(@Nullable NetworkName parent, YieldGroup yieldGroup)

public final YieldGroup createYieldGroup(@Nullable NetworkName parent, YieldGroup yieldGroup)

Creates a YieldGroup object.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   YieldGroup yieldGroup = YieldGroup.newBuilder().build();
   YieldGroup response = yieldGroupServiceClient.createYieldGroup(parent, yieldGroup);
 }
 
Parameters
Name Description
parent @org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName

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

yieldGroup YieldGroup

Required. The YieldGroup to create.

Returns
Type Description
YieldGroup

createYieldGroup(CreateYieldGroupRequest request)

public final YieldGroup createYieldGroup(CreateYieldGroupRequest request)

Creates a YieldGroup object.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   CreateYieldGroupRequest request =
       CreateYieldGroupRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setYieldGroup(YieldGroup.newBuilder().build())
           .build();
   YieldGroup response = yieldGroupServiceClient.createYieldGroup(request);
 }
 
Parameter
Name Description
request CreateYieldGroupRequest

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

Returns
Type Description
YieldGroup

createYieldGroup(String parent, YieldGroup yieldGroup)

public final YieldGroup createYieldGroup(String parent, YieldGroup yieldGroup)

Creates a YieldGroup object.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   YieldGroup yieldGroup = YieldGroup.newBuilder().build();
   YieldGroup response = yieldGroupServiceClient.createYieldGroup(parent, yieldGroup);
 }
 
Parameters
Name Description
parent String

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

yieldGroup YieldGroup

Required. The YieldGroup to create.

Returns
Type Description
YieldGroup

createYieldGroupCallable()

public final UnaryCallable<CreateYieldGroupRequest,YieldGroup> createYieldGroupCallable()

Creates a YieldGroup object.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   CreateYieldGroupRequest request =
       CreateYieldGroupRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setYieldGroup(YieldGroup.newBuilder().build())
           .build();
   ApiFuture<YieldGroup> future =
       yieldGroupServiceClient.createYieldGroupCallable().futureCall(request);
   // Do something.
   YieldGroup response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateYieldGroupRequest,YieldGroup>

getSettings()

public final @Nullable YieldGroupServiceSettings getSettings()
Returns
Type Description
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.YieldGroupServiceSettings

getStub()

public YieldGroupServiceStub getStub()
Returns
Type Description
YieldGroupServiceStub

getYieldGroup(@Nullable YieldGroupName name)

public final YieldGroup getYieldGroup(@Nullable YieldGroupName name)

Retrieves a YieldGroup object.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   YieldGroupName name = YieldGroupName.of("[NETWORK_CODE]", "[YIELD_GROUP]");
   YieldGroup response = yieldGroupServiceClient.getYieldGroup(name);
 }
 
Parameter
Name Description
name @org.jspecify.annotations.Nullable com.google.ads.admanager.v1.YieldGroupName

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

Returns
Type Description
YieldGroup

getYieldGroup(GetYieldGroupRequest request)

public final YieldGroup getYieldGroup(GetYieldGroupRequest request)

Retrieves a YieldGroup object.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   GetYieldGroupRequest request =
       GetYieldGroupRequest.newBuilder()
           .setName(YieldGroupName.of("[NETWORK_CODE]", "[YIELD_GROUP]").toString())
           .build();
   YieldGroup response = yieldGroupServiceClient.getYieldGroup(request);
 }
 
Parameter
Name Description
request GetYieldGroupRequest

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

Returns
Type Description
YieldGroup

getYieldGroup(String name)

public final YieldGroup getYieldGroup(String name)

Retrieves a YieldGroup object.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   String name = YieldGroupName.of("[NETWORK_CODE]", "[YIELD_GROUP]").toString();
   YieldGroup response = yieldGroupServiceClient.getYieldGroup(name);
 }
 
Parameter
Name Description
name String

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

Returns
Type Description
YieldGroup

getYieldGroupCallable()

public final UnaryCallable<GetYieldGroupRequest,YieldGroup> getYieldGroupCallable()

Retrieves a YieldGroup object.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   GetYieldGroupRequest request =
       GetYieldGroupRequest.newBuilder()
           .setName(YieldGroupName.of("[NETWORK_CODE]", "[YIELD_GROUP]").toString())
           .build();
   ApiFuture<YieldGroup> future =
       yieldGroupServiceClient.getYieldGroupCallable().futureCall(request);
   // Do something.
   YieldGroup response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetYieldGroupRequest,YieldGroup>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listYieldGroups(@Nullable NetworkName parent)

public final YieldGroupServiceClient.ListYieldGroupsPagedResponse listYieldGroups(@Nullable NetworkName parent)

Lists YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (YieldGroup element : yieldGroupServiceClient.listYieldGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent @org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName

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

Returns
Type Description
YieldGroupServiceClient.ListYieldGroupsPagedResponse

listYieldGroups(ListYieldGroupsRequest request)

public final YieldGroupServiceClient.ListYieldGroupsPagedResponse listYieldGroups(ListYieldGroupsRequest request)

Lists YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   ListYieldGroupsRequest request =
       ListYieldGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (YieldGroup element : yieldGroupServiceClient.listYieldGroups(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListYieldGroupsRequest

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

Returns
Type Description
YieldGroupServiceClient.ListYieldGroupsPagedResponse

listYieldGroups(String parent)

public final YieldGroupServiceClient.ListYieldGroupsPagedResponse listYieldGroups(String parent)

Lists YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (YieldGroup element : yieldGroupServiceClient.listYieldGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

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

Returns
Type Description
YieldGroupServiceClient.ListYieldGroupsPagedResponse

listYieldGroupsCallable()

public final UnaryCallable<ListYieldGroupsRequest,ListYieldGroupsResponse> listYieldGroupsCallable()

Lists YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   ListYieldGroupsRequest request =
       ListYieldGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListYieldGroupsResponse response =
         yieldGroupServiceClient.listYieldGroupsCallable().call(request);
     for (YieldGroup element : response.getYieldGroupsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListYieldGroupsRequest,ListYieldGroupsResponse>

listYieldGroupsPagedCallable()

public final UnaryCallable<ListYieldGroupsRequest,YieldGroupServiceClient.ListYieldGroupsPagedResponse> listYieldGroupsPagedCallable()

Lists YieldGroup objects.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   ListYieldGroupsRequest request =
       ListYieldGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<YieldGroup> future =
       yieldGroupServiceClient.listYieldGroupsPagedCallable().futureCall(request);
   // Do something.
   for (YieldGroup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListYieldGroupsRequest,ListYieldGroupsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateYieldGroup(UpdateYieldGroupRequest request)

public final YieldGroup updateYieldGroup(UpdateYieldGroupRequest request)

Updates a YieldGroup object.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   UpdateYieldGroupRequest request =
       UpdateYieldGroupRequest.newBuilder()
           .setYieldGroup(YieldGroup.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   YieldGroup response = yieldGroupServiceClient.updateYieldGroup(request);
 }
 
Parameter
Name Description
request UpdateYieldGroupRequest

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

Returns
Type Description
YieldGroup

updateYieldGroup(YieldGroup yieldGroup, FieldMask updateMask)

public final YieldGroup updateYieldGroup(YieldGroup yieldGroup, FieldMask updateMask)

Updates a YieldGroup object.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   YieldGroup yieldGroup = YieldGroup.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   YieldGroup response = yieldGroupServiceClient.updateYieldGroup(yieldGroup, updateMask);
 }
 
Parameters
Name Description
yieldGroup YieldGroup

Required. The YieldGroup to update.

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

updateMask FieldMask

Optional. The list of fields to update.

Returns
Type Description
YieldGroup

updateYieldGroupCallable()

public final UnaryCallable<UpdateYieldGroupRequest,YieldGroup> updateYieldGroupCallable()

Updates a YieldGroup object.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (YieldGroupServiceClient yieldGroupServiceClient = YieldGroupServiceClient.create()) {
   UpdateYieldGroupRequest request =
       UpdateYieldGroupRequest.newBuilder()
           .setYieldGroup(YieldGroup.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<YieldGroup> future =
       yieldGroupServiceClient.updateYieldGroupCallable().futureCall(request);
   // Do something.
   YieldGroup response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateYieldGroupRequest,YieldGroup>