Package com.google.ads.googleads.v10.services

Class AssetSetAssetServiceClient

java.lang.Object

com.google.ads.googleads.v10.services.AssetSetAssetServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable

@Generated("by gapic-generator-java")
public class AssetSetAssetServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service to manage asset set asset.

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:

 try (AssetSetAssetServiceClient assetSetAssetServiceClient =
     AssetSetAssetServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<AssetSetAssetOperation> operations = new ArrayList<>();
   MutateAssetSetAssetsResponse response =
       assetSetAssetServiceClient.mutateAssetSetAssets(customerId, operations);
 }
 

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

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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 AssetSetAssetServiceSettings to create(). For example:

To customize credentials:

 AssetSetAssetServiceSettings assetSetAssetServiceSettings =
     AssetSetAssetServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AssetSetAssetServiceClient assetSetAssetServiceClient =
     AssetSetAssetServiceClient.create(assetSetAssetServiceSettings);
 

To customize the endpoint:

 AssetSetAssetServiceSettings assetSetAssetServiceSettings =
     AssetSetAssetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AssetSetAssetServiceClient assetSetAssetServiceClient =
     AssetSetAssetServiceClient.create(assetSetAssetServiceSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AssetSetAssetServiceClient(AssetSetAssetServiceSettings settings)	Constructs an instance of AssetSetAssetServiceClient, using the given settings.
protected	AssetSetAssetServiceClient(AssetSetAssetServiceStub stub)

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void	close()
static AssetSetAssetServiceClient	create()	Constructs an instance of AssetSetAssetServiceClient with default settings.
static AssetSetAssetServiceClient	create(AssetSetAssetServiceSettings settings)	Constructs an instance of AssetSetAssetServiceClient, using the given settings.
static AssetSetAssetServiceClient	create(AssetSetAssetServiceStub stub)	Constructs an instance of AssetSetAssetServiceClient, using the given stub for making calls.
AssetSetAssetServiceSettings	getSettings()
AssetSetAssetServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
MutateAssetSetAssetsResponse	mutateAssetSetAssets(MutateAssetSetAssetsRequest request)	Creates, updates or removes asset set assets.
MutateAssetSetAssetsResponse	mutateAssetSetAssets(java.lang.String customerId, java.util.List<AssetSetAssetOperation> operations)	Creates, updates or removes asset set assets.
com.google.api.gax.rpc.UnaryCallable<MutateAssetSetAssetsRequest,MutateAssetSetAssetsResponse>	mutateAssetSetAssetsCallable()	Creates, updates or removes asset set assets.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssetSetAssetServiceClient

protected AssetSetAssetServiceClient(AssetSetAssetServiceSettings settings)
                              throws java.io.IOException

Constructs an instance of AssetSetAssetServiceClient, 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.

Throws:

java.io.IOException

AssetSetAssetServiceClient

@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected AssetSetAssetServiceClient(AssetSetAssetServiceStub stub)

Method Detail

create

public static final AssetSetAssetServiceClient create()
                                               throws java.io.IOException

Constructs an instance of AssetSetAssetServiceClient with default settings.

Throws:

java.io.IOException

create

public static final AssetSetAssetServiceClient create(AssetSetAssetServiceSettings settings)
                                               throws java.io.IOException

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

Throws:

java.io.IOException

create

@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final AssetSetAssetServiceClient create(AssetSetAssetServiceStub stub)

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

getSettings

public final AssetSetAssetServiceSettings getSettings()

getStub

@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public AssetSetAssetServiceStub getStub()

mutateAssetSetAssets

public final MutateAssetSetAssetsResponse mutateAssetSetAssets(java.lang.String customerId,
                                                               java.util.List<AssetSetAssetOperation> operations)

Creates, updates or removes asset set assets. Operation statuses are returned.

Sample code:

 try (AssetSetAssetServiceClient assetSetAssetServiceClient =
     AssetSetAssetServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<AssetSetAssetOperation> operations = new ArrayList<>();
   MutateAssetSetAssetsResponse response =
       assetSetAssetServiceClient.mutateAssetSetAssets(customerId, operations);
 }
 

Parameters:

customerId - Required. The ID of the customer whose asset set assets are being modified.

operations - Required. The list of operations to perform on individual asset set assets.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

mutateAssetSetAssets

public final MutateAssetSetAssetsResponse mutateAssetSetAssets(MutateAssetSetAssetsRequest request)

Creates, updates or removes asset set assets. Operation statuses are returned.

Sample code:

 try (AssetSetAssetServiceClient assetSetAssetServiceClient =
     AssetSetAssetServiceClient.create()) {
   MutateAssetSetAssetsRequest request =
       MutateAssetSetAssetsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<AssetSetAssetOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateAssetSetAssetsResponse response =
       assetSetAssetServiceClient.mutateAssetSetAssets(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

mutateAssetSetAssetsCallable

public final com.google.api.gax.rpc.UnaryCallable<MutateAssetSetAssetsRequest,MutateAssetSetAssetsResponse> mutateAssetSetAssetsCallable()

Creates, updates or removes asset set assets. Operation statuses are returned.

Sample code:

 try (AssetSetAssetServiceClient assetSetAssetServiceClient =
     AssetSetAssetServiceClient.create()) {
   MutateAssetSetAssetsRequest request =
       MutateAssetSetAssetsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<AssetSetAssetOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateAssetSetAssetsResponse> future =
       assetSetAssetServiceClient.mutateAssetSetAssetsCallable().futureCall(request);
   // Do something.
   MutateAssetSetAssetsResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface java.lang.AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                java.util.concurrent.TimeUnit unit)
                         throws java.lang.InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

java.lang.InterruptedException