Class InstanceServiceClient (0.2.0)

Service Description: InstanceService provides the entry interface for the Chronicle 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 (InstanceServiceClient instanceServiceClient = InstanceServiceClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = instanceServiceClient.getInstance(name);
 }

Note: close() needs to be called on the InstanceServiceClient 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
GetInstance	Gets a Instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getInstance(GetInstanceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getInstance(InstanceName name) getInstance(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. getInstanceCallable()

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 InstanceServiceSettings 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
 InstanceServiceSettings instanceServiceSettings =
     InstanceServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InstanceServiceClient instanceServiceClient =
     InstanceServiceClient.create(instanceServiceSettings);

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
 InstanceServiceSettings instanceServiceSettings =
     InstanceServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 InstanceServiceClient instanceServiceClient =
     InstanceServiceClient.create(instanceServiceSettings);

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
 InstanceServiceSettings instanceServiceSettings =
     InstanceServiceSettings.newHttpJsonBuilder().build();
 InstanceServiceClient instanceServiceClient =
     InstanceServiceClient.create(instanceServiceSettings);

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

Inheritance

java.lang.Object > InstanceServiceClient

Static Methods

create()

public static final InstanceServiceClient create()

Constructs an instance of InstanceServiceClient with default settings.

Returns
Type	Description
`InstanceServiceClient`

Exceptions
Type	Description
`IOException`

create(InstanceServiceSettings settings)

public static final InstanceServiceClient create(InstanceServiceSettings settings)

Constructs an instance of InstanceServiceClient, 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`	`InstanceServiceSettings`

Returns
Type	Description
`InstanceServiceClient`

Exceptions
Type	Description
`IOException`

create(InstanceServiceStub stub)

public static final InstanceServiceClient create(InstanceServiceStub stub)

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

Parameter
Name	Description
`stub`	`InstanceServiceStub`

Returns
Type	Description
`InstanceServiceClient`

Constructors

InstanceServiceClient(InstanceServiceSettings settings)

protected InstanceServiceClient(InstanceServiceSettings settings)

Constructs an instance of InstanceServiceClient, 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`	`InstanceServiceSettings`

InstanceServiceClient(InstanceServiceStub stub)

protected InstanceServiceClient(InstanceServiceStub stub)

Parameter
Name	Description
`stub`	`InstanceServiceStub`

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

getInstance(GetInstanceRequest request)

public final Instance getInstance(GetInstanceRequest request)

Gets a Instance.

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 (InstanceServiceClient instanceServiceClient = InstanceServiceClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   Instance response = instanceServiceClient.getInstance(request);
 }

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

Returns
Type	Description
`Instance`

getInstance(InstanceName name)

public final Instance getInstance(InstanceName name)

Gets a Instance.

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 (InstanceServiceClient instanceServiceClient = InstanceServiceClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = instanceServiceClient.getInstance(name);
 }

Parameter
Name	Description
`name`	`InstanceName` Required. The name of the instance to retrieve. Format: `projects/{project_id}/locations/{location}/instances/{instance}`

Returns
Type	Description
`Instance`

getInstance(String name)

public final Instance getInstance(String name)

Gets a Instance.

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 (InstanceServiceClient instanceServiceClient = InstanceServiceClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   Instance response = instanceServiceClient.getInstance(name);
 }

Parameter
Name	Description
`name`	`String` Required. The name of the instance to retrieve. Format: `projects/{project_id}/locations/{location}/instances/{instance}`

Returns
Type	Description
`Instance`

getInstanceCallable()

public final UnaryCallable<GetInstanceRequest,Instance> getInstanceCallable()

Gets a Instance.

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 (InstanceServiceClient instanceServiceClient = InstanceServiceClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   ApiFuture<Instance> future = instanceServiceClient.getInstanceCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetInstanceRequest,Instance>`

getSettings()

public final InstanceServiceSettings getSettings()

Returns
Type	Description
`InstanceServiceSettings`

getStub()

public InstanceServiceStub getStub()

Returns
Type	Description
`InstanceServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

Class InstanceServiceClient (0.2.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(InstanceServiceSettings settings)

create(InstanceServiceStub stub)

Constructors

InstanceServiceClient(InstanceServiceSettings settings)

InstanceServiceClient(InstanceServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

getInstance(GetInstanceRequest request)

getInstance(InstanceName name)

getInstance(String name)

getInstanceCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

shutdown()

shutdownNow()

Class InstanceServiceClient (0.2.0)