Class AutofeedSettingsServiceClient (0.10.0)

GitHub RepositoryProduct Reference

Service Description: Service to support autofeed setting.

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 (AutofeedSettingsServiceClient autofeedSettingsServiceClient =
     AutofeedSettingsServiceClient.create()) {
   AutofeedSettingsName name = AutofeedSettingsName.of("[ACCOUNT]");
   AutofeedSettings response = autofeedSettingsServiceClient.getAutofeedSettings(name);
 }

Note: close() needs to be called on the AutofeedSettingsServiceClient 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

GetAutofeedSettings

Retrieves the autofeed settings of an account.

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

  • getAutofeedSettings(GetAutofeedSettingsRequest request)

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

  • getAutofeedSettings(AutofeedSettingsName name)

  • getAutofeedSettings(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.

  • getAutofeedSettingsCallable()

UpdateAutofeedSettings

Updates the autofeed settings of an account.

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

  • updateAutofeedSettings(UpdateAutofeedSettingsRequest request)

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

  • updateAutofeedSettings(AutofeedSettings autofeedSettings, 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.

  • updateAutofeedSettingsCallable()

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 AutofeedSettingsServiceSettings 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
 AutofeedSettingsServiceSettings autofeedSettingsServiceSettings =
     AutofeedSettingsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AutofeedSettingsServiceClient autofeedSettingsServiceClient =
     AutofeedSettingsServiceClient.create(autofeedSettingsServiceSettings);

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
 AutofeedSettingsServiceSettings autofeedSettingsServiceSettings =
     AutofeedSettingsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AutofeedSettingsServiceClient autofeedSettingsServiceClient =
     AutofeedSettingsServiceClient.create(autofeedSettingsServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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
 AutofeedSettingsServiceSettings autofeedSettingsServiceSettings =
     AutofeedSettingsServiceSettings.newHttpJsonBuilder().build();
 AutofeedSettingsServiceClient autofeedSettingsServiceClient =
     AutofeedSettingsServiceClient.create(autofeedSettingsServiceSettings);

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

Inheritance

java.lang.Object > AutofeedSettingsServiceClient

Static Methods

create()

public static final AutofeedSettingsServiceClient create()

Constructs an instance of AutofeedSettingsServiceClient with default settings.

Returns
Type Description
AutofeedSettingsServiceClient
Exceptions
Type Description
IOException

create(AutofeedSettingsServiceSettings settings)

public static final AutofeedSettingsServiceClient create(AutofeedSettingsServiceSettings settings)

Constructs an instance of AutofeedSettingsServiceClient, 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 AutofeedSettingsServiceSettings
Returns
Type Description
AutofeedSettingsServiceClient
Exceptions
Type Description
IOException

create(AutofeedSettingsServiceStub stub)

public static final AutofeedSettingsServiceClient create(AutofeedSettingsServiceStub stub)

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

Parameter
Name Description
stub AutofeedSettingsServiceStub
Returns
Type Description
AutofeedSettingsServiceClient

Constructors

AutofeedSettingsServiceClient(AutofeedSettingsServiceSettings settings)

protected AutofeedSettingsServiceClient(AutofeedSettingsServiceSettings settings)

Constructs an instance of AutofeedSettingsServiceClient, 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 AutofeedSettingsServiceSettings

AutofeedSettingsServiceClient(AutofeedSettingsServiceStub stub)

protected AutofeedSettingsServiceClient(AutofeedSettingsServiceStub stub)
Parameter
Name Description
stub AutofeedSettingsServiceStub

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

close()

public final void close()

getAutofeedSettings(AutofeedSettingsName name)

public final AutofeedSettings getAutofeedSettings(AutofeedSettingsName name)

Retrieves the autofeed settings of an account.

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 (AutofeedSettingsServiceClient autofeedSettingsServiceClient =
     AutofeedSettingsServiceClient.create()) {
   AutofeedSettingsName name = AutofeedSettingsName.of("[ACCOUNT]");
   AutofeedSettings response = autofeedSettingsServiceClient.getAutofeedSettings(name);
 }
Parameter
Name Description
name AutofeedSettingsName

Required. The resource name of the autofeed settings. Format: accounts/{account}/autofeedSettings
Returns
Type Description
AutofeedSettings

getAutofeedSettings(GetAutofeedSettingsRequest request)

public final AutofeedSettings getAutofeedSettings(GetAutofeedSettingsRequest request)

Retrieves the autofeed settings of an account.

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 (AutofeedSettingsServiceClient autofeedSettingsServiceClient =
     AutofeedSettingsServiceClient.create()) {
   GetAutofeedSettingsRequest request =
       GetAutofeedSettingsRequest.newBuilder()
           .setName(AutofeedSettingsName.of("[ACCOUNT]").toString())
           .build();
   AutofeedSettings response = autofeedSettingsServiceClient.getAutofeedSettings(request);
 }
Parameter
Name Description
request GetAutofeedSettingsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AutofeedSettings

getAutofeedSettings(String name)

public final AutofeedSettings getAutofeedSettings(String name)

Retrieves the autofeed settings of an account.

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 (AutofeedSettingsServiceClient autofeedSettingsServiceClient =
     AutofeedSettingsServiceClient.create()) {
   String name = AutofeedSettingsName.of("[ACCOUNT]").toString();
   AutofeedSettings response = autofeedSettingsServiceClient.getAutofeedSettings(name);
 }
Parameter
Name Description
name String

Required. The resource name of the autofeed settings. Format: accounts/{account}/autofeedSettings
Returns
Type Description
AutofeedSettings

getAutofeedSettingsCallable()

public final UnaryCallable<GetAutofeedSettingsRequest,AutofeedSettings> getAutofeedSettingsCallable()

Retrieves the autofeed settings of an account.

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 (AutofeedSettingsServiceClient autofeedSettingsServiceClient =
     AutofeedSettingsServiceClient.create()) {
   GetAutofeedSettingsRequest request =
       GetAutofeedSettingsRequest.newBuilder()
           .setName(AutofeedSettingsName.of("[ACCOUNT]").toString())
           .build();
   ApiFuture<AutofeedSettings> future =
       autofeedSettingsServiceClient.getAutofeedSettingsCallable().futureCall(request);
   // Do something.
   AutofeedSettings response = future.get();
 }
Returns
Type Description
UnaryCallable<GetAutofeedSettingsRequest,AutofeedSettings>

getSettings()

public final AutofeedSettingsServiceSettings getSettings()
Returns
Type Description
AutofeedSettingsServiceSettings

getStub()

public AutofeedSettingsServiceStub getStub()
Returns
Type Description
AutofeedSettingsServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAutofeedSettings(AutofeedSettings autofeedSettings, FieldMask updateMask)

public final AutofeedSettings updateAutofeedSettings(AutofeedSettings autofeedSettings, FieldMask updateMask)

Updates the autofeed settings of an account.

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 (AutofeedSettingsServiceClient autofeedSettingsServiceClient =
     AutofeedSettingsServiceClient.create()) {
   AutofeedSettings autofeedSettings = AutofeedSettings.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AutofeedSettings response =
       autofeedSettingsServiceClient.updateAutofeedSettings(autofeedSettings, updateMask);
 }
Parameters
Name Description
autofeedSettings AutofeedSettings

Required. The new version of the autofeed setting.
updateMask FieldMask

Required. List of fields being updated.
Returns
Type Description
AutofeedSettings

updateAutofeedSettings(UpdateAutofeedSettingsRequest request)

public final AutofeedSettings updateAutofeedSettings(UpdateAutofeedSettingsRequest request)

Updates the autofeed settings of an account.

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 (AutofeedSettingsServiceClient autofeedSettingsServiceClient =
     AutofeedSettingsServiceClient.create()) {
   UpdateAutofeedSettingsRequest request =
       UpdateAutofeedSettingsRequest.newBuilder()
           .setAutofeedSettings(AutofeedSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   AutofeedSettings response = autofeedSettingsServiceClient.updateAutofeedSettings(request);
 }
Parameter
Name Description
request UpdateAutofeedSettingsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AutofeedSettings

updateAutofeedSettingsCallable()

public final UnaryCallable<UpdateAutofeedSettingsRequest,AutofeedSettings> updateAutofeedSettingsCallable()

Updates the autofeed settings of an account.

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 (AutofeedSettingsServiceClient autofeedSettingsServiceClient =
     AutofeedSettingsServiceClient.create()) {
   UpdateAutofeedSettingsRequest request =
       UpdateAutofeedSettingsRequest.newBuilder()
           .setAutofeedSettings(AutofeedSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<AutofeedSettings> future =
       autofeedSettingsServiceClient.updateAutofeedSettingsCallable().futureCall(request);
   // Do something.
   AutofeedSettings response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateAutofeedSettingsRequest,AutofeedSettings>