Class FeedServiceClient
- java.lang.Object
-
- com.google.ads.googleads.v10.services.FeedServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource,java.lang.AutoCloseable
@Generated("by gapic-generator-java") public class FeedServiceClient extends java.lang.Object implements com.google.api.gax.core.BackgroundResourceService Description: Service to manage feeds.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 (FeedServiceClient feedServiceClient = FeedServiceClient.create()) { String customerId = "customerId-1581184615"; List<FeedOperation> operations = new ArrayList<>(); MutateFeedsResponse response = feedServiceClient.mutateFeeds(customerId, operations); }Note: close() needs to be called on the FeedServiceClient 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:
- 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.
- 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.
- 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 FeedServiceSettings to create(). For example:
To customize credentials:
FeedServiceSettings feedServiceSettings = FeedServiceSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); FeedServiceClient feedServiceClient = FeedServiceClient.create(feedServiceSettings);To customize the endpoint:
FeedServiceSettings feedServiceSettings = FeedServiceSettings.newBuilder().setEndpoint(myEndpoint).build(); FeedServiceClient feedServiceClient = FeedServiceClient.create(feedServiceSettings);Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedFeedServiceClient(FeedServiceSettings settings)Constructs an instance of FeedServiceClient, using the given settings.protectedFeedServiceClient(FeedServiceStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanawaitTermination(long duration, java.util.concurrent.TimeUnit unit)voidclose()static FeedServiceClientcreate()Constructs an instance of FeedServiceClient with default settings.static FeedServiceClientcreate(FeedServiceSettings settings)Constructs an instance of FeedServiceClient, using the given settings.static FeedServiceClientcreate(FeedServiceStub stub)Constructs an instance of FeedServiceClient, using the given stub for making calls.FeedServiceSettingsgetSettings()FeedServiceStubgetStub()booleanisShutdown()booleanisTerminated()MutateFeedsResponsemutateFeeds(MutateFeedsRequest request)Creates, updates, or removes feeds.MutateFeedsResponsemutateFeeds(java.lang.String customerId, java.util.List<FeedOperation> operations)Creates, updates, or removes feeds.com.google.api.gax.rpc.UnaryCallable<MutateFeedsRequest,MutateFeedsResponse>mutateFeedsCallable()Creates, updates, or removes feeds.voidshutdown()voidshutdownNow()
-
-
-
Constructor Detail
-
FeedServiceClient
protected FeedServiceClient(FeedServiceSettings settings) throws java.io.IOException
Constructs an instance of FeedServiceClient, 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
-
FeedServiceClient
@BetaApi("A restructuring of stub classes is planned, so this may break in the future") protected FeedServiceClient(FeedServiceStub stub)
-
-
Method Detail
-
create
public static final FeedServiceClient create() throws java.io.IOException
Constructs an instance of FeedServiceClient with default settings.- Throws:
java.io.IOException
-
create
public static final FeedServiceClient create(FeedServiceSettings settings) throws java.io.IOException
Constructs an instance of FeedServiceClient, 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 FeedServiceClient create(FeedServiceStub stub)Constructs an instance of FeedServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(FeedServiceSettings).
-
getSettings
public final FeedServiceSettings getSettings()
-
getStub
@BetaApi("A restructuring of stub classes is planned, so this may break in the future") public FeedServiceStub getStub()
-
mutateFeeds
public final MutateFeedsResponse mutateFeeds(java.lang.String customerId, java.util.List<FeedOperation> operations)
Creates, updates, or removes feeds. Operation statuses are returned.List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [DatabaseError]() [DistinctError]() [FeedError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
Sample code:
try (FeedServiceClient feedServiceClient = FeedServiceClient.create()) { String customerId = "customerId-1581184615"; List<FeedOperation> operations = new ArrayList<>(); MutateFeedsResponse response = feedServiceClient.mutateFeeds(customerId, operations); }- Parameters:
customerId- Required. The ID of the customer whose feeds are being modified.operations- Required. The list of operations to perform on individual feeds.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
mutateFeeds
public final MutateFeedsResponse mutateFeeds(MutateFeedsRequest request)
Creates, updates, or removes feeds. Operation statuses are returned.List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [DatabaseError]() [DistinctError]() [FeedError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
Sample code:
try (FeedServiceClient feedServiceClient = FeedServiceClient.create()) { MutateFeedsRequest request = MutateFeedsRequest.newBuilder() .setCustomerId("customerId-1581184615") .addAllOperations(new ArrayList<FeedOperation>()) .setPartialFailure(true) .setValidateOnly(true) .build(); MutateFeedsResponse response = feedServiceClient.mutateFeeds(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
-
mutateFeedsCallable
public final com.google.api.gax.rpc.UnaryCallable<MutateFeedsRequest,MutateFeedsResponse> mutateFeedsCallable()
Creates, updates, or removes feeds. Operation statuses are returned.List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [DatabaseError]() [DistinctError]() [FeedError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
Sample code:
try (FeedServiceClient feedServiceClient = FeedServiceClient.create()) { MutateFeedsRequest request = MutateFeedsRequest.newBuilder() .setCustomerId("customerId-1581184615") .addAllOperations(new ArrayList<FeedOperation>()) .setPartialFailure(true) .setValidateOnly(true) .build(); ApiFuture<MutateFeedsResponse> future = feedServiceClient.mutateFeedsCallable().futureCall(request); // Do something. MutateFeedsResponse response = future.get(); }
-
close
public final void close()
- Specified by:
closein interfacejava.lang.AutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdownin interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdownin interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminatedin interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNowin interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, java.util.concurrent.TimeUnit unit) throws java.lang.InterruptedException- Specified by:
awaitTerminationin interfacecom.google.api.gax.core.BackgroundResource- Throws:
java.lang.InterruptedException
-
-