Class InstanceAdminSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<InstanceAdminSettings>
-
- com.google.cloud.spanner.admin.instance.v1.InstanceAdminSettings
-
@Generated("by gapic-generator-java") public class InstanceAdminSettings extends com.google.api.gax.rpc.ClientSettings<InstanceAdminSettings>
Settings class to configure an instance ofInstanceAdminClient
.The default instance has everything set to sensible defaults:
- The default service address (spanner.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 getInstanceConfig to 30 seconds:
// 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 InstanceAdminSettings.Builder instanceAdminSettingsBuilder = InstanceAdminSettings.newBuilder(); instanceAdminSettingsBuilder .getInstanceConfigSettings() .setRetrySettings( instanceAdminSettingsBuilder .getInstanceConfigSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); InstanceAdminSettings instanceAdminSettings = instanceAdminSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
InstanceAdminSettings.Builder
Builder for InstanceAdminSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
InstanceAdminSettings(InstanceAdminSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static InstanceAdminSettings
create(InstanceAdminStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateInstanceConfigRequest,InstanceConfig,CreateInstanceConfigMetadata>
createInstanceConfigOperationSettings()
Returns the object with the settings used for calls to createInstanceConfig.com.google.api.gax.rpc.UnaryCallSettings<CreateInstanceConfigRequest,com.google.longrunning.Operation>
createInstanceConfigSettings()
Returns the object with the settings used for calls to createInstanceConfig.com.google.api.gax.rpc.OperationCallSettings<CreateInstanceRequest,Instance,CreateInstanceMetadata>
createInstanceOperationSettings()
Returns the object with the settings used for calls to createInstance.com.google.api.gax.rpc.UnaryCallSettings<CreateInstanceRequest,com.google.longrunning.Operation>
createInstanceSettings()
Returns the object with the settings used for calls to createInstance.static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder
defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.static com.google.api.gax.core.InstantiatingExecutorProvider.Builder
defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder
defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProvider
defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteInstanceConfigRequest,com.google.protobuf.Empty>
deleteInstanceConfigSettings()
Returns the object with the settings used for calls to deleteInstanceConfig.com.google.api.gax.rpc.UnaryCallSettings<DeleteInstanceRequest,com.google.protobuf.Empty>
deleteInstanceSettings()
Returns the object with the settings used for calls to deleteInstance.static String
getDefaultEndpoint()
Returns the default service endpoint.static List<String>
getDefaultServiceScopes()
Returns the default service scopes.com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>
getIamPolicySettings()
Returns the object with the settings used for calls to getIamPolicy.com.google.api.gax.rpc.UnaryCallSettings<GetInstanceConfigRequest,InstanceConfig>
getInstanceConfigSettings()
Returns the object with the settings used for calls to getInstanceConfig.com.google.api.gax.rpc.UnaryCallSettings<GetInstanceRequest,Instance>
getInstanceSettings()
Returns the object with the settings used for calls to getInstance.com.google.api.gax.rpc.PagedCallSettings<ListInstanceConfigOperationsRequest,ListInstanceConfigOperationsResponse,InstanceAdminClient.ListInstanceConfigOperationsPagedResponse>
listInstanceConfigOperationsSettings()
Returns the object with the settings used for calls to listInstanceConfigOperations.com.google.api.gax.rpc.PagedCallSettings<ListInstanceConfigsRequest,ListInstanceConfigsResponse,InstanceAdminClient.ListInstanceConfigsPagedResponse>
listInstanceConfigsSettings()
Returns the object with the settings used for calls to listInstanceConfigs.com.google.api.gax.rpc.PagedCallSettings<ListInstancesRequest,ListInstancesResponse,InstanceAdminClient.ListInstancesPagedResponse>
listInstancesSettings()
Returns the object with the settings used for calls to listInstances.static InstanceAdminSettings.Builder
newBuilder()
Returns a new gRPC builder for this class.static InstanceAdminSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.static InstanceAdminSettings.Builder
newHttpJsonBuilder()
Returns a new REST builder for this class.com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>
setIamPolicySettings()
Returns the object with the settings used for calls to setIamPolicy.com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>
testIamPermissionsSettings()
Returns the object with the settings used for calls to testIamPermissions.InstanceAdminSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.OperationCallSettings<UpdateInstanceConfigRequest,InstanceConfig,UpdateInstanceConfigMetadata>
updateInstanceConfigOperationSettings()
Returns the object with the settings used for calls to updateInstanceConfig.com.google.api.gax.rpc.UnaryCallSettings<UpdateInstanceConfigRequest,com.google.longrunning.Operation>
updateInstanceConfigSettings()
Returns the object with the settings used for calls to updateInstanceConfig.com.google.api.gax.rpc.OperationCallSettings<UpdateInstanceRequest,Instance,UpdateInstanceMetadata>
updateInstanceOperationSettings()
Returns the object with the settings used for calls to updateInstance.com.google.api.gax.rpc.UnaryCallSettings<UpdateInstanceRequest,com.google.longrunning.Operation>
updateInstanceSettings()
Returns the object with the settings used for calls to updateInstance.-
Methods inherited from class com.google.api.gax.rpc.ClientSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString
-
-
-
-
Constructor Detail
-
InstanceAdminSettings
protected InstanceAdminSettings(InstanceAdminSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
listInstanceConfigsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListInstanceConfigsRequest,ListInstanceConfigsResponse,InstanceAdminClient.ListInstanceConfigsPagedResponse> listInstanceConfigsSettings()
Returns the object with the settings used for calls to listInstanceConfigs.
-
getInstanceConfigSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetInstanceConfigRequest,InstanceConfig> getInstanceConfigSettings()
Returns the object with the settings used for calls to getInstanceConfig.
-
createInstanceConfigSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateInstanceConfigRequest,com.google.longrunning.Operation> createInstanceConfigSettings()
Returns the object with the settings used for calls to createInstanceConfig.
-
createInstanceConfigOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<CreateInstanceConfigRequest,InstanceConfig,CreateInstanceConfigMetadata> createInstanceConfigOperationSettings()
Returns the object with the settings used for calls to createInstanceConfig.
-
updateInstanceConfigSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateInstanceConfigRequest,com.google.longrunning.Operation> updateInstanceConfigSettings()
Returns the object with the settings used for calls to updateInstanceConfig.
-
updateInstanceConfigOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<UpdateInstanceConfigRequest,InstanceConfig,UpdateInstanceConfigMetadata> updateInstanceConfigOperationSettings()
Returns the object with the settings used for calls to updateInstanceConfig.
-
deleteInstanceConfigSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteInstanceConfigRequest,com.google.protobuf.Empty> deleteInstanceConfigSettings()
Returns the object with the settings used for calls to deleteInstanceConfig.
-
listInstanceConfigOperationsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListInstanceConfigOperationsRequest,ListInstanceConfigOperationsResponse,InstanceAdminClient.ListInstanceConfigOperationsPagedResponse> listInstanceConfigOperationsSettings()
Returns the object with the settings used for calls to listInstanceConfigOperations.
-
listInstancesSettings
public com.google.api.gax.rpc.PagedCallSettings<ListInstancesRequest,ListInstancesResponse,InstanceAdminClient.ListInstancesPagedResponse> listInstancesSettings()
Returns the object with the settings used for calls to listInstances.
-
getInstanceSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()
Returns the object with the settings used for calls to getInstance.
-
createInstanceSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateInstanceRequest,com.google.longrunning.Operation> createInstanceSettings()
Returns the object with the settings used for calls to createInstance.
-
createInstanceOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<CreateInstanceRequest,Instance,CreateInstanceMetadata> createInstanceOperationSettings()
Returns the object with the settings used for calls to createInstance.
-
updateInstanceSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateInstanceRequest,com.google.longrunning.Operation> updateInstanceSettings()
Returns the object with the settings used for calls to updateInstance.
-
updateInstanceOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<UpdateInstanceRequest,Instance,UpdateInstanceMetadata> updateInstanceOperationSettings()
Returns the object with the settings used for calls to updateInstance.
-
deleteInstanceSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteInstanceRequest,com.google.protobuf.Empty> deleteInstanceSettings()
Returns the object with the settings used for calls to deleteInstance.
-
setIamPolicySettings
public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()
Returns the object with the settings used for calls to setIamPolicy.
-
getIamPolicySettings
public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()
Returns the object with the settings used for calls to getIamPolicy.
-
testIamPermissionsSettings
public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()
Returns the object with the settings used for calls to testIamPermissions.
-
create
public static final InstanceAdminSettings create(InstanceAdminStubSettings stub) throws IOException
- Throws:
IOException
-
defaultExecutorProviderBuilder
public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
-
getDefaultEndpoint
public static String getDefaultEndpoint()
Returns the default service endpoint.
-
getDefaultServiceScopes
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
-
defaultCredentialsProviderBuilder
public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
-
defaultGrpcTransportProviderBuilder
public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
-
defaultHttpJsonTransportProviderBuilder
@BetaApi public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
-
defaultTransportChannelProvider
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
-
defaultApiClientHeaderProviderBuilder
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static InstanceAdminSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
-
newHttpJsonBuilder
@BetaApi public static InstanceAdminSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
-
newBuilder
public static InstanceAdminSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public InstanceAdminSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.ClientSettings<InstanceAdminSettings>
-
-