Class NotebookServiceSettings (1.4.0)

public class NotebookServiceSettings extends 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();

Inheritance

java.lang.Object > ClientSettings > NotebookServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(NotebookServiceStubSettings stub)

public static final NotebookServiceSettings create(NotebookServiceStubSettings stub)

Parameter

Name	Description
stub	`NotebookServiceStubSettings`

Returns

Type	Description
NotebookServiceSettings

Exceptions

Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns

Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns

Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns

Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns

Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns

Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns

Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

newBuilder()

public static NotebookServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
NotebookServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static NotebookServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
NotebookServiceSettings.Builder

Constructors

NotebookServiceSettings(NotebookServiceSettings.Builder settingsBuilder)

protected NotebookServiceSettings(NotebookServiceSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`NotebookServiceSettings.Builder`

Methods

createEnvironmentOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<CreateEnvironmentRequest,Environment,OperationMetadata>

createEnvironmentSettings()

public UnaryCallSettings<CreateEnvironmentRequest,Operation> createEnvironmentSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateEnvironmentRequest,Operation>

createExecutionOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<CreateExecutionRequest,Execution,OperationMetadata>

createExecutionSettings()

public UnaryCallSettings<CreateExecutionRequest,Operation> createExecutionSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateExecutionRequest,Operation>

createInstanceOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata>

createInstanceSettings()

public UnaryCallSettings<CreateInstanceRequest,Operation> createInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateInstanceRequest,Operation>

createScheduleOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<CreateScheduleRequest,Schedule,OperationMetadata>

createScheduleSettings()

public UnaryCallSettings<CreateScheduleRequest,Operation> createScheduleSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateScheduleRequest,Operation>

deleteEnvironmentOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<DeleteEnvironmentRequest,Empty,OperationMetadata>

deleteEnvironmentSettings()

public UnaryCallSettings<DeleteEnvironmentRequest,Operation> deleteEnvironmentSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteEnvironmentRequest,Operation>

deleteExecutionOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<DeleteExecutionRequest,Empty,OperationMetadata>

deleteExecutionSettings()

public UnaryCallSettings<DeleteExecutionRequest,Operation> deleteExecutionSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteExecutionRequest,Operation>

deleteInstanceOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadata>

deleteInstanceSettings()

public UnaryCallSettings<DeleteInstanceRequest,Operation> deleteInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteInstanceRequest,Operation>

deleteScheduleOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<DeleteScheduleRequest,Empty,OperationMetadata>

deleteScheduleSettings()

public UnaryCallSettings<DeleteScheduleRequest,Operation> deleteScheduleSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteScheduleRequest,Operation>

getEnvironmentSettings()

public UnaryCallSettings<GetEnvironmentRequest,Environment> getEnvironmentSettings()

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

Returns

Type	Description
UnaryCallSettings<GetEnvironmentRequest,Environment>

getExecutionSettings()

public UnaryCallSettings<GetExecutionRequest,Execution> getExecutionSettings()

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

Returns

Type	Description
UnaryCallSettings<GetExecutionRequest,Execution>

getInstanceHealthSettings()

public UnaryCallSettings<GetInstanceHealthRequest,GetInstanceHealthResponse> getInstanceHealthSettings()

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

Returns

Type	Description
UnaryCallSettings<GetInstanceHealthRequest,GetInstanceHealthResponse>

getInstanceSettings()

public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<GetInstanceRequest,Instance>

getScheduleSettings()

public UnaryCallSettings<GetScheduleRequest,Schedule> getScheduleSettings()

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

Returns

Type	Description
UnaryCallSettings<GetScheduleRequest,Schedule>

isInstanceUpgradeableSettings()

public UnaryCallSettings<IsInstanceUpgradeableRequest,IsInstanceUpgradeableResponse> isInstanceUpgradeableSettings()

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

Returns

Type	Description
UnaryCallSettings<IsInstanceUpgradeableRequest,IsInstanceUpgradeableResponse>

listEnvironmentsSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse,ListEnvironmentsPagedResponse>

listExecutionsSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListExecutionsRequest,ListExecutionsResponse,ListExecutionsPagedResponse>

listInstancesSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse>

listSchedulesSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListSchedulesRequest,ListSchedulesResponse,ListSchedulesPagedResponse>

registerInstanceOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<RegisterInstanceRequest,Instance,OperationMetadata>

registerInstanceSettings()

public UnaryCallSettings<RegisterInstanceRequest,Operation> registerInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<RegisterInstanceRequest,Operation>

reportInstanceInfoOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<ReportInstanceInfoRequest,Instance,OperationMetadata>

reportInstanceInfoSettings()

public UnaryCallSettings<ReportInstanceInfoRequest,Operation> reportInstanceInfoSettings()

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

Returns

Type	Description
UnaryCallSettings<ReportInstanceInfoRequest,Operation>

resetInstanceOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<ResetInstanceRequest,Instance,OperationMetadata>

resetInstanceSettings()

public UnaryCallSettings<ResetInstanceRequest,Operation> resetInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<ResetInstanceRequest,Operation>

rollbackInstanceOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<RollbackInstanceRequest,Instance,OperationMetadata>

rollbackInstanceSettings()

public UnaryCallSettings<RollbackInstanceRequest,Operation> rollbackInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<RollbackInstanceRequest,Operation>

setInstanceAcceleratorOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<SetInstanceAcceleratorRequest,Instance,OperationMetadata>

setInstanceAcceleratorSettings()

public UnaryCallSettings<SetInstanceAcceleratorRequest,Operation> setInstanceAcceleratorSettings()

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

Returns

Type	Description
UnaryCallSettings<SetInstanceAcceleratorRequest,Operation>

setInstanceLabelsOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<SetInstanceLabelsRequest,Instance,OperationMetadata>

setInstanceLabelsSettings()

public UnaryCallSettings<SetInstanceLabelsRequest,Operation> setInstanceLabelsSettings()

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

Returns

Type	Description
UnaryCallSettings<SetInstanceLabelsRequest,Operation>

setInstanceMachineTypeOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<SetInstanceMachineTypeRequest,Instance,OperationMetadata>

setInstanceMachineTypeSettings()

public UnaryCallSettings<SetInstanceMachineTypeRequest,Operation> setInstanceMachineTypeSettings()

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

Returns

Type	Description
UnaryCallSettings<SetInstanceMachineTypeRequest,Operation>

startInstanceOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<StartInstanceRequest,Instance,OperationMetadata>

startInstanceSettings()

public UnaryCallSettings<StartInstanceRequest,Operation> startInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<StartInstanceRequest,Operation>

stopInstanceOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<StopInstanceRequest,Instance,OperationMetadata>

stopInstanceSettings()

public UnaryCallSettings<StopInstanceRequest,Operation> stopInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<StopInstanceRequest,Operation>

toBuilder()

public NotebookServiceSettings.Builder toBuilder()

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

Returns

Type	Description
NotebookServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

triggerScheduleOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<TriggerScheduleRequest,Schedule,OperationMetadata>

triggerScheduleSettings()

public UnaryCallSettings<TriggerScheduleRequest,Operation> triggerScheduleSettings()

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

Returns

Type	Description
UnaryCallSettings<TriggerScheduleRequest,Operation>

updateInstanceConfigOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<UpdateInstanceConfigRequest,Instance,OperationMetadata>

updateInstanceConfigSettings()

public UnaryCallSettings<UpdateInstanceConfigRequest,Operation> updateInstanceConfigSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateInstanceConfigRequest,Operation>

updateInstanceMetadataItemsSettings()

public UnaryCallSettings<UpdateInstanceMetadataItemsRequest,UpdateInstanceMetadataItemsResponse> updateInstanceMetadataItemsSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateInstanceMetadataItemsRequest,UpdateInstanceMetadataItemsResponse>

updateShieldedInstanceConfigOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<UpdateShieldedInstanceConfigRequest,Instance,OperationMetadata>

updateShieldedInstanceConfigSettings()

public UnaryCallSettings<UpdateShieldedInstanceConfigRequest,Operation> updateShieldedInstanceConfigSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateShieldedInstanceConfigRequest,Operation>

upgradeInstanceInternalOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<UpgradeInstanceInternalRequest,Instance,OperationMetadata>

upgradeInstanceInternalSettings()

public UnaryCallSettings<UpgradeInstanceInternalRequest,Operation> upgradeInstanceInternalSettings()

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

Returns

Type	Description
UnaryCallSettings<UpgradeInstanceInternalRequest,Operation>

upgradeInstanceOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<UpgradeInstanceRequest,Instance,OperationMetadata>

upgradeInstanceSettings()

public UnaryCallSettings<UpgradeInstanceRequest,Operation> upgradeInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<UpgradeInstanceRequest,Operation>