Package com.google.cloud.bigtable.admin.v2.stub

Class BigtableInstanceAdminStubSettings

java.lang.Object
com.google.api.gax.rpc.StubSettings<BigtableInstanceAdminStubSettings>
com.google.cloud.bigtable.admin.v2.stub.BigtableInstanceAdminStubSettings
@Generated("by gapic-generator-java") public class BigtableInstanceAdminStubSettings extends com.google.api.gax.rpc.StubSettings<BigtableInstanceAdminStubSettings>
Settings class to configure an instance of BigtableInstanceAdminStub.

The default instance has everything set to sensible defaults:

  • The default service address (bigtableadmin.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 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
 BigtableInstanceAdminStubSettings.Builder baseBigtableInstanceAdminSettingsBuilder =
     BigtableInstanceAdminStubSettings.newBuilder();
 baseBigtableInstanceAdminSettingsBuilder
     .getInstanceSettings()
     .setRetrySettings(
         baseBigtableInstanceAdminSettingsBuilder
             .getInstanceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 BigtableInstanceAdminStubSettings baseBigtableInstanceAdminSettings =
     baseBigtableInstanceAdminSettingsBuilder.build();

  • Constructor Details

  • Method Details

    • 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.

    • getInstanceSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()
      Returns the object with the settings used for calls to getInstance.

    • listInstancesSettings

      public com.google.api.gax.rpc.UnaryCallSettings<ListInstancesRequest,ListInstancesResponse> listInstancesSettings()
      Returns the object with the settings used for calls to listInstances.

    • updateInstanceSettings

      public com.google.api.gax.rpc.UnaryCallSettings<Instance,Instance> updateInstanceSettings()
      Returns the object with the settings used for calls to updateInstance.

    • partialUpdateInstanceSettings

      public com.google.api.gax.rpc.UnaryCallSettings<PartialUpdateInstanceRequest,com.google.longrunning.Operation> partialUpdateInstanceSettings()
      Returns the object with the settings used for calls to partialUpdateInstance.

    • partialUpdateInstanceOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<PartialUpdateInstanceRequest,Instance,UpdateInstanceMetadata> partialUpdateInstanceOperationSettings()
      Returns the object with the settings used for calls to partialUpdateInstance.

    • 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.

    • createClusterSettings

      public com.google.api.gax.rpc.UnaryCallSettings<CreateClusterRequest,com.google.longrunning.Operation> createClusterSettings()
      Returns the object with the settings used for calls to createCluster.

    • createClusterOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<CreateClusterRequest,Cluster,CreateClusterMetadata> createClusterOperationSettings()
      Returns the object with the settings used for calls to createCluster.

    • getClusterSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetClusterRequest,Cluster> getClusterSettings()
      Returns the object with the settings used for calls to getCluster.

    • listClustersSettings

      public com.google.api.gax.rpc.UnaryCallSettings<ListClustersRequest,ListClustersResponse> listClustersSettings()
      Returns the object with the settings used for calls to listClusters.

    • updateClusterSettings

      public com.google.api.gax.rpc.UnaryCallSettings<Cluster,com.google.longrunning.Operation> updateClusterSettings()
      Returns the object with the settings used for calls to updateCluster.

    • updateClusterOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<Cluster,Cluster,UpdateClusterMetadata> updateClusterOperationSettings()
      Returns the object with the settings used for calls to updateCluster.

    • partialUpdateClusterSettings

      public com.google.api.gax.rpc.UnaryCallSettings<PartialUpdateClusterRequest,com.google.longrunning.Operation> partialUpdateClusterSettings()
      Returns the object with the settings used for calls to partialUpdateCluster.

    • partialUpdateClusterOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<PartialUpdateClusterRequest,Cluster,PartialUpdateClusterMetadata> partialUpdateClusterOperationSettings()
      Returns the object with the settings used for calls to partialUpdateCluster.

    • deleteClusterSettings

      public com.google.api.gax.rpc.UnaryCallSettings<DeleteClusterRequest,com.google.protobuf.Empty> deleteClusterSettings()
      Returns the object with the settings used for calls to deleteCluster.

    • createAppProfileSettings

      public com.google.api.gax.rpc.UnaryCallSettings<CreateAppProfileRequest,AppProfile> createAppProfileSettings()
      Returns the object with the settings used for calls to createAppProfile.

    • getAppProfileSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetAppProfileRequest,AppProfile> getAppProfileSettings()
      Returns the object with the settings used for calls to getAppProfile.

    • listAppProfilesSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListAppProfilesRequest,ListAppProfilesResponse,com.google.cloud.bigtable.admin.v2.BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse> listAppProfilesSettings()
      Returns the object with the settings used for calls to listAppProfiles.

    • updateAppProfileSettings

      public com.google.api.gax.rpc.UnaryCallSettings<UpdateAppProfileRequest,com.google.longrunning.Operation> updateAppProfileSettings()
      Returns the object with the settings used for calls to updateAppProfile.

    • updateAppProfileOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<UpdateAppProfileRequest,AppProfile,UpdateAppProfileMetadata> updateAppProfileOperationSettings()
      Returns the object with the settings used for calls to updateAppProfile.

    • deleteAppProfileSettings

      public com.google.api.gax.rpc.UnaryCallSettings<DeleteAppProfileRequest,com.google.protobuf.Empty> deleteAppProfileSettings()
      Returns the object with the settings used for calls to deleteAppProfile.

    • 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.

    • 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.

    • 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.

    • listHotTabletsSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListHotTabletsRequest,ListHotTabletsResponse,com.google.cloud.bigtable.admin.v2.BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse> listHotTabletsSettings()
      Returns the object with the settings used for calls to listHotTablets.

    • createStub

      public com.google.cloud.bigtable.admin.v2.stub.BigtableInstanceAdminStub createStub() throws IOException
      Throws:
      IOException

    • getEndpoint

      public String getEndpoint()
      Returns the endpoint set by the user or the the service's default endpoint.
      Overrides:
      getEndpoint in class com.google.api.gax.rpc.StubSettings<BigtableInstanceAdminStubSettings>

    • getServiceName

      public String getServiceName()
      Returns the default service name.
      Overrides:
      getServiceName in class com.google.api.gax.rpc.StubSettings<BigtableInstanceAdminStubSettings>

    • 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.

    • getDefaultMtlsEndpoint

      public static String getDefaultMtlsEndpoint()
      Returns the default mTLS 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 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 BigtableInstanceAdminStubSettings.Builder newBuilder()
      Returns a new builder for this class.

    • newBuilder

      public static BigtableInstanceAdminStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
      Returns a new builder for this class.

    • toBuilder

      public BigtableInstanceAdminStubSettings.Builder toBuilder()
      Returns a builder containing all the values of this settings class.
      Specified by:
      toBuilder in class com.google.api.gax.rpc.StubSettings<BigtableInstanceAdminStubSettings>