Class NotebookServiceStubSettings (1.3.0)

public class NotebookServiceStubSettings extends StubSettings<NotebookServiceStubSettings>

Settings class to configure an instance of NotebookServiceStub.

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
 NotebookServiceStubSettings.Builder notebookServiceSettingsBuilder =
     NotebookServiceStubSettings.newBuilder();
 notebookServiceSettingsBuilder
     .getInstanceSettings()
     .setRetrySettings(
         notebookServiceSettingsBuilder.getInstanceSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 NotebookServiceStubSettings notebookServiceSettings = notebookServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > NotebookServiceStubSettings

Static Methods

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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static NotebookServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
NotebookServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static NotebookServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
NotebookServiceStubSettings.Builder

Constructors

NotebookServiceStubSettings(NotebookServiceStubSettings.Builder settingsBuilder)

protected NotebookServiceStubSettings(NotebookServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderNotebookServiceStubSettings.Builder

Methods

createEnvironmentOperationSettings()

public OperationCallSettings<CreateEnvironmentRequest,Environment,OperationMetadata> createEnvironmentOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateEnvironmentRequest,Environment,OperationMetadata>

createEnvironmentSettings()

public UnaryCallSettings<CreateEnvironmentRequest,Operation> createEnvironmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateEnvironmentRequest,Operation>

createExecutionOperationSettings()

public OperationCallSettings<CreateExecutionRequest,Execution,OperationMetadata> createExecutionOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateExecutionRequest,Execution,OperationMetadata>

createExecutionSettings()

public UnaryCallSettings<CreateExecutionRequest,Operation> createExecutionSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateExecutionRequest,Operation>

createInstanceOperationSettings()

public OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata>

createInstanceSettings()

public UnaryCallSettings<CreateInstanceRequest,Operation> createInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateInstanceRequest,Operation>

createScheduleOperationSettings()

public OperationCallSettings<CreateScheduleRequest,Schedule,OperationMetadata> createScheduleOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateScheduleRequest,Schedule,OperationMetadata>

createScheduleSettings()

public UnaryCallSettings<CreateScheduleRequest,Operation> createScheduleSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateScheduleRequest,Operation>

createStub()

public NotebookServiceStub createStub()
Returns
TypeDescription
NotebookServiceStub
Exceptions
TypeDescription
IOException

deleteEnvironmentOperationSettings()

public OperationCallSettings<DeleteEnvironmentRequest,Empty,OperationMetadata> deleteEnvironmentOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteEnvironmentRequest,Empty,OperationMetadata>

deleteEnvironmentSettings()

public UnaryCallSettings<DeleteEnvironmentRequest,Operation> deleteEnvironmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteEnvironmentRequest,Operation>

deleteExecutionOperationSettings()

public OperationCallSettings<DeleteExecutionRequest,Empty,OperationMetadata> deleteExecutionOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteExecutionRequest,Empty,OperationMetadata>

deleteExecutionSettings()

public UnaryCallSettings<DeleteExecutionRequest,Operation> deleteExecutionSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteExecutionRequest,Operation>

deleteInstanceOperationSettings()

public OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadata> deleteInstanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadata>

deleteInstanceSettings()

public UnaryCallSettings<DeleteInstanceRequest,Operation> deleteInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteInstanceRequest,Operation>

deleteScheduleOperationSettings()

public OperationCallSettings<DeleteScheduleRequest,Empty,OperationMetadata> deleteScheduleOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteScheduleRequest,Empty,OperationMetadata>

deleteScheduleSettings()

public UnaryCallSettings<DeleteScheduleRequest,Operation> deleteScheduleSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteScheduleRequest,Operation>

getEnvironmentSettings()

public UnaryCallSettings<GetEnvironmentRequest,Environment> getEnvironmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetEnvironmentRequest,Environment>

getExecutionSettings()

public UnaryCallSettings<GetExecutionRequest,Execution> getExecutionSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetExecutionRequest,Execution>

getInstanceHealthSettings()

public UnaryCallSettings<GetInstanceHealthRequest,GetInstanceHealthResponse> getInstanceHealthSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetInstanceHealthRequest,GetInstanceHealthResponse>

getInstanceSettings()

public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetInstanceRequest,Instance>

getScheduleSettings()

public UnaryCallSettings<GetScheduleRequest,Schedule> getScheduleSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetScheduleRequest,Schedule>

isInstanceUpgradeableSettings()

public UnaryCallSettings<IsInstanceUpgradeableRequest,IsInstanceUpgradeableResponse> isInstanceUpgradeableSettings()

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

Returns
TypeDescription
UnaryCallSettings<IsInstanceUpgradeableRequest,IsInstanceUpgradeableResponse>

listEnvironmentsSettings()

public PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse,NotebookServiceClient.ListEnvironmentsPagedResponse> listEnvironmentsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse,ListEnvironmentsPagedResponse>

listExecutionsSettings()

public PagedCallSettings<ListExecutionsRequest,ListExecutionsResponse,NotebookServiceClient.ListExecutionsPagedResponse> listExecutionsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListExecutionsRequest,ListExecutionsResponse,ListExecutionsPagedResponse>

listInstancesSettings()

public PagedCallSettings<ListInstancesRequest,ListInstancesResponse,NotebookServiceClient.ListInstancesPagedResponse> listInstancesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse>

listSchedulesSettings()

public PagedCallSettings<ListSchedulesRequest,ListSchedulesResponse,NotebookServiceClient.ListSchedulesPagedResponse> listSchedulesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListSchedulesRequest,ListSchedulesResponse,ListSchedulesPagedResponse>

registerInstanceOperationSettings()

public OperationCallSettings<RegisterInstanceRequest,Instance,OperationMetadata> registerInstanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<RegisterInstanceRequest,Instance,OperationMetadata>

registerInstanceSettings()

public UnaryCallSettings<RegisterInstanceRequest,Operation> registerInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<RegisterInstanceRequest,Operation>

reportInstanceInfoOperationSettings()

public OperationCallSettings<ReportInstanceInfoRequest,Instance,OperationMetadata> reportInstanceInfoOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<ReportInstanceInfoRequest,Instance,OperationMetadata>

reportInstanceInfoSettings()

public UnaryCallSettings<ReportInstanceInfoRequest,Operation> reportInstanceInfoSettings()

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

Returns
TypeDescription
UnaryCallSettings<ReportInstanceInfoRequest,Operation>

resetInstanceOperationSettings()

public OperationCallSettings<ResetInstanceRequest,Instance,OperationMetadata> resetInstanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<ResetInstanceRequest,Instance,OperationMetadata>

resetInstanceSettings()

public UnaryCallSettings<ResetInstanceRequest,Operation> resetInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<ResetInstanceRequest,Operation>

rollbackInstanceOperationSettings()

public OperationCallSettings<RollbackInstanceRequest,Instance,OperationMetadata> rollbackInstanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<RollbackInstanceRequest,Instance,OperationMetadata>

rollbackInstanceSettings()

public UnaryCallSettings<RollbackInstanceRequest,Operation> rollbackInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<RollbackInstanceRequest,Operation>

setInstanceAcceleratorOperationSettings()

public OperationCallSettings<SetInstanceAcceleratorRequest,Instance,OperationMetadata> setInstanceAcceleratorOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<SetInstanceAcceleratorRequest,Instance,OperationMetadata>

setInstanceAcceleratorSettings()

public UnaryCallSettings<SetInstanceAcceleratorRequest,Operation> setInstanceAcceleratorSettings()

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

Returns
TypeDescription
UnaryCallSettings<SetInstanceAcceleratorRequest,Operation>

setInstanceLabelsOperationSettings()

public OperationCallSettings<SetInstanceLabelsRequest,Instance,OperationMetadata> setInstanceLabelsOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<SetInstanceLabelsRequest,Instance,OperationMetadata>

setInstanceLabelsSettings()

public UnaryCallSettings<SetInstanceLabelsRequest,Operation> setInstanceLabelsSettings()

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

Returns
TypeDescription
UnaryCallSettings<SetInstanceLabelsRequest,Operation>

setInstanceMachineTypeOperationSettings()

public OperationCallSettings<SetInstanceMachineTypeRequest,Instance,OperationMetadata> setInstanceMachineTypeOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<SetInstanceMachineTypeRequest,Instance,OperationMetadata>

setInstanceMachineTypeSettings()

public UnaryCallSettings<SetInstanceMachineTypeRequest,Operation> setInstanceMachineTypeSettings()

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

Returns
TypeDescription
UnaryCallSettings<SetInstanceMachineTypeRequest,Operation>

startInstanceOperationSettings()

public OperationCallSettings<StartInstanceRequest,Instance,OperationMetadata> startInstanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<StartInstanceRequest,Instance,OperationMetadata>

startInstanceSettings()

public UnaryCallSettings<StartInstanceRequest,Operation> startInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<StartInstanceRequest,Operation>

stopInstanceOperationSettings()

public OperationCallSettings<StopInstanceRequest,Instance,OperationMetadata> stopInstanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<StopInstanceRequest,Instance,OperationMetadata>

stopInstanceSettings()

public UnaryCallSettings<StopInstanceRequest,Operation> stopInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<StopInstanceRequest,Operation>

toBuilder()

public NotebookServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
NotebookServiceStubSettings.Builder
Overrides

triggerScheduleOperationSettings()

public OperationCallSettings<TriggerScheduleRequest,Schedule,OperationMetadata> triggerScheduleOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<TriggerScheduleRequest,Schedule,OperationMetadata>

triggerScheduleSettings()

public UnaryCallSettings<TriggerScheduleRequest,Operation> triggerScheduleSettings()

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

Returns
TypeDescription
UnaryCallSettings<TriggerScheduleRequest,Operation>

updateInstanceConfigOperationSettings()

public OperationCallSettings<UpdateInstanceConfigRequest,Instance,OperationMetadata> updateInstanceConfigOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateInstanceConfigRequest,Instance,OperationMetadata>

updateInstanceConfigSettings()

public UnaryCallSettings<UpdateInstanceConfigRequest,Operation> updateInstanceConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateInstanceConfigRequest,Operation>

updateInstanceMetadataItemsSettings()

public UnaryCallSettings<UpdateInstanceMetadataItemsRequest,UpdateInstanceMetadataItemsResponse> updateInstanceMetadataItemsSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateInstanceMetadataItemsRequest,UpdateInstanceMetadataItemsResponse>

updateShieldedInstanceConfigOperationSettings()

public OperationCallSettings<UpdateShieldedInstanceConfigRequest,Instance,OperationMetadata> updateShieldedInstanceConfigOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateShieldedInstanceConfigRequest,Instance,OperationMetadata>

updateShieldedInstanceConfigSettings()

public UnaryCallSettings<UpdateShieldedInstanceConfigRequest,Operation> updateShieldedInstanceConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateShieldedInstanceConfigRequest,Operation>

upgradeInstanceInternalOperationSettings()

public OperationCallSettings<UpgradeInstanceInternalRequest,Instance,OperationMetadata> upgradeInstanceInternalOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpgradeInstanceInternalRequest,Instance,OperationMetadata>

upgradeInstanceInternalSettings()

public UnaryCallSettings<UpgradeInstanceInternalRequest,Operation> upgradeInstanceInternalSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpgradeInstanceInternalRequest,Operation>

upgradeInstanceOperationSettings()

public OperationCallSettings<UpgradeInstanceRequest,Instance,OperationMetadata> upgradeInstanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpgradeInstanceRequest,Instance,OperationMetadata>

upgradeInstanceSettings()

public UnaryCallSettings<UpgradeInstanceRequest,Operation> upgradeInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpgradeInstanceRequest,Operation>