public class InstancesSettings extends ClientSettings<InstancesSettings>Settings class to configure an instance of InstancesClient.
The default instance has everything set to sensible defaults:
- The default service address (appengine.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 getInstance to 30 seconds:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
InstancesSettings.Builder instancesSettingsBuilder = InstancesSettings.newBuilder();
instancesSettingsBuilder
.getInstanceSettings()
.setRetrySettings(
instancesSettingsBuilder
.getInstanceSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
InstancesSettings instancesSettings = instancesSettingsBuilder.build();
Static Methods
create(InstancesStubSettings stub)
public static final InstancesSettings create(InstancesStubSettings stub)| Name | Description |
| stub | InstancesStubSettings |
| Type | Description |
| InstancesSettings |
| Type | Description |
| IOException |
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Type | Description |
| Builder |
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Type | Description |
| Builder |
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Type | Description |
| Builder |
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service.
| Type | Description |
| Builder |
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Type | Description |
| TransportChannelProvider |
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Type | Description |
| String |
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Type | Description |
| List<String> |
newBuilder()
public static InstancesSettings.Builder newBuilder()Returns a new builder for this class.
| Type | Description |
| InstancesSettings.Builder |
newBuilder(ClientContext clientContext)
public static InstancesSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Name | Description |
| clientContext | ClientContext |
| Type | Description |
| InstancesSettings.Builder |
Constructors
InstancesSettings(InstancesSettings.Builder settingsBuilder)
protected InstancesSettings(InstancesSettings.Builder settingsBuilder)| Name | Description |
| settingsBuilder | InstancesSettings.Builder |
Methods
debugInstanceOperationSettings()
public OperationCallSettings<DebugInstanceRequest,Instance,OperationMetadataV1> debugInstanceOperationSettings()Returns the object with the settings used for calls to debugInstance.
| Type | Description |
| OperationCallSettings<DebugInstanceRequest,Instance,OperationMetadataV1> |
debugInstanceSettings()
public UnaryCallSettings<DebugInstanceRequest,Operation> debugInstanceSettings()Returns the object with the settings used for calls to debugInstance.
| Type | Description |
| UnaryCallSettings<DebugInstanceRequest,Operation> |
deleteInstanceOperationSettings()
public OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadataV1> deleteInstanceOperationSettings()Returns the object with the settings used for calls to deleteInstance.
| Type | Description |
| OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadataV1> |
deleteInstanceSettings()
public UnaryCallSettings<DeleteInstanceRequest,Operation> deleteInstanceSettings()Returns the object with the settings used for calls to deleteInstance.
| Type | Description |
| UnaryCallSettings<DeleteInstanceRequest,Operation> |
getInstanceSettings()
public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()Returns the object with the settings used for calls to getInstance.
| Type | Description |
| UnaryCallSettings<GetInstanceRequest,Instance> |
listInstancesSettings()
public PagedCallSettings<ListInstancesRequest,ListInstancesResponse,InstancesClient.ListInstancesPagedResponse> listInstancesSettings()Returns the object with the settings used for calls to listInstances.
| Type | Description |
| PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse> |
toBuilder()
public InstancesSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Type | Description |
| InstancesSettings.Builder |