Class TermsOfServiceAgreementStateServiceClient (0.4.0)

Service Description: Service to support TermsOfServiceAgreementState 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 (TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient =
     TermsOfServiceAgreementStateServiceClient.create()) {
   TermsOfServiceAgreementStateName name =
       TermsOfServiceAgreementStateName.of("[ACCOUNT]", "[IDENTIFIER]");
   TermsOfServiceAgreementState response =
       termsOfServiceAgreementStateServiceClient.getTermsOfServiceAgreementState(name);
 }

Note: close() needs to be called on the TermsOfServiceAgreementStateServiceClient 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
GetTermsOfServiceAgreementState	Returns the state of a terms of service agreement.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getTermsOfServiceAgreementState(GetTermsOfServiceAgreementStateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getTermsOfServiceAgreementState(TermsOfServiceAgreementStateName name) getTermsOfServiceAgreementState(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. getTermsOfServiceAgreementStateCallable()
RetrieveForApplicationTermsOfServiceAgreementState	Retrieves the state of the agreement for the application terms of service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. retrieveForApplicationTermsOfServiceAgreementState(RetrieveForApplicationTermsOfServiceAgreementStateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. retrieveForApplicationTermsOfServiceAgreementState(AccountName parent) retrieveForApplicationTermsOfServiceAgreementState(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. retrieveForApplicationTermsOfServiceAgreementStateCallable()

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 TermsOfServiceAgreementStateServiceSettings 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
 TermsOfServiceAgreementStateServiceSettings termsOfServiceAgreementStateServiceSettings =
     TermsOfServiceAgreementStateServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient =
     TermsOfServiceAgreementStateServiceClient.create(
         termsOfServiceAgreementStateServiceSettings);

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
 TermsOfServiceAgreementStateServiceSettings termsOfServiceAgreementStateServiceSettings =
     TermsOfServiceAgreementStateServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient =
     TermsOfServiceAgreementStateServiceClient.create(
         termsOfServiceAgreementStateServiceSettings);

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
 TermsOfServiceAgreementStateServiceSettings termsOfServiceAgreementStateServiceSettings =
     TermsOfServiceAgreementStateServiceSettings.newHttpJsonBuilder().build();
 TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient =
     TermsOfServiceAgreementStateServiceClient.create(
         termsOfServiceAgreementStateServiceSettings);

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

Inheritance

java.lang.Object > TermsOfServiceAgreementStateServiceClient

Static Methods

create()

public static final TermsOfServiceAgreementStateServiceClient create()

Constructs an instance of TermsOfServiceAgreementStateServiceClient with default settings.

Returns
Type	Description
`TermsOfServiceAgreementStateServiceClient`

Exceptions
Type	Description
`IOException`

create(TermsOfServiceAgreementStateServiceSettings settings)

public static final TermsOfServiceAgreementStateServiceClient create(TermsOfServiceAgreementStateServiceSettings settings)

Constructs an instance of TermsOfServiceAgreementStateServiceClient, 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`	`TermsOfServiceAgreementStateServiceSettings`

Returns
Type	Description
`TermsOfServiceAgreementStateServiceClient`

Exceptions
Type	Description
`IOException`

create(TermsOfServiceAgreementStateServiceStub stub)

public static final TermsOfServiceAgreementStateServiceClient create(TermsOfServiceAgreementStateServiceStub stub)

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

Parameter
Name	Description
`stub`	`TermsOfServiceAgreementStateServiceStub`

Returns
Type	Description
`TermsOfServiceAgreementStateServiceClient`

Constructors

TermsOfServiceAgreementStateServiceClient(TermsOfServiceAgreementStateServiceSettings settings)

protected TermsOfServiceAgreementStateServiceClient(TermsOfServiceAgreementStateServiceSettings settings)

Constructs an instance of TermsOfServiceAgreementStateServiceClient, 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`	`TermsOfServiceAgreementStateServiceSettings`

TermsOfServiceAgreementStateServiceClient(TermsOfServiceAgreementStateServiceStub stub)

protected TermsOfServiceAgreementStateServiceClient(TermsOfServiceAgreementStateServiceStub stub)

Parameter
Name	Description
`stub`	`TermsOfServiceAgreementStateServiceStub`

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

getSettings()

public final TermsOfServiceAgreementStateServiceSettings getSettings()

Returns
Type	Description
`TermsOfServiceAgreementStateServiceSettings`

getStub()

public TermsOfServiceAgreementStateServiceStub getStub()

Returns
Type	Description
`TermsOfServiceAgreementStateServiceStub`

getTermsOfServiceAgreementState(GetTermsOfServiceAgreementStateRequest request)

public final TermsOfServiceAgreementState getTermsOfServiceAgreementState(GetTermsOfServiceAgreementStateRequest request)

Returns the state of a terms of service agreement.

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 (TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient =
     TermsOfServiceAgreementStateServiceClient.create()) {
   GetTermsOfServiceAgreementStateRequest request =
       GetTermsOfServiceAgreementStateRequest.newBuilder()
           .setName(TermsOfServiceAgreementStateName.of("[ACCOUNT]", "[IDENTIFIER]").toString())
           .build();
   TermsOfServiceAgreementState response =
       termsOfServiceAgreementStateServiceClient.getTermsOfServiceAgreementState(request);
 }

Parameter
Name	Description
`request`	`GetTermsOfServiceAgreementStateRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`TermsOfServiceAgreementState`

getTermsOfServiceAgreementState(TermsOfServiceAgreementStateName name)

public final TermsOfServiceAgreementState getTermsOfServiceAgreementState(TermsOfServiceAgreementStateName name)

Returns the state of a terms of service agreement.

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 (TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient =
     TermsOfServiceAgreementStateServiceClient.create()) {
   TermsOfServiceAgreementStateName name =
       TermsOfServiceAgreementStateName.of("[ACCOUNT]", "[IDENTIFIER]");
   TermsOfServiceAgreementState response =
       termsOfServiceAgreementStateServiceClient.getTermsOfServiceAgreementState(name);
 }

Parameter
Name	Description
`name`	`TermsOfServiceAgreementStateName` Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}`

Returns
Type	Description
`TermsOfServiceAgreementState`

getTermsOfServiceAgreementState(String name)

public final TermsOfServiceAgreementState getTermsOfServiceAgreementState(String name)

Returns the state of a terms of service agreement.

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 (TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient =
     TermsOfServiceAgreementStateServiceClient.create()) {
   String name = TermsOfServiceAgreementStateName.of("[ACCOUNT]", "[IDENTIFIER]").toString();
   TermsOfServiceAgreementState response =
       termsOfServiceAgreementStateServiceClient.getTermsOfServiceAgreementState(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}`

Returns
Type	Description
`TermsOfServiceAgreementState`

getTermsOfServiceAgreementStateCallable()

public final UnaryCallable<GetTermsOfServiceAgreementStateRequest,TermsOfServiceAgreementState> getTermsOfServiceAgreementStateCallable()

Returns the state of a terms of service agreement.

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 (TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient =
     TermsOfServiceAgreementStateServiceClient.create()) {
   GetTermsOfServiceAgreementStateRequest request =
       GetTermsOfServiceAgreementStateRequest.newBuilder()
           .setName(TermsOfServiceAgreementStateName.of("[ACCOUNT]", "[IDENTIFIER]").toString())
           .build();
   ApiFuture<TermsOfServiceAgreementState> future =
       termsOfServiceAgreementStateServiceClient
           .getTermsOfServiceAgreementStateCallable()
           .futureCall(request);
   // Do something.
   TermsOfServiceAgreementState response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetTermsOfServiceAgreementStateRequest,TermsOfServiceAgreementState>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

retrieveForApplicationTermsOfServiceAgreementState(AccountName parent)

public final TermsOfServiceAgreementState retrieveForApplicationTermsOfServiceAgreementState(AccountName parent)

Retrieves the state of the agreement for the application terms of service.

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 (TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient =
     TermsOfServiceAgreementStateServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   TermsOfServiceAgreementState response =
       termsOfServiceAgreementStateServiceClient
           .retrieveForApplicationTermsOfServiceAgreementState(parent);
 }

Parameter
Name	Description
`parent`	`AccountName` Required. The account for which to get a TermsOfServiceAgreementState Format: `accounts/{account}`

Returns
Type	Description
`TermsOfServiceAgreementState`

retrieveForApplicationTermsOfServiceAgreementState(RetrieveForApplicationTermsOfServiceAgreementStateRequest request)

public final TermsOfServiceAgreementState retrieveForApplicationTermsOfServiceAgreementState(RetrieveForApplicationTermsOfServiceAgreementStateRequest request)

Retrieves the state of the agreement for the application terms of service.

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 (TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient =
     TermsOfServiceAgreementStateServiceClient.create()) {
   RetrieveForApplicationTermsOfServiceAgreementStateRequest request =
       RetrieveForApplicationTermsOfServiceAgreementStateRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .build();
   TermsOfServiceAgreementState response =
       termsOfServiceAgreementStateServiceClient
           .retrieveForApplicationTermsOfServiceAgreementState(request);
 }

Parameter
Name	Description
`request`	`RetrieveForApplicationTermsOfServiceAgreementStateRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`TermsOfServiceAgreementState`

retrieveForApplicationTermsOfServiceAgreementState(String parent)

public final TermsOfServiceAgreementState retrieveForApplicationTermsOfServiceAgreementState(String parent)

Retrieves the state of the agreement for the application terms of service.

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 (TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient =
     TermsOfServiceAgreementStateServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   TermsOfServiceAgreementState response =
       termsOfServiceAgreementStateServiceClient
           .retrieveForApplicationTermsOfServiceAgreementState(parent);
 }

Parameter
Name	Description
`parent`	`String` Required. The account for which to get a TermsOfServiceAgreementState Format: `accounts/{account}`

Returns
Type	Description
`TermsOfServiceAgreementState`

retrieveForApplicationTermsOfServiceAgreementStateCallable()

public final UnaryCallable<RetrieveForApplicationTermsOfServiceAgreementStateRequest,TermsOfServiceAgreementState> retrieveForApplicationTermsOfServiceAgreementStateCallable()

Retrieves the state of the agreement for the application terms of service.

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 (TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient =
     TermsOfServiceAgreementStateServiceClient.create()) {
   RetrieveForApplicationTermsOfServiceAgreementStateRequest request =
       RetrieveForApplicationTermsOfServiceAgreementStateRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .build();
   ApiFuture<TermsOfServiceAgreementState> future =
       termsOfServiceAgreementStateServiceClient
           .retrieveForApplicationTermsOfServiceAgreementStateCallable()
           .futureCall(request);
   // Do something.
   TermsOfServiceAgreementState response = future.get();
 }

Returns
Type	Description
`UnaryCallable<RetrieveForApplicationTermsOfServiceAgreementStateRequest,TermsOfServiceAgreementState>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()