Class SharedSetServiceClient
- java.lang.Object
-
- com.google.ads.googleads.v14.services.SharedSetServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,java.lang.AutoCloseable
@Generated("by gapic-generator-java") public class SharedSetServiceClient extends java.lang.Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service to manage shared sets.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 (SharedSetServiceClient sharedSetServiceClient = SharedSetServiceClient.create()) { String customerId = "customerId-1581184615"; List<SharedSetOperation> operations = new ArrayList<>(); MutateSharedSetsResponse response = sharedSetServiceClient.mutateSharedSets(customerId, operations); }
Note: close() needs to be called on the SharedSetServiceClient 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 MutateSharedSets
Creates, updates, or removes shared sets. Operation statuses are returned.
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SharedSetError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
Request object method variants only take one parameter, a request object, which must be constructed before the call.
mutateSharedSets(MutateSharedSetsRequest request)
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
mutateSharedSets(String customerId, List<SharedSetOperation> operations)
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
mutateSharedSetsCallable()
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 SharedSetServiceSettings 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 SharedSetServiceSettings sharedSetServiceSettings = SharedSetServiceSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); SharedSetServiceClient sharedSetServiceClient = SharedSetServiceClient.create(sharedSetServiceSettings);
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 SharedSetServiceSettings sharedSetServiceSettings = SharedSetServiceSettings.newBuilder().setEndpoint(myEndpoint).build(); SharedSetServiceClient sharedSetServiceClient = SharedSetServiceClient.create(sharedSetServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
SharedSetServiceClient(SharedSetServiceSettings settings)
Constructs an instance of SharedSetServiceClient, using the given settings.protected
SharedSetServiceClient(SharedSetServiceStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void
close()
static SharedSetServiceClient
create()
Constructs an instance of SharedSetServiceClient with default settings.static SharedSetServiceClient
create(SharedSetServiceSettings settings)
Constructs an instance of SharedSetServiceClient, using the given settings.static SharedSetServiceClient
create(SharedSetServiceStub stub)
Constructs an instance of SharedSetServiceClient, using the given stub for making calls.SharedSetServiceSettings
getSettings()
SharedSetServiceStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
MutateSharedSetsResponse
mutateSharedSets(MutateSharedSetsRequest request)
Creates, updates, or removes shared sets.MutateSharedSetsResponse
mutateSharedSets(java.lang.String customerId, java.util.List<SharedSetOperation> operations)
Creates, updates, or removes shared sets.com.google.api.gax.rpc.UnaryCallable<MutateSharedSetsRequest,MutateSharedSetsResponse>
mutateSharedSetsCallable()
Creates, updates, or removes shared sets.void
shutdown()
void
shutdownNow()
-
-
-
Constructor Detail
-
SharedSetServiceClient
protected SharedSetServiceClient(SharedSetServiceSettings settings) throws java.io.IOException
Constructs an instance of SharedSetServiceClient, 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
-
SharedSetServiceClient
protected SharedSetServiceClient(SharedSetServiceStub stub)
-
-
Method Detail
-
create
public static final SharedSetServiceClient create() throws java.io.IOException
Constructs an instance of SharedSetServiceClient with default settings.- Throws:
java.io.IOException
-
create
public static final SharedSetServiceClient create(SharedSetServiceSettings settings) throws java.io.IOException
Constructs an instance of SharedSetServiceClient, 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
public static final SharedSetServiceClient create(SharedSetServiceStub stub)
Constructs an instance of SharedSetServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SharedSetServiceSettings).
-
getSettings
public final SharedSetServiceSettings getSettings()
-
getStub
public SharedSetServiceStub getStub()
-
mutateSharedSets
public final MutateSharedSetsResponse mutateSharedSets(java.lang.String customerId, java.util.List<SharedSetOperation> operations)
Creates, updates, or removes shared sets. Operation statuses are returned.List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SharedSetError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
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 (SharedSetServiceClient sharedSetServiceClient = SharedSetServiceClient.create()) { String customerId = "customerId-1581184615"; List<SharedSetOperation> operations = new ArrayList<>(); MutateSharedSetsResponse response = sharedSetServiceClient.mutateSharedSets(customerId, operations); }
- Parameters:
customerId
- Required. The ID of the customer whose shared sets are being modified.operations
- Required. The list of operations to perform on individual shared sets.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
mutateSharedSets
public final MutateSharedSetsResponse mutateSharedSets(MutateSharedSetsRequest request)
Creates, updates, or removes shared sets. Operation statuses are returned.List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SharedSetError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
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 (SharedSetServiceClient sharedSetServiceClient = SharedSetServiceClient.create()) { MutateSharedSetsRequest request = MutateSharedSetsRequest.newBuilder() .setCustomerId("customerId-1581184615") .addAllOperations(new ArrayList<SharedSetOperation>()) .setPartialFailure(true) .setValidateOnly(true) .build(); MutateSharedSetsResponse response = sharedSetServiceClient.mutateSharedSets(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
-
mutateSharedSetsCallable
public final com.google.api.gax.rpc.UnaryCallable<MutateSharedSetsRequest,MutateSharedSetsResponse> mutateSharedSetsCallable()
Creates, updates, or removes shared sets. Operation statuses are returned.List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SharedSetError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
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 (SharedSetServiceClient sharedSetServiceClient = SharedSetServiceClient.create()) { MutateSharedSetsRequest request = MutateSharedSetsRequest.newBuilder() .setCustomerId("customerId-1581184615") .addAllOperations(new ArrayList<SharedSetOperation>()) .setPartialFailure(true) .setValidateOnly(true) .build(); ApiFuture<MutateSharedSetsResponse> future = sharedSetServiceClient.mutateSharedSetsCallable().futureCall(request); // Do something. MutateSharedSetsResponse response = future.get(); }
-
close
public final void close()
- Specified by:
close
in interfacejava.lang.AutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, java.util.concurrent.TimeUnit unit) throws java.lang.InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
java.lang.InterruptedException
-
-