Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

AI Platform Notebooks v1 API - Class NotebookServiceSettings (2.0.0)

public sealed class NotebookServiceSettings : ServiceSettingsBase

Reference documentation and code samples for the AI Platform Notebooks v1 API class NotebookServiceSettings.

Settings for NotebookServiceClient instances.

Inheritance

Object > ServiceSettingsBase > NotebookServiceSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Constructors

NotebookServiceSettings()

public NotebookServiceSettings()

Constructs a new NotebookServiceSettings object with default settings.

Properties

CreateEnvironmentOperationsSettings

public OperationsSettings CreateEnvironmentOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.CreateEnvironment and NotebookServiceClient.CreateEnvironmentAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

CreateEnvironmentSettings

public CallSettings CreateEnvironmentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.CreateEnvironment and NotebookServiceClient.CreateEnvironmentAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

CreateExecutionOperationsSettings

public OperationsSettings CreateExecutionOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.CreateExecution and NotebookServiceClient.CreateExecutionAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

CreateExecutionSettings

public CallSettings CreateExecutionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.CreateExecution and NotebookServiceClient.CreateExecutionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

CreateInstanceOperationsSettings

public OperationsSettings CreateInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.CreateInstance and NotebookServiceClient.CreateInstanceAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

CreateInstanceSettings

public CallSettings CreateInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.CreateInstance and NotebookServiceClient.CreateInstanceAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

CreateScheduleOperationsSettings

public OperationsSettings CreateScheduleOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.CreateSchedule and NotebookServiceClient.CreateScheduleAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

CreateScheduleSettings

public CallSettings CreateScheduleSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.CreateSchedule and NotebookServiceClient.CreateScheduleAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

DeleteEnvironmentOperationsSettings

public OperationsSettings DeleteEnvironmentOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.DeleteEnvironment and NotebookServiceClient.DeleteEnvironmentAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

DeleteEnvironmentSettings

public CallSettings DeleteEnvironmentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.DeleteEnvironment and NotebookServiceClient.DeleteEnvironmentAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

DeleteExecutionOperationsSettings

public OperationsSettings DeleteExecutionOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.DeleteExecution and NotebookServiceClient.DeleteExecutionAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

DeleteExecutionSettings

public CallSettings DeleteExecutionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.DeleteExecution and NotebookServiceClient.DeleteExecutionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

DeleteInstanceOperationsSettings

public OperationsSettings DeleteInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.DeleteInstance and NotebookServiceClient.DeleteInstanceAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

DeleteInstanceSettings

public CallSettings DeleteInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.DeleteInstance and NotebookServiceClient.DeleteInstanceAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

DeleteScheduleOperationsSettings

public OperationsSettings DeleteScheduleOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.DeleteSchedule and NotebookServiceClient.DeleteScheduleAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

DeleteScheduleSettings

public CallSettings DeleteScheduleSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.DeleteSchedule and NotebookServiceClient.DeleteScheduleAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

GetEnvironmentSettings

public CallSettings GetEnvironmentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.GetEnvironment and NotebookServiceClient.GetEnvironmentAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

GetExecutionSettings

public CallSettings GetExecutionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.GetExecution and NotebookServiceClient.GetExecutionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

GetInstanceHealthSettings

public CallSettings GetInstanceHealthSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.GetInstanceHealth and NotebookServiceClient.GetInstanceHealthAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

GetInstanceSettings

public CallSettings GetInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.GetInstance and NotebookServiceClient.GetInstanceAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

GetScheduleSettings

public CallSettings GetScheduleSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.GetSchedule and NotebookServiceClient.GetScheduleAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

IsInstanceUpgradeableSettings

public CallSettings IsInstanceUpgradeableSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.IsInstanceUpgradeable and NotebookServiceClient.IsInstanceUpgradeableAsync .

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

ListEnvironmentsSettings

public CallSettings ListEnvironmentsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.ListEnvironments and NotebookServiceClient.ListEnvironmentsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

ListExecutionsSettings

public CallSettings ListExecutionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.ListExecutions and NotebookServiceClient.ListExecutionsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

ListInstancesSettings

public CallSettings ListInstancesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.ListInstances and NotebookServiceClient.ListInstancesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

ListSchedulesSettings

public CallSettings ListSchedulesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.ListSchedules and NotebookServiceClient.ListSchedulesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

RegisterInstanceOperationsSettings

public OperationsSettings RegisterInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.RegisterInstance and NotebookServiceClient.RegisterInstanceAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

RegisterInstanceSettings

public CallSettings RegisterInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.RegisterInstance and NotebookServiceClient.RegisterInstanceAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

ReportInstanceInfoOperationsSettings

public OperationsSettings ReportInstanceInfoOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.ReportInstanceInfo and NotebookServiceClient.ReportInstanceInfoAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

ReportInstanceInfoSettings

public CallSettings ReportInstanceInfoSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.ReportInstanceInfo and NotebookServiceClient.ReportInstanceInfoAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

ResetInstanceOperationsSettings

public OperationsSettings ResetInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.ResetInstance and NotebookServiceClient.ResetInstanceAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

ResetInstanceSettings

public CallSettings ResetInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.ResetInstance and NotebookServiceClient.ResetInstanceAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

RollbackInstanceOperationsSettings

public OperationsSettings RollbackInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.RollbackInstance and NotebookServiceClient.RollbackInstanceAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

RollbackInstanceSettings

public CallSettings RollbackInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.RollbackInstance and NotebookServiceClient.RollbackInstanceAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

SetInstanceAcceleratorOperationsSettings

public OperationsSettings SetInstanceAcceleratorOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.SetInstanceAccelerator and NotebookServiceClient.SetInstanceAcceleratorAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

SetInstanceAcceleratorSettings

public CallSettings SetInstanceAcceleratorSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.SetInstanceAccelerator and NotebookServiceClient.SetInstanceAcceleratorAsync .

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

SetInstanceLabelsOperationsSettings

public OperationsSettings SetInstanceLabelsOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.SetInstanceLabels and NotebookServiceClient.SetInstanceLabelsAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

SetInstanceLabelsSettings

public CallSettings SetInstanceLabelsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.SetInstanceLabels and NotebookServiceClient.SetInstanceLabelsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

SetInstanceMachineTypeOperationsSettings

public OperationsSettings SetInstanceMachineTypeOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.SetInstanceMachineType and NotebookServiceClient.SetInstanceMachineTypeAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

SetInstanceMachineTypeSettings

public CallSettings SetInstanceMachineTypeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.SetInstanceMachineType and NotebookServiceClient.SetInstanceMachineTypeAsync .

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

StartInstanceOperationsSettings

public OperationsSettings StartInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.StartInstance and NotebookServiceClient.StartInstanceAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

StartInstanceSettings

public CallSettings StartInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.StartInstance and NotebookServiceClient.StartInstanceAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

StopInstanceOperationsSettings

public OperationsSettings StopInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.StopInstance and NotebookServiceClient.StopInstanceAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

StopInstanceSettings

public CallSettings StopInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.StopInstance and NotebookServiceClient.StopInstanceAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

TriggerScheduleOperationsSettings

public OperationsSettings TriggerScheduleOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.TriggerSchedule and NotebookServiceClient.TriggerScheduleAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

TriggerScheduleSettings

public CallSettings TriggerScheduleSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.TriggerSchedule and NotebookServiceClient.TriggerScheduleAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unavailable.
Timeout: 60 seconds.

UpdateInstanceConfigOperationsSettings

public OperationsSettings UpdateInstanceConfigOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.UpdateInstanceConfig and NotebookServiceClient.UpdateInstanceConfigAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

UpdateInstanceConfigSettings

public CallSettings UpdateInstanceConfigSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.UpdateInstanceConfig and NotebookServiceClient.UpdateInstanceConfigAsync .

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

UpdateInstanceMetadataItemsSettings

public CallSettings UpdateInstanceMetadataItemsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.UpdateInstanceMetadataItems and NotebookServiceClient.UpdateInstanceMetadataItemsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unavailable.
Timeout: 60 seconds.

UpdateShieldedInstanceConfigOperationsSettings

public OperationsSettings UpdateShieldedInstanceConfigOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.UpdateShieldedInstanceConfig and NotebookServiceClient.UpdateShieldedInstanceConfigAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

UpdateShieldedInstanceConfigSettings

public CallSettings UpdateShieldedInstanceConfigSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.UpdateShieldedInstanceConfig and NotebookServiceClient.UpdateShieldedInstanceConfigAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

UpgradeInstanceInternalOperationsSettings

public OperationsSettings UpgradeInstanceInternalOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.UpgradeInstanceInternal and NotebookServiceClient.UpgradeInstanceInternalAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

UpgradeInstanceInternalSettings

public CallSettings UpgradeInstanceInternalSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.UpgradeInstanceInternal and NotebookServiceClient.UpgradeInstanceInternalAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

UpgradeInstanceOperationsSettings

public OperationsSettings UpgradeInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.UpgradeInstance and NotebookServiceClient.UpgradeInstanceAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

UpgradeInstanceSettings

public CallSettings UpgradeInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.UpgradeInstance and NotebookServiceClient.UpgradeInstanceAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 60 seconds.

Methods

Clone()

public NotebookServiceSettings Clone()

Creates a deep clone of this object, with all the same property values.

Returns
Type	Description
`NotebookServiceSettings`	A deep clone of this NotebookServiceSettings object.

GetDefault()

public static NotebookServiceSettings GetDefault()

Get a new instance of the default NotebookServiceSettings.

Returns
Type	Description
`NotebookServiceSettings`	A new instance of the default NotebookServiceSettings.