Class BreakTemplateServiceClient (0.58.0)

Service Description: Provides methods for handling BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   BreakTemplateName name = BreakTemplateName.of("[NETWORK_CODE]", "[BREAK_TEMPLATE]");
   BreakTemplate response = breakTemplateServiceClient.getBreakTemplate(name);
 }

Note: close() needs to be called on the BreakTemplateServiceClient 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
GetBreakTemplate	Retrieves a `BreakTemplate` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getBreakTemplate(GetBreakTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getBreakTemplate(BreakTemplateName name) getBreakTemplate(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. getBreakTemplateCallable()
ListBreakTemplates	Lists `BreakTemplate` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listBreakTemplates(ListBreakTemplatesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listBreakTemplates(NetworkName parent) listBreakTemplates(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. listBreakTemplatesPagedCallable() listBreakTemplatesCallable()
CreateBreakTemplate	Creates a `BreakTemplate` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createBreakTemplate(CreateBreakTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createBreakTemplate(NetworkName parent, BreakTemplate breakTemplate) createBreakTemplate(String parent, BreakTemplate breakTemplate) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createBreakTemplateCallable()
BatchCreateBreakTemplates	Batch creates `BreakTemplate` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchCreateBreakTemplates(NetworkName parent, List<CreateBreakTemplateRequest> requests) batchCreateBreakTemplates(String parent, List<CreateBreakTemplateRequest> requests) batchCreateBreakTemplates(BatchCreateBreakTemplatesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchCreateBreakTemplatesCallable()
UpdateBreakTemplate	Updates a `BreakTemplate` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateBreakTemplate(UpdateBreakTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateBreakTemplate(BreakTemplate breakTemplate, 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. updateBreakTemplateCallable()
BatchUpdateBreakTemplates	Batch updates `BreakTemplate` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchUpdateBreakTemplates(NetworkName parent, List<UpdateBreakTemplateRequest> requests) batchUpdateBreakTemplates(String parent, List<UpdateBreakTemplateRequest> requests) batchUpdateBreakTemplates(BatchUpdateBreakTemplatesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchUpdateBreakTemplatesCallable()

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 BreakTemplateServiceSettings 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
 BreakTemplateServiceSettings breakTemplateServiceSettings =
     BreakTemplateServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create(breakTemplateServiceSettings);

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
 BreakTemplateServiceSettings breakTemplateServiceSettings =
     BreakTemplateServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create(breakTemplateServiceSettings);

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

Inheritance

java.lang.Object > BreakTemplateServiceClient

Static Methods

create()

public static final BreakTemplateServiceClient create()

Constructs an instance of BreakTemplateServiceClient with default settings.

Returns
Type	Description
`BreakTemplateServiceClient`

Exceptions
Type	Description
`IOException`

create(BreakTemplateServiceSettings settings)

public static final BreakTemplateServiceClient create(BreakTemplateServiceSettings settings)

Constructs an instance of BreakTemplateServiceClient, 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`	`BreakTemplateServiceSettings`

Returns
Type	Description
`BreakTemplateServiceClient`

Exceptions
Type	Description
`IOException`

create(BreakTemplateServiceStub stub)

public static final BreakTemplateServiceClient create(BreakTemplateServiceStub stub)

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

Parameter
Name	Description
`stub`	`BreakTemplateServiceStub`

Returns
Type	Description
`BreakTemplateServiceClient`

Constructors

BreakTemplateServiceClient(BreakTemplateServiceSettings settings)

protected BreakTemplateServiceClient(BreakTemplateServiceSettings settings)

Constructs an instance of BreakTemplateServiceClient, 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`	`BreakTemplateServiceSettings`

BreakTemplateServiceClient(BreakTemplateServiceStub stub)

protected BreakTemplateServiceClient(BreakTemplateServiceStub stub)

Parameter
Name	Description
`stub`	`BreakTemplateServiceStub`

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`

batchCreateBreakTemplates(@Nullable NetworkName parent, List<CreateBreakTemplateRequest> requests)

public final BatchCreateBreakTemplatesResponse batchCreateBreakTemplates(@Nullable NetworkName parent, List<CreateBreakTemplateRequest> requests)

Batch creates BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<CreateBreakTemplateRequest> requests = new ArrayList<>();
   BatchCreateBreakTemplatesResponse response =
       breakTemplateServiceClient.batchCreateBreakTemplates(parent, requests);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName` Required. The parent resource where `BreakTemplates` will be created. Format: `networks/{network_code}` The parent field in the `CreateBreakTemplateRequest` must match this field.
`requests`	`List<CreateBreakTemplateRequest>` Required. The `BreakTemplate` objects to create. A maximum of 100 objects can be created in a batch.

Returns
Type	Description
`BatchCreateBreakTemplatesResponse`

batchCreateBreakTemplates(BatchCreateBreakTemplatesRequest request)

public final BatchCreateBreakTemplatesResponse batchCreateBreakTemplates(BatchCreateBreakTemplatesRequest request)

Batch creates BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   BatchCreateBreakTemplatesRequest request =
       BatchCreateBreakTemplatesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<CreateBreakTemplateRequest>())
           .build();
   BatchCreateBreakTemplatesResponse response =
       breakTemplateServiceClient.batchCreateBreakTemplates(request);
 }

Parameter
Name	Description
`request`	`BatchCreateBreakTemplatesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BatchCreateBreakTemplatesResponse`

batchCreateBreakTemplates(String parent, List<CreateBreakTemplateRequest> requests)

public final BatchCreateBreakTemplatesResponse batchCreateBreakTemplates(String parent, List<CreateBreakTemplateRequest> requests)

Batch creates BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<CreateBreakTemplateRequest> requests = new ArrayList<>();
   BatchCreateBreakTemplatesResponse response =
       breakTemplateServiceClient.batchCreateBreakTemplates(parent, requests);
 }

Parameters
Name	Description
`parent`	`String` Required. The parent resource where `BreakTemplates` will be created. Format: `networks/{network_code}` The parent field in the `CreateBreakTemplateRequest` must match this field.
`requests`	`List<CreateBreakTemplateRequest>` Required. The `BreakTemplate` objects to create. A maximum of 100 objects can be created in a batch.

Returns
Type	Description
`BatchCreateBreakTemplatesResponse`

batchCreateBreakTemplatesCallable()

public final UnaryCallable<BatchCreateBreakTemplatesRequest,BatchCreateBreakTemplatesResponse> batchCreateBreakTemplatesCallable()

Batch creates BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   BatchCreateBreakTemplatesRequest request =
       BatchCreateBreakTemplatesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<CreateBreakTemplateRequest>())
           .build();
   ApiFuture<BatchCreateBreakTemplatesResponse> future =
       breakTemplateServiceClient.batchCreateBreakTemplatesCallable().futureCall(request);
   // Do something.
   BatchCreateBreakTemplatesResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchCreateBreakTemplatesRequest,BatchCreateBreakTemplatesResponse>`

batchUpdateBreakTemplates(@Nullable NetworkName parent, List<UpdateBreakTemplateRequest> requests)

public final BatchUpdateBreakTemplatesResponse batchUpdateBreakTemplates(@Nullable NetworkName parent, List<UpdateBreakTemplateRequest> requests)

Batch updates BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<UpdateBreakTemplateRequest> requests = new ArrayList<>();
   BatchUpdateBreakTemplatesResponse response =
       breakTemplateServiceClient.batchUpdateBreakTemplates(parent, requests);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName` Required. The parent resource where `BreakTemplates` will be updated. Format: `networks/{network_code}` The parent field in the `UpdateBreakTemplateRequest` must match this field.
`requests`	`List<UpdateBreakTemplateRequest>` Required. The `BreakTemplate` objects to update. A maximum of 100 objects can be updated in a batch.

Returns
Type	Description
`BatchUpdateBreakTemplatesResponse`

batchUpdateBreakTemplates(BatchUpdateBreakTemplatesRequest request)

public final BatchUpdateBreakTemplatesResponse batchUpdateBreakTemplates(BatchUpdateBreakTemplatesRequest request)

Batch updates BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   BatchUpdateBreakTemplatesRequest request =
       BatchUpdateBreakTemplatesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<UpdateBreakTemplateRequest>())
           .build();
   BatchUpdateBreakTemplatesResponse response =
       breakTemplateServiceClient.batchUpdateBreakTemplates(request);
 }

Parameter
Name	Description
`request`	`BatchUpdateBreakTemplatesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BatchUpdateBreakTemplatesResponse`

batchUpdateBreakTemplates(String parent, List<UpdateBreakTemplateRequest> requests)

public final BatchUpdateBreakTemplatesResponse batchUpdateBreakTemplates(String parent, List<UpdateBreakTemplateRequest> requests)

Batch updates BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<UpdateBreakTemplateRequest> requests = new ArrayList<>();
   BatchUpdateBreakTemplatesResponse response =
       breakTemplateServiceClient.batchUpdateBreakTemplates(parent, requests);
 }

Parameters
Name	Description
`parent`	`String` Required. The parent resource where `BreakTemplates` will be updated. Format: `networks/{network_code}` The parent field in the `UpdateBreakTemplateRequest` must match this field.
`requests`	`List<UpdateBreakTemplateRequest>` Required. The `BreakTemplate` objects to update. A maximum of 100 objects can be updated in a batch.

Returns
Type	Description
`BatchUpdateBreakTemplatesResponse`

batchUpdateBreakTemplatesCallable()

public final UnaryCallable<BatchUpdateBreakTemplatesRequest,BatchUpdateBreakTemplatesResponse> batchUpdateBreakTemplatesCallable()

Batch updates BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   BatchUpdateBreakTemplatesRequest request =
       BatchUpdateBreakTemplatesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<UpdateBreakTemplateRequest>())
           .build();
   ApiFuture<BatchUpdateBreakTemplatesResponse> future =
       breakTemplateServiceClient.batchUpdateBreakTemplatesCallable().futureCall(request);
   // Do something.
   BatchUpdateBreakTemplatesResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchUpdateBreakTemplatesRequest,BatchUpdateBreakTemplatesResponse>`

close()

public final void close()

createBreakTemplate(@Nullable NetworkName parent, BreakTemplate breakTemplate)

public final BreakTemplate createBreakTemplate(@Nullable NetworkName parent, BreakTemplate breakTemplate)

Creates a BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   BreakTemplate breakTemplate = BreakTemplate.newBuilder().build();
   BreakTemplate response =
       breakTemplateServiceClient.createBreakTemplate(parent, breakTemplate);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName` Required. The parent resource where this `BreakTemplate` will be created. Format: `networks/{network_code}`
`breakTemplate`	`BreakTemplate` Required. The `BreakTemplate` to create.

Returns
Type	Description
`BreakTemplate`

createBreakTemplate(CreateBreakTemplateRequest request)

public final BreakTemplate createBreakTemplate(CreateBreakTemplateRequest request)

Creates a BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   CreateBreakTemplateRequest request =
       CreateBreakTemplateRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setBreakTemplate(BreakTemplate.newBuilder().build())
           .build();
   BreakTemplate response = breakTemplateServiceClient.createBreakTemplate(request);
 }

Parameter
Name	Description
`request`	`CreateBreakTemplateRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BreakTemplate`

createBreakTemplate(String parent, BreakTemplate breakTemplate)

public final BreakTemplate createBreakTemplate(String parent, BreakTemplate breakTemplate)

Creates a BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   BreakTemplate breakTemplate = BreakTemplate.newBuilder().build();
   BreakTemplate response =
       breakTemplateServiceClient.createBreakTemplate(parent, breakTemplate);
 }

Parameters
Name	Description
`parent`	`String` Required. The parent resource where this `BreakTemplate` will be created. Format: `networks/{network_code}`
`breakTemplate`	`BreakTemplate` Required. The `BreakTemplate` to create.

Returns
Type	Description
`BreakTemplate`

createBreakTemplateCallable()

public final UnaryCallable<CreateBreakTemplateRequest,BreakTemplate> createBreakTemplateCallable()

Creates a BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   CreateBreakTemplateRequest request =
       CreateBreakTemplateRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setBreakTemplate(BreakTemplate.newBuilder().build())
           .build();
   ApiFuture<BreakTemplate> future =
       breakTemplateServiceClient.createBreakTemplateCallable().futureCall(request);
   // Do something.
   BreakTemplate response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateBreakTemplateRequest,BreakTemplate>`

getBreakTemplate(@Nullable BreakTemplateName name)

public final BreakTemplate getBreakTemplate(@Nullable BreakTemplateName name)

Retrieves a BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   BreakTemplateName name = BreakTemplateName.of("[NETWORK_CODE]", "[BREAK_TEMPLATE]");
   BreakTemplate response = breakTemplateServiceClient.getBreakTemplate(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.BreakTemplateName` Required. The resource name of the `BreakTemplate`. Format: `networks/{network_code}/breakTemplates/{break_template_id}`

Returns
Type	Description
`BreakTemplate`

getBreakTemplate(GetBreakTemplateRequest request)

public final BreakTemplate getBreakTemplate(GetBreakTemplateRequest request)

Retrieves a BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   GetBreakTemplateRequest request =
       GetBreakTemplateRequest.newBuilder()
           .setName(BreakTemplateName.of("[NETWORK_CODE]", "[BREAK_TEMPLATE]").toString())
           .build();
   BreakTemplate response = breakTemplateServiceClient.getBreakTemplate(request);
 }

Parameter
Name	Description
`request`	`GetBreakTemplateRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BreakTemplate`

getBreakTemplate(String name)

public final BreakTemplate getBreakTemplate(String name)

Retrieves a BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   String name = BreakTemplateName.of("[NETWORK_CODE]", "[BREAK_TEMPLATE]").toString();
   BreakTemplate response = breakTemplateServiceClient.getBreakTemplate(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the `BreakTemplate`. Format: `networks/{network_code}/breakTemplates/{break_template_id}`

Returns
Type	Description
`BreakTemplate`

getBreakTemplateCallable()

public final UnaryCallable<GetBreakTemplateRequest,BreakTemplate> getBreakTemplateCallable()

Retrieves a BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   GetBreakTemplateRequest request =
       GetBreakTemplateRequest.newBuilder()
           .setName(BreakTemplateName.of("[NETWORK_CODE]", "[BREAK_TEMPLATE]").toString())
           .build();
   ApiFuture<BreakTemplate> future =
       breakTemplateServiceClient.getBreakTemplateCallable().futureCall(request);
   // Do something.
   BreakTemplate response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetBreakTemplateRequest,BreakTemplate>`

getSettings()

public final @Nullable BreakTemplateServiceSettings getSettings()

Returns
Type	Description
`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.BreakTemplateServiceSettings`

getStub()

public BreakTemplateServiceStub getStub()

Returns
Type	Description
`BreakTemplateServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listBreakTemplates(@Nullable NetworkName parent)

public final BreakTemplateServiceClient.ListBreakTemplatesPagedResponse listBreakTemplates(@Nullable NetworkName parent)

Lists BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (BreakTemplate element :
       breakTemplateServiceClient.listBreakTemplates(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 `BreakTemplates`. Format: `networks/{network_code}`

Returns
Type	Description
`BreakTemplateServiceClient.ListBreakTemplatesPagedResponse`

listBreakTemplates(ListBreakTemplatesRequest request)

public final BreakTemplateServiceClient.ListBreakTemplatesPagedResponse listBreakTemplates(ListBreakTemplatesRequest request)

Lists BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   ListBreakTemplatesRequest request =
       ListBreakTemplatesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (BreakTemplate element :
       breakTemplateServiceClient.listBreakTemplates(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListBreakTemplatesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BreakTemplateServiceClient.ListBreakTemplatesPagedResponse`

listBreakTemplates(String parent)

public final BreakTemplateServiceClient.ListBreakTemplatesPagedResponse listBreakTemplates(String parent)

Lists BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (BreakTemplate element :
       breakTemplateServiceClient.listBreakTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of `BreakTemplates`. Format: `networks/{network_code}`

Returns
Type	Description
`BreakTemplateServiceClient.ListBreakTemplatesPagedResponse`

listBreakTemplatesCallable()

public final UnaryCallable<ListBreakTemplatesRequest,ListBreakTemplatesResponse> listBreakTemplatesCallable()

Lists BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   ListBreakTemplatesRequest request =
       ListBreakTemplatesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListBreakTemplatesResponse response =
         breakTemplateServiceClient.listBreakTemplatesCallable().call(request);
     for (BreakTemplate element : response.getBreakTemplatesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListBreakTemplatesRequest,ListBreakTemplatesResponse>`

listBreakTemplatesPagedCallable()

public final UnaryCallable<ListBreakTemplatesRequest,BreakTemplateServiceClient.ListBreakTemplatesPagedResponse> listBreakTemplatesPagedCallable()

Lists BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   ListBreakTemplatesRequest request =
       ListBreakTemplatesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<BreakTemplate> future =
       breakTemplateServiceClient.listBreakTemplatesPagedCallable().futureCall(request);
   // Do something.
   for (BreakTemplate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListBreakTemplatesRequest,ListBreakTemplatesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateBreakTemplate(BreakTemplate breakTemplate, FieldMask updateMask)

public final BreakTemplate updateBreakTemplate(BreakTemplate breakTemplate, FieldMask updateMask)

Updates a BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   BreakTemplate breakTemplate = BreakTemplate.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   BreakTemplate response =
       breakTemplateServiceClient.updateBreakTemplate(breakTemplate, updateMask);
 }

Parameters

Name Description

breakTemplate

BreakTemplate

Required. The BreakTemplate to update.

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

updateMask

FieldMask

Optional. The list of fields to update.

Returns
Type	Description
`BreakTemplate`

updateBreakTemplate(UpdateBreakTemplateRequest request)

public final BreakTemplate updateBreakTemplate(UpdateBreakTemplateRequest request)

Updates a BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   UpdateBreakTemplateRequest request =
       UpdateBreakTemplateRequest.newBuilder()
           .setBreakTemplate(BreakTemplate.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   BreakTemplate response = breakTemplateServiceClient.updateBreakTemplate(request);
 }

Parameter
Name	Description
`request`	`UpdateBreakTemplateRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BreakTemplate`

updateBreakTemplateCallable()

public final UnaryCallable<UpdateBreakTemplateRequest,BreakTemplate> updateBreakTemplateCallable()

Updates a BreakTemplate 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 (BreakTemplateServiceClient breakTemplateServiceClient =
     BreakTemplateServiceClient.create()) {
   UpdateBreakTemplateRequest request =
       UpdateBreakTemplateRequest.newBuilder()
           .setBreakTemplate(BreakTemplate.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<BreakTemplate> future =
       breakTemplateServiceClient.updateBreakTemplateCallable().futureCall(request);
   // Do something.
   BreakTemplate response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateBreakTemplateRequest,BreakTemplate>`

Class BreakTemplateServiceClient (0.58.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(BreakTemplateServiceSettings settings)

create(BreakTemplateServiceStub stub)

Constructors

BreakTemplateServiceClient(BreakTemplateServiceSettings settings)

BreakTemplateServiceClient(BreakTemplateServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

batchCreateBreakTemplates(@Nullable NetworkName parent, List<CreateBreakTemplateRequest> requests)

batchCreateBreakTemplates(BatchCreateBreakTemplatesRequest request)

batchCreateBreakTemplates(String parent, List<CreateBreakTemplateRequest> requests)

batchCreateBreakTemplatesCallable()

batchUpdateBreakTemplates(@Nullable NetworkName parent, List<UpdateBreakTemplateRequest> requests)

batchUpdateBreakTemplates(BatchUpdateBreakTemplatesRequest request)

batchUpdateBreakTemplates(String parent, List<UpdateBreakTemplateRequest> requests)

batchUpdateBreakTemplatesCallable()

close()

createBreakTemplate(@Nullable NetworkName parent, BreakTemplate breakTemplate)

createBreakTemplate(CreateBreakTemplateRequest request)

createBreakTemplate(String parent, BreakTemplate breakTemplate)

createBreakTemplateCallable()

getBreakTemplate(@Nullable BreakTemplateName name)

getBreakTemplate(GetBreakTemplateRequest request)

getBreakTemplate(String name)

getBreakTemplateCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listBreakTemplates(@Nullable NetworkName parent)

listBreakTemplates(ListBreakTemplatesRequest request)

listBreakTemplates(String parent)

listBreakTemplatesCallable()

listBreakTemplatesPagedCallable()

shutdown()

shutdownNow()

updateBreakTemplate(BreakTemplate breakTemplate, FieldMask updateMask)

updateBreakTemplate(UpdateBreakTemplateRequest request)

updateBreakTemplateCallable()

Class BreakTemplateServiceClient (0.58.0)