Class TermsOfServiceServiceClient (0.4.0)

GitHub RepositoryProduct Reference

Service Description: Service to support TermsOfService API.

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 (TermsOfServiceServiceClient termsOfServiceServiceClient =
     TermsOfServiceServiceClient.create()) {
   TermsOfServiceName name = TermsOfServiceName.of("[VERSION]");
   TermsOfService response = termsOfServiceServiceClient.getTermsOfService(name);
 }

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

GetTermsOfService

Retrieves the TermsOfService associated with the provided version.

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

  • getTermsOfService(GetTermsOfServiceRequest request)

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

  • getTermsOfService(TermsOfServiceName name)

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

  • getTermsOfServiceCallable()

RetrieveLatestTermsOfService

Retrieves the latest version of the TermsOfService for a given kind and region_code.

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

  • retrieveLatestTermsOfService(RetrieveLatestTermsOfServiceRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • retrieveLatestTermsOfServiceCallable()

AcceptTermsOfService

Accepts a TermsOfService. Executing this method requires admin access.

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

  • acceptTermsOfService(AcceptTermsOfServiceRequest request)

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

  • acceptTermsOfService(TermsOfServiceName name)

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

  • acceptTermsOfServiceCallable()

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 TermsOfServiceServiceSettings 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
 TermsOfServiceServiceSettings termsOfServiceServiceSettings =
     TermsOfServiceServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TermsOfServiceServiceClient termsOfServiceServiceClient =
     TermsOfServiceServiceClient.create(termsOfServiceServiceSettings);

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
 TermsOfServiceServiceSettings termsOfServiceServiceSettings =
     TermsOfServiceServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TermsOfServiceServiceClient termsOfServiceServiceClient =
     TermsOfServiceServiceClient.create(termsOfServiceServiceSettings);

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
 TermsOfServiceServiceSettings termsOfServiceServiceSettings =
     TermsOfServiceServiceSettings.newHttpJsonBuilder().build();
 TermsOfServiceServiceClient termsOfServiceServiceClient =
     TermsOfServiceServiceClient.create(termsOfServiceServiceSettings);

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

Inheritance

java.lang.Object > TermsOfServiceServiceClient

Static Methods

create()

public static final TermsOfServiceServiceClient create()

Constructs an instance of TermsOfServiceServiceClient with default settings.

Returns
Type Description
TermsOfServiceServiceClient
Exceptions
Type Description
IOException

create(TermsOfServiceServiceSettings settings)

public static final TermsOfServiceServiceClient create(TermsOfServiceServiceSettings settings)

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

create(TermsOfServiceServiceStub stub)

public static final TermsOfServiceServiceClient create(TermsOfServiceServiceStub stub)

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

Parameter
Name Description
stub TermsOfServiceServiceStub
Returns
Type Description
TermsOfServiceServiceClient

Constructors

TermsOfServiceServiceClient(TermsOfServiceServiceSettings settings)

protected TermsOfServiceServiceClient(TermsOfServiceServiceSettings settings)

Constructs an instance of TermsOfServiceServiceClient, 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 TermsOfServiceServiceSettings

TermsOfServiceServiceClient(TermsOfServiceServiceStub stub)

protected TermsOfServiceServiceClient(TermsOfServiceServiceStub stub)
Parameter
Name Description
stub TermsOfServiceServiceStub

Methods

acceptTermsOfService(AcceptTermsOfServiceRequest request)

public final void acceptTermsOfService(AcceptTermsOfServiceRequest request)

Accepts a TermsOfService. Executing this method requires admin access.

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 (TermsOfServiceServiceClient termsOfServiceServiceClient =
     TermsOfServiceServiceClient.create()) {
   AcceptTermsOfServiceRequest request =
       AcceptTermsOfServiceRequest.newBuilder()
           .setName(TermsOfServiceName.of("[VERSION]").toString())
           .setAccount(AccountName.of("[ACCOUNT]").toString())
           .setRegionCode("regionCode-1991004415")
           .build();
   termsOfServiceServiceClient.acceptTermsOfService(request);
 }
Parameter
Name Description
request AcceptTermsOfServiceRequest

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

acceptTermsOfService(TermsOfServiceName name)

public final void acceptTermsOfService(TermsOfServiceName name)

Accepts a TermsOfService. Executing this method requires admin access.

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 (TermsOfServiceServiceClient termsOfServiceServiceClient =
     TermsOfServiceServiceClient.create()) {
   TermsOfServiceName name = TermsOfServiceName.of("[VERSION]");
   termsOfServiceServiceClient.acceptTermsOfService(name);
 }
Parameter
Name Description
name TermsOfServiceName

Required. The resource name of the terms of service version. Format: termsOfService/{version}

acceptTermsOfService(String name)

public final void acceptTermsOfService(String name)

Accepts a TermsOfService. Executing this method requires admin access.

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 (TermsOfServiceServiceClient termsOfServiceServiceClient =
     TermsOfServiceServiceClient.create()) {
   String name = TermsOfServiceName.of("[VERSION]").toString();
   termsOfServiceServiceClient.acceptTermsOfService(name);
 }
Parameter
Name Description
name String

Required. The resource name of the terms of service version. Format: termsOfService/{version}

acceptTermsOfServiceCallable()

public final UnaryCallable<AcceptTermsOfServiceRequest,Empty> acceptTermsOfServiceCallable()

Accepts a TermsOfService. Executing this method requires admin access.

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 (TermsOfServiceServiceClient termsOfServiceServiceClient =
     TermsOfServiceServiceClient.create()) {
   AcceptTermsOfServiceRequest request =
       AcceptTermsOfServiceRequest.newBuilder()
           .setName(TermsOfServiceName.of("[VERSION]").toString())
           .setAccount(AccountName.of("[ACCOUNT]").toString())
           .setRegionCode("regionCode-1991004415")
           .build();
   ApiFuture<Empty> future =
       termsOfServiceServiceClient.acceptTermsOfServiceCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<AcceptTermsOfServiceRequest,Empty>

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()

getSettings()

public final TermsOfServiceServiceSettings getSettings()
Returns
Type Description
TermsOfServiceServiceSettings

getStub()

public TermsOfServiceServiceStub getStub()
Returns
Type Description
TermsOfServiceServiceStub

getTermsOfService(GetTermsOfServiceRequest request)

public final TermsOfService getTermsOfService(GetTermsOfServiceRequest request)

Retrieves the TermsOfService associated with the provided version.

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 (TermsOfServiceServiceClient termsOfServiceServiceClient =
     TermsOfServiceServiceClient.create()) {
   GetTermsOfServiceRequest request =
       GetTermsOfServiceRequest.newBuilder()
           .setName(TermsOfServiceName.of("[VERSION]").toString())
           .build();
   TermsOfService response = termsOfServiceServiceClient.getTermsOfService(request);
 }
Parameter
Name Description
request GetTermsOfServiceRequest

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

getTermsOfService(TermsOfServiceName name)

public final TermsOfService getTermsOfService(TermsOfServiceName name)

Retrieves the TermsOfService associated with the provided version.

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 (TermsOfServiceServiceClient termsOfServiceServiceClient =
     TermsOfServiceServiceClient.create()) {
   TermsOfServiceName name = TermsOfServiceName.of("[VERSION]");
   TermsOfService response = termsOfServiceServiceClient.getTermsOfService(name);
 }
Parameter
Name Description
name TermsOfServiceName

Required. The resource name of the terms of service version. Format: termsOfService/{version}
Returns
Type Description
TermsOfService

getTermsOfService(String name)

public final TermsOfService getTermsOfService(String name)

Retrieves the TermsOfService associated with the provided version.

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 (TermsOfServiceServiceClient termsOfServiceServiceClient =
     TermsOfServiceServiceClient.create()) {
   String name = TermsOfServiceName.of("[VERSION]").toString();
   TermsOfService response = termsOfServiceServiceClient.getTermsOfService(name);
 }
Parameter
Name Description
name String

Required. The resource name of the terms of service version. Format: termsOfService/{version}
Returns
Type Description
TermsOfService

getTermsOfServiceCallable()

public final UnaryCallable<GetTermsOfServiceRequest,TermsOfService> getTermsOfServiceCallable()

Retrieves the TermsOfService associated with the provided version.

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 (TermsOfServiceServiceClient termsOfServiceServiceClient =
     TermsOfServiceServiceClient.create()) {
   GetTermsOfServiceRequest request =
       GetTermsOfServiceRequest.newBuilder()
           .setName(TermsOfServiceName.of("[VERSION]").toString())
           .build();
   ApiFuture<TermsOfService> future =
       termsOfServiceServiceClient.getTermsOfServiceCallable().futureCall(request);
   // Do something.
   TermsOfService response = future.get();
 }
Returns
Type Description
UnaryCallable<GetTermsOfServiceRequest,TermsOfService>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

retrieveLatestTermsOfService(RetrieveLatestTermsOfServiceRequest request)

public final TermsOfService retrieveLatestTermsOfService(RetrieveLatestTermsOfServiceRequest request)

Retrieves the latest version of the TermsOfService for a given kind and region_code.

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 (TermsOfServiceServiceClient termsOfServiceServiceClient =
     TermsOfServiceServiceClient.create()) {
   RetrieveLatestTermsOfServiceRequest request =
       RetrieveLatestTermsOfServiceRequest.newBuilder()
           .setRegionCode("regionCode-1991004415")
           .setKind(TermsOfServiceKind.forNumber(0))
           .build();
   TermsOfService response = termsOfServiceServiceClient.retrieveLatestTermsOfService(request);
 }
Parameter
Name Description
request RetrieveLatestTermsOfServiceRequest

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

retrieveLatestTermsOfServiceCallable()

public final UnaryCallable<RetrieveLatestTermsOfServiceRequest,TermsOfService> retrieveLatestTermsOfServiceCallable()

Retrieves the latest version of the TermsOfService for a given kind and region_code.

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 (TermsOfServiceServiceClient termsOfServiceServiceClient =
     TermsOfServiceServiceClient.create()) {
   RetrieveLatestTermsOfServiceRequest request =
       RetrieveLatestTermsOfServiceRequest.newBuilder()
           .setRegionCode("regionCode-1991004415")
           .setKind(TermsOfServiceKind.forNumber(0))
           .build();
   ApiFuture<TermsOfService> future =
       termsOfServiceServiceClient.retrieveLatestTermsOfServiceCallable().futureCall(request);
   // Do something.
   TermsOfService response = future.get();
 }
Returns
Type Description
UnaryCallable<RetrieveLatestTermsOfServiceRequest,TermsOfService>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()