Package com.google.cloud.notebooks.v2

Class NotebookServiceSettings

  • @Generated("by gapic-generator-java")
public class NotebookServiceSettings
extends com.google.api.gax.rpc.ClientSettings<NotebookServiceSettings>
    Settings class to configure an instance of NotebookServiceClient.

    The default instance has everything set to sensible defaults:

    • The default service address (notebooks.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
 NotebookServiceSettings.Builder notebookServiceSettingsBuilder =
     NotebookServiceSettings.newBuilder();
 notebookServiceSettingsBuilder
     .getInstanceSettings()
     .setRetrySettings(
         notebookServiceSettingsBuilder
             .getInstanceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 NotebookServiceSettings notebookServiceSettings = notebookServiceSettingsBuilder.build();

    • Method Detail

      • 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,​OperationMetadata> 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,​OperationMetadata> updateInstanceOperationSettings()
        Returns the object with the settings used for calls to updateInstance.

      • deleteInstanceSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DeleteInstanceRequest,​com.google.longrunning.Operation> deleteInstanceSettings()
        Returns the object with the settings used for calls to deleteInstance.

      • deleteInstanceOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<DeleteInstanceRequest,​com.google.protobuf.Empty,​OperationMetadata> deleteInstanceOperationSettings()
        Returns the object with the settings used for calls to deleteInstance.

      • startInstanceSettings

        public com.google.api.gax.rpc.UnaryCallSettings<StartInstanceRequest,​com.google.longrunning.Operation> startInstanceSettings()
        Returns the object with the settings used for calls to startInstance.

      • startInstanceOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<StartInstanceRequest,​Instance,​OperationMetadata> startInstanceOperationSettings()
        Returns the object with the settings used for calls to startInstance.

      • stopInstanceSettings

        public com.google.api.gax.rpc.UnaryCallSettings<StopInstanceRequest,​com.google.longrunning.Operation> stopInstanceSettings()
        Returns the object with the settings used for calls to stopInstance.

      • stopInstanceOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<StopInstanceRequest,​Instance,​OperationMetadata> stopInstanceOperationSettings()
        Returns the object with the settings used for calls to stopInstance.

      • resetInstanceSettings

        public com.google.api.gax.rpc.UnaryCallSettings<ResetInstanceRequest,​com.google.longrunning.Operation> resetInstanceSettings()
        Returns the object with the settings used for calls to resetInstance.

      • resetInstanceOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<ResetInstanceRequest,​Instance,​OperationMetadata> resetInstanceOperationSettings()
        Returns the object with the settings used for calls to resetInstance.

      • upgradeInstanceSettings

        public com.google.api.gax.rpc.UnaryCallSettings<UpgradeInstanceRequest,​com.google.longrunning.Operation> upgradeInstanceSettings()
        Returns the object with the settings used for calls to upgradeInstance.

      • upgradeInstanceOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<UpgradeInstanceRequest,​Instance,​OperationMetadata> upgradeInstanceOperationSettings()
        Returns the object with the settings used for calls to upgradeInstance.

      • rollbackInstanceSettings

        public com.google.api.gax.rpc.UnaryCallSettings<RollbackInstanceRequest,​com.google.longrunning.Operation> rollbackInstanceSettings()
        Returns the object with the settings used for calls to rollbackInstance.

      • rollbackInstanceOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<RollbackInstanceRequest,​Instance,​OperationMetadata> rollbackInstanceOperationSettings()
        Returns the object with the settings used for calls to rollbackInstance.

      • diagnoseInstanceSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DiagnoseInstanceRequest,​com.google.longrunning.Operation> diagnoseInstanceSettings()
        Returns the object with the settings used for calls to diagnoseInstance.

      • diagnoseInstanceOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<DiagnoseInstanceRequest,​Instance,​OperationMetadata> diagnoseInstanceOperationSettings()
        Returns the object with the settings used for calls to diagnoseInstance.

      • listLocationsSettings

        public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,​com.google.cloud.location.ListLocationsResponse,​NotebookServiceClient.ListLocationsPagedResponse> listLocationsSettings()
        Returns the object with the settings used for calls to listLocations.

      • getLocationSettings

        public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,​com.google.cloud.location.Location> getLocationSettings()
        Returns the object with the settings used for calls to getLocation.

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

      • 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 NotebookServiceSettings.Builder newBuilder​(com.google.api.gax.rpc.ClientContext clientContext)
        Returns a new builder for this class.