Notebooks v2 API - Class NotebookServiceSettings (1.2.0)

public sealed class NotebookServiceSettings : ServiceSettingsBase

Reference documentation and code samples for the Notebooks v2 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.ToString()

Namespace

Google.Cloud.Notebooks.V2

Assembly

Google.Cloud.Notebooks.V2.dll

Constructors

NotebookServiceSettings()

public NotebookServiceSettings()

Constructs a new NotebookServiceSettings object with default settings.

Properties

CheckInstanceUpgradabilitySettings

public CallSettings CheckInstanceUpgradabilitySettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.CheckInstanceUpgradability and NotebookServiceClient.CheckInstanceUpgradabilityAsync.

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.

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.

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.

DiagnoseInstanceOperationsSettings

public OperationsSettings DiagnoseInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.DiagnoseInstance and NotebookServiceClient.DiagnoseInstanceAsync.

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.

DiagnoseInstanceSettings

public CallSettings DiagnoseInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.DiagnoseInstance and NotebookServiceClient.DiagnoseInstanceAsync.

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.

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.

IAMPolicySettings

public IAMPolicySettings IAMPolicySettings { get; set; }

The settings to use for the IAMPolicyClient associated with the client.

Property Value
Type	Description
`IAMPolicySettings`

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.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

The settings to use for the LocationsClient associated with the client.

Property Value
Type	Description
`LocationsSettings`

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.

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.

UpdateInstanceOperationsSettings

public OperationsSettings UpdateInstanceOperationsSettings { get; set; }

Long Running Operation settings for calls to NotebookServiceClient.UpdateInstance and NotebookServiceClient.UpdateInstanceAsync.

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.

UpdateInstanceSettings

public CallSettings UpdateInstanceSettings { get; set; }

CallSettings for synchronous and asynchronous calls to NotebookServiceClient.UpdateInstance and NotebookServiceClient.UpdateInstanceAsync.

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.

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.