Class TargetInstancesSettings (1.11.0) 

public class TargetInstancesSettings extends ClientSettings<TargetInstancesSettings>

Settings class to configure an instance of TargetInstancesClient.

The default instance has everything set to sensible defaults:

  • The default service address (compute.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of get to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 TargetInstancesSettings.Builder targetInstancesSettingsBuilder =
     TargetInstancesSettings.newBuilder();
 targetInstancesSettingsBuilder
     .getSettings()
     .setRetrySettings(
         targetInstancesSettingsBuilder
             .getSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TargetInstancesSettings targetInstancesSettings = targetInstancesSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > TargetInstancesSettings

Static Methods

create(TargetInstancesStubSettings stub)

public static final TargetInstancesSettings create(TargetInstancesStubSettings stub)
Parameter
NameDescription
stubTargetInstancesStubSettings
Returns
TypeDescription
TargetInstancesSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static TargetInstancesSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
TargetInstancesSettings.Builder

newBuilder(ClientContext clientContext)

public static TargetInstancesSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
TargetInstancesSettings.Builder

Constructors

TargetInstancesSettings(TargetInstancesSettings.Builder settingsBuilder)

protected TargetInstancesSettings(TargetInstancesSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderTargetInstancesSettings.Builder

Methods

aggregatedListSettings()

public PagedCallSettings<AggregatedListTargetInstancesRequest,TargetInstanceAggregatedList,TargetInstancesClient.AggregatedListPagedResponse> aggregatedListSettings()

Returns the object with the settings used for calls to aggregatedList.

Returns
TypeDescription
PagedCallSettings<AggregatedListTargetInstancesRequest,TargetInstanceAggregatedList,AggregatedListPagedResponse>

deleteOperationSettings()

public OperationCallSettings<DeleteTargetInstanceRequest,Operation,Operation> deleteOperationSettings()

Returns the object with the settings used for calls to delete.

Returns
TypeDescription
OperationCallSettings<DeleteTargetInstanceRequest,Operation,Operation>

deleteSettings()

public UnaryCallSettings<DeleteTargetInstanceRequest,Operation> deleteSettings()

Returns the object with the settings used for calls to delete.

Returns
TypeDescription
UnaryCallSettings<DeleteTargetInstanceRequest,Operation>

getSettings()

public UnaryCallSettings<GetTargetInstanceRequest,TargetInstance> getSettings()

Returns the object with the settings used for calls to get.

Returns
TypeDescription
UnaryCallSettings<GetTargetInstanceRequest,TargetInstance>

insertOperationSettings()

public OperationCallSettings<InsertTargetInstanceRequest,Operation,Operation> insertOperationSettings()

Returns the object with the settings used for calls to insert.

Returns
TypeDescription
OperationCallSettings<InsertTargetInstanceRequest,Operation,Operation>

insertSettings()

public UnaryCallSettings<InsertTargetInstanceRequest,Operation> insertSettings()

Returns the object with the settings used for calls to insert.

Returns
TypeDescription
UnaryCallSettings<InsertTargetInstanceRequest,Operation>

listSettings()

public PagedCallSettings<ListTargetInstancesRequest,TargetInstanceList,TargetInstancesClient.ListPagedResponse> listSettings()

Returns the object with the settings used for calls to list.

Returns
TypeDescription
PagedCallSettings<ListTargetInstancesRequest,TargetInstanceList,ListPagedResponse>

toBuilder()

public TargetInstancesSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
TypeDescription
TargetInstancesSettings.Builder
Overrides