Class InstanceSettingsServiceClient (1.63.0)

GitHub RepositoryProduct Reference

Service Description: The InstanceSettings 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 (InstanceSettingsServiceClient instanceSettingsServiceClient =
     InstanceSettingsServiceClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   InstanceSettings response = instanceSettingsServiceClient.get(project, zone);
 }

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

Get

Get Instance settings.

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

  • get(GetInstanceSettingRequest request)

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

  • get(String project, String zone)

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

  • getCallable()

Patch

Patch Instance settings

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

  • patchAsync(PatchInstanceSettingRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • patchAsync(String project, String zone, InstanceSettings instanceSettingsResource)

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

  • patchOperationCallable()

  • patchCallable()

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 InstanceSettingsServiceSettings 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
 InstanceSettingsServiceSettings instanceSettingsServiceSettings =
     InstanceSettingsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InstanceSettingsServiceClient instanceSettingsServiceClient =
     InstanceSettingsServiceClient.create(instanceSettingsServiceSettings);

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
 InstanceSettingsServiceSettings instanceSettingsServiceSettings =
     InstanceSettingsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 InstanceSettingsServiceClient instanceSettingsServiceClient =
     InstanceSettingsServiceClient.create(instanceSettingsServiceSettings);

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

Inheritance

java.lang.Object > InstanceSettingsServiceClient

Static Methods

create()

public static final InstanceSettingsServiceClient create()

Constructs an instance of InstanceSettingsServiceClient with default settings.

Returns
Type Description
InstanceSettingsServiceClient
Exceptions
Type Description
IOException

create(InstanceSettingsServiceSettings settings)

public static final InstanceSettingsServiceClient create(InstanceSettingsServiceSettings settings)

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

create(InstanceSettingsServiceStub stub)

public static final InstanceSettingsServiceClient create(InstanceSettingsServiceStub stub)

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

Parameter
Name Description
stub InstanceSettingsServiceStub
Returns
Type Description
InstanceSettingsServiceClient

Constructors

InstanceSettingsServiceClient(InstanceSettingsServiceSettings settings)

protected InstanceSettingsServiceClient(InstanceSettingsServiceSettings settings)

Constructs an instance of InstanceSettingsServiceClient, 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 InstanceSettingsServiceSettings

InstanceSettingsServiceClient(InstanceSettingsServiceStub stub)

protected InstanceSettingsServiceClient(InstanceSettingsServiceStub stub)
Parameter
Name Description
stub InstanceSettingsServiceStub

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

get(GetInstanceSettingRequest request)

public final InstanceSettings get(GetInstanceSettingRequest request)

Get Instance settings.

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 (InstanceSettingsServiceClient instanceSettingsServiceClient =
     InstanceSettingsServiceClient.create()) {
   GetInstanceSettingRequest request =
       GetInstanceSettingRequest.newBuilder()
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   InstanceSettings response = instanceSettingsServiceClient.get(request);
 }
Parameter
Name Description
request GetInstanceSettingRequest

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

get(String project, String zone)

public final InstanceSettings get(String project, String zone)

Get Instance settings.

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 (InstanceSettingsServiceClient instanceSettingsServiceClient =
     InstanceSettingsServiceClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   InstanceSettings response = instanceSettingsServiceClient.get(project, zone);
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

Name of the zone for this request.
Returns
Type Description
InstanceSettings

getCallable()

public final UnaryCallable<GetInstanceSettingRequest,InstanceSettings> getCallable()

Get Instance settings.

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 (InstanceSettingsServiceClient instanceSettingsServiceClient =
     InstanceSettingsServiceClient.create()) {
   GetInstanceSettingRequest request =
       GetInstanceSettingRequest.newBuilder()
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture<InstanceSettings> future =
       instanceSettingsServiceClient.getCallable().futureCall(request);
   // Do something.
   InstanceSettings response = future.get();
 }
Returns
Type Description
UnaryCallable<GetInstanceSettingRequest,InstanceSettings>

getSettings()

public final InstanceSettingsServiceSettings getSettings()
Returns
Type Description
InstanceSettingsServiceSettings

getStub()

public InstanceSettingsServiceStub getStub()
Returns
Type Description
InstanceSettingsServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

patchAsync(PatchInstanceSettingRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchInstanceSettingRequest request)

Patch Instance settings

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 (InstanceSettingsServiceClient instanceSettingsServiceClient =
     InstanceSettingsServiceClient.create()) {
   PatchInstanceSettingRequest request =
       PatchInstanceSettingRequest.newBuilder()
           .setInstanceSettingsResource(InstanceSettings.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUpdateMask("updateMask-296147115")
           .setZone("zone3744684")
           .build();
   Operation response = instanceSettingsServiceClient.patchAsync(request).get();
 }
Parameter
Name Description
request PatchInstanceSettingRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

patchAsync(String project, String zone, InstanceSettings instanceSettingsResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String zone, InstanceSettings instanceSettingsResource)

Patch Instance settings

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 (InstanceSettingsServiceClient instanceSettingsServiceClient =
     InstanceSettingsServiceClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   InstanceSettings instanceSettingsResource = InstanceSettings.newBuilder().build();
   Operation response =
       instanceSettingsServiceClient.patchAsync(project, zone, instanceSettingsResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

The zone scoping this request. It should conform to RFC1035.
instanceSettingsResource InstanceSettings

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchInstanceSettingRequest,Operation> patchCallable()

Patch Instance settings

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 (InstanceSettingsServiceClient instanceSettingsServiceClient =
     InstanceSettingsServiceClient.create()) {
   PatchInstanceSettingRequest request =
       PatchInstanceSettingRequest.newBuilder()
           .setInstanceSettingsResource(InstanceSettings.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUpdateMask("updateMask-296147115")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future =
       instanceSettingsServiceClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<PatchInstanceSettingRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchInstanceSettingRequest,Operation,Operation> patchOperationCallable()

Patch Instance settings

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 (InstanceSettingsServiceClient instanceSettingsServiceClient =
     InstanceSettingsServiceClient.create()) {
   PatchInstanceSettingRequest request =
       PatchInstanceSettingRequest.newBuilder()
           .setInstanceSettingsResource(InstanceSettings.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUpdateMask("updateMask-296147115")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       instanceSettingsServiceClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<PatchInstanceSettingRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()