AI Platform Notebooks v1 API - Class NotebookService.NotebookServiceClient (2.5.0)

public class NotebookService.NotebookServiceClient : ClientBase<NotebookService.NotebookServiceClient>

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

Client for NotebookService

Inheritance

object > ClientBase > ClientBaseNotebookServiceNotebookServiceClient > NotebookService.NotebookServiceClient

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Constructors

NotebookServiceClient()

protected NotebookServiceClient()

Protected parameterless constructor to allow creation of test doubles.

NotebookServiceClient(CallInvoker)

public NotebookServiceClient(CallInvoker callInvoker)

Creates a new client for NotebookService that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

NotebookServiceClient(ChannelBase)

public NotebookServiceClient(ChannelBase channel)

Creates a new client for NotebookService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

NotebookServiceClient(ClientBaseConfiguration)

protected NotebookServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateEnvironment(CreateEnvironmentRequest, CallOptions)

public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, CallOptions options)

Creates a new Environment.

Parameters
Name Description
request CreateEnvironmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateEnvironment(CreateEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Environment.

Parameters
Name Description
request CreateEnvironmentRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateEnvironmentAsync(CreateEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallOptions options)

Creates a new Environment.

Parameters
Name Description
request CreateEnvironmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateEnvironmentAsync(CreateEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateEnvironmentAsync(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Environment.

Parameters
Name Description
request CreateEnvironmentRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateExecution(CreateExecutionRequest, CallOptions)

public virtual Operation CreateExecution(CreateExecutionRequest request, CallOptions options)

Creates a new Execution in a given project and location.

Parameters
Name Description
request CreateExecutionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateExecution(CreateExecutionRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateExecution(CreateExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Execution in a given project and location.

Parameters
Name Description
request CreateExecutionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateExecutionAsync(CreateExecutionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateExecutionAsync(CreateExecutionRequest request, CallOptions options)

Creates a new Execution in a given project and location.

Parameters
Name Description
request CreateExecutionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateExecutionAsync(CreateExecutionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateExecutionAsync(CreateExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Execution in a given project and location.

Parameters
Name Description
request CreateExecutionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type Description
IAMPolicyIAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateInstance(CreateInstanceRequest, CallOptions)

public virtual Operation CreateInstance(CreateInstanceRequest request, CallOptions options)

Creates a new Instance in a given project and location.

Parameters
Name Description
request CreateInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateInstance(CreateInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateInstance(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Instance in a given project and location.

Parameters
Name Description
request CreateInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateInstanceAsync(CreateInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, CallOptions options)

Creates a new Instance in a given project and location.

Parameters
Name Description
request CreateInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateInstanceAsync(CreateInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Instance in a given project and location.

Parameters
Name Description
request CreateInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

CreateSchedule(CreateScheduleRequest, CallOptions)

public virtual Operation CreateSchedule(CreateScheduleRequest request, CallOptions options)

Creates a new Scheduled Notebook in a given project and location.

Parameters
Name Description
request CreateScheduleRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateSchedule(CreateScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateSchedule(CreateScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Scheduled Notebook in a given project and location.

Parameters
Name Description
request CreateScheduleRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateScheduleAsync(CreateScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateScheduleAsync(CreateScheduleRequest request, CallOptions options)

Creates a new Scheduled Notebook in a given project and location.

Parameters
Name Description
request CreateScheduleRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateScheduleAsync(CreateScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateScheduleAsync(CreateScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Scheduled Notebook in a given project and location.

Parameters
Name Description
request CreateScheduleRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteEnvironment(DeleteEnvironmentRequest, CallOptions)

public virtual Operation DeleteEnvironment(DeleteEnvironmentRequest request, CallOptions options)

Deletes a single Environment.

Parameters
Name Description
request DeleteEnvironmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteEnvironment(DeleteEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteEnvironment(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single Environment.

Parameters
Name Description
request DeleteEnvironmentRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CallOptions options)

Deletes a single Environment.

Parameters
Name Description
request DeleteEnvironmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single Environment.

Parameters
Name Description
request DeleteEnvironmentRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteExecution(DeleteExecutionRequest, CallOptions)

public virtual Operation DeleteExecution(DeleteExecutionRequest request, CallOptions options)

Deletes execution

Parameters
Name Description
request DeleteExecutionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteExecution(DeleteExecutionRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteExecution(DeleteExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes execution

Parameters
Name Description
request DeleteExecutionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteExecutionAsync(DeleteExecutionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteExecutionAsync(DeleteExecutionRequest request, CallOptions options)

Deletes execution

Parameters
Name Description
request DeleteExecutionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteExecutionAsync(DeleteExecutionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteExecutionAsync(DeleteExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes execution

Parameters
Name Description
request DeleteExecutionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteInstance(DeleteInstanceRequest, CallOptions)

public virtual Operation DeleteInstance(DeleteInstanceRequest request, CallOptions options)

Deletes a single Instance.

Parameters
Name Description
request DeleteInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteInstance(DeleteInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteInstance(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single Instance.

Parameters
Name Description
request DeleteInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteInstanceAsync(DeleteInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, CallOptions options)

Deletes a single Instance.

Parameters
Name Description
request DeleteInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteInstanceAsync(DeleteInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single Instance.

Parameters
Name Description
request DeleteInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteSchedule(DeleteScheduleRequest, CallOptions)

public virtual Operation DeleteSchedule(DeleteScheduleRequest request, CallOptions options)

Deletes schedule and all underlying jobs

Parameters
Name Description
request DeleteScheduleRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteSchedule(DeleteScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteSchedule(DeleteScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes schedule and all underlying jobs

Parameters
Name Description
request DeleteScheduleRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteScheduleAsync(DeleteScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteScheduleAsync(DeleteScheduleRequest request, CallOptions options)

Deletes schedule and all underlying jobs

Parameters
Name Description
request DeleteScheduleRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteScheduleAsync(DeleteScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteScheduleAsync(DeleteScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes schedule and all underlying jobs

Parameters
Name Description
request DeleteScheduleRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DiagnoseInstance(DiagnoseInstanceRequest, CallOptions)

public virtual Operation DiagnoseInstance(DiagnoseInstanceRequest request, CallOptions options)

Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

Parameters
Name Description
request DiagnoseInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DiagnoseInstance(DiagnoseInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DiagnoseInstance(DiagnoseInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

Parameters
Name Description
request DiagnoseInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DiagnoseInstanceAsync(DiagnoseInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DiagnoseInstanceAsync(DiagnoseInstanceRequest request, CallOptions options)

Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

Parameters
Name Description
request DiagnoseInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DiagnoseInstanceAsync(DiagnoseInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DiagnoseInstanceAsync(DiagnoseInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

Parameters
Name Description
request DiagnoseInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

GetEnvironment(GetEnvironmentRequest, CallOptions)

public virtual Environment GetEnvironment(GetEnvironmentRequest request, CallOptions options)

Gets details of a single Environment.

Parameters
Name Description
request GetEnvironmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Environment

The response received from the server.

GetEnvironment(GetEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual Environment GetEnvironment(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Environment.

Parameters
Name Description
request GetEnvironmentRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Environment

The response received from the server.

GetEnvironmentAsync(GetEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CallOptions options)

Gets details of a single Environment.

Parameters
Name Description
request GetEnvironmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEnvironment

The call object.

GetEnvironmentAsync(GetEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Environment.

Parameters
Name Description
request GetEnvironmentRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEnvironment

The call object.

GetExecution(GetExecutionRequest, CallOptions)

public virtual Execution GetExecution(GetExecutionRequest request, CallOptions options)

Gets details of executions

Parameters
Name Description
request GetExecutionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Execution

The response received from the server.

GetExecution(GetExecutionRequest, Metadata, DateTime?, CancellationToken)

public virtual Execution GetExecution(GetExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of executions

Parameters
Name Description
request GetExecutionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Execution

The response received from the server.

GetExecutionAsync(GetExecutionRequest, CallOptions)

public virtual AsyncUnaryCall<Execution> GetExecutionAsync(GetExecutionRequest request, CallOptions options)

Gets details of executions

Parameters
Name Description
request GetExecutionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallExecution

The call object.

GetExecutionAsync(GetExecutionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Execution> GetExecutionAsync(GetExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of executions

Parameters
Name Description
request GetExecutionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallExecution

The call object.

GetInstance(GetInstanceRequest, CallOptions)

public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)

Gets details of a single Instance.

Parameters
Name Description
request GetInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Instance

The response received from the server.

GetInstance(GetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Instance GetInstance(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Instance.

Parameters
Name Description
request GetInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Instance

The response received from the server.

GetInstanceAsync(GetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, CallOptions options)

Gets details of a single Instance.

Parameters
Name Description
request GetInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallInstance

The call object.

GetInstanceAsync(GetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Instance.

Parameters
Name Description
request GetInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallInstance

The call object.

GetInstanceHealth(GetInstanceHealthRequest, CallOptions)

public virtual GetInstanceHealthResponse GetInstanceHealth(GetInstanceHealthRequest request, CallOptions options)

Check if a notebook instance is healthy.

Parameters
Name Description
request GetInstanceHealthRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
GetInstanceHealthResponse

The response received from the server.

GetInstanceHealth(GetInstanceHealthRequest, Metadata, DateTime?, CancellationToken)

public virtual GetInstanceHealthResponse GetInstanceHealth(GetInstanceHealthRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Check if a notebook instance is healthy.

Parameters
Name Description
request GetInstanceHealthRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
GetInstanceHealthResponse

The response received from the server.

GetInstanceHealthAsync(GetInstanceHealthRequest, CallOptions)

public virtual AsyncUnaryCall<GetInstanceHealthResponse> GetInstanceHealthAsync(GetInstanceHealthRequest request, CallOptions options)

Check if a notebook instance is healthy.

Parameters
Name Description
request GetInstanceHealthRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallGetInstanceHealthResponse

The call object.

GetInstanceHealthAsync(GetInstanceHealthRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GetInstanceHealthResponse> GetInstanceHealthAsync(GetInstanceHealthRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Check if a notebook instance is healthy.

Parameters
Name Description
request GetInstanceHealthRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallGetInstanceHealthResponse

The call object.

GetSchedule(GetScheduleRequest, CallOptions)

public virtual Schedule GetSchedule(GetScheduleRequest request, CallOptions options)

Gets details of schedule

Parameters
Name Description
request GetScheduleRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Schedule

The response received from the server.

GetSchedule(GetScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual Schedule GetSchedule(GetScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of schedule

Parameters
Name Description
request GetScheduleRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Schedule

The response received from the server.

GetScheduleAsync(GetScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<Schedule> GetScheduleAsync(GetScheduleRequest request, CallOptions options)

Gets details of schedule

Parameters
Name Description
request GetScheduleRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSchedule

The call object.

GetScheduleAsync(GetScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Schedule> GetScheduleAsync(GetScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of schedule

Parameters
Name Description
request GetScheduleRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallSchedule

The call object.

IsInstanceUpgradeable(IsInstanceUpgradeableRequest, CallOptions)

public virtual IsInstanceUpgradeableResponse IsInstanceUpgradeable(IsInstanceUpgradeableRequest request, CallOptions options)

Check if a notebook instance is upgradable.

Parameters
Name Description
request IsInstanceUpgradeableRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
IsInstanceUpgradeableResponse

The response received from the server.

IsInstanceUpgradeable(IsInstanceUpgradeableRequest, Metadata, DateTime?, CancellationToken)

public virtual IsInstanceUpgradeableResponse IsInstanceUpgradeable(IsInstanceUpgradeableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Check if a notebook instance is upgradable.

Parameters
Name Description
request IsInstanceUpgradeableRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
IsInstanceUpgradeableResponse

The response received from the server.

IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, CallOptions)

public virtual AsyncUnaryCall<IsInstanceUpgradeableResponse> IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest request, CallOptions options)

Check if a notebook instance is upgradable.

Parameters
Name Description
request IsInstanceUpgradeableRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallIsInstanceUpgradeableResponse

The call object.

IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<IsInstanceUpgradeableResponse> IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Check if a notebook instance is upgradable.

Parameters
Name Description
request IsInstanceUpgradeableRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallIsInstanceUpgradeableResponse

The call object.

ListEnvironments(ListEnvironmentsRequest, CallOptions)

public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, CallOptions options)

Lists environments in a project.

Parameters
Name Description
request ListEnvironmentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListEnvironmentsResponse

The response received from the server.

ListEnvironments(ListEnvironmentsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists environments in a project.

Parameters
Name Description
request ListEnvironmentsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListEnvironmentsResponse

The response received from the server.

ListEnvironmentsAsync(ListEnvironmentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEnvironmentsResponse> ListEnvironmentsAsync(ListEnvironmentsRequest request, CallOptions options)

Lists environments in a project.

Parameters
Name Description
request ListEnvironmentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListEnvironmentsResponse

The call object.

ListEnvironmentsAsync(ListEnvironmentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEnvironmentsResponse> ListEnvironmentsAsync(ListEnvironmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists environments in a project.

Parameters
Name Description
request ListEnvironmentsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListEnvironmentsResponse

The call object.

ListExecutions(ListExecutionsRequest, CallOptions)

public virtual ListExecutionsResponse ListExecutions(ListExecutionsRequest request, CallOptions options)

Lists executions in a given project and location

Parameters
Name Description
request ListExecutionsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListExecutionsResponse

The response received from the server.

ListExecutions(ListExecutionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListExecutionsResponse ListExecutions(ListExecutionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists executions in a given project and location

Parameters
Name Description
request ListExecutionsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListExecutionsResponse

The response received from the server.

ListExecutionsAsync(ListExecutionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListExecutionsResponse> ListExecutionsAsync(ListExecutionsRequest request, CallOptions options)

Lists executions in a given project and location

Parameters
Name Description
request ListExecutionsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListExecutionsResponse

The call object.

ListExecutionsAsync(ListExecutionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListExecutionsResponse> ListExecutionsAsync(ListExecutionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists executions in a given project and location

Parameters
Name Description
request ListExecutionsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListExecutionsResponse

The call object.

ListInstances(ListInstancesRequest, CallOptions)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, CallOptions options)

Lists instances in a given project and location.

Parameters
Name Description
request ListInstancesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListInstancesResponse

The response received from the server.

ListInstances(ListInstancesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists instances in a given project and location.

Parameters
Name Description
request ListInstancesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListInstancesResponse

The response received from the server.

ListInstancesAsync(ListInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, CallOptions options)

Lists instances in a given project and location.

Parameters
Name Description
request ListInstancesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListInstancesResponse

The call object.

ListInstancesAsync(ListInstancesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists instances in a given project and location.

Parameters
Name Description
request ListInstancesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListInstancesResponse

The call object.

ListSchedules(ListSchedulesRequest, CallOptions)

public virtual ListSchedulesResponse ListSchedules(ListSchedulesRequest request, CallOptions options)

Lists schedules in a given project and location.

Parameters
Name Description
request ListSchedulesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListSchedulesResponse

The response received from the server.

ListSchedules(ListSchedulesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListSchedulesResponse ListSchedules(ListSchedulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists schedules in a given project and location.

Parameters
Name Description
request ListSchedulesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListSchedulesResponse

The response received from the server.

ListSchedulesAsync(ListSchedulesRequest, CallOptions)

public virtual AsyncUnaryCall<ListSchedulesResponse> ListSchedulesAsync(ListSchedulesRequest request, CallOptions options)

Lists schedules in a given project and location.

Parameters
Name Description
request ListSchedulesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListSchedulesResponse

The call object.

ListSchedulesAsync(ListSchedulesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListSchedulesResponse> ListSchedulesAsync(ListSchedulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists schedules in a given project and location.

Parameters
Name Description
request ListSchedulesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListSchedulesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override NotebookService.NotebookServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
NotebookServiceNotebookServiceClient
Overrides

RegisterInstance(RegisterInstanceRequest, CallOptions)

public virtual Operation RegisterInstance(RegisterInstanceRequest request, CallOptions options)

Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

Parameters
Name Description
request RegisterInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

RegisterInstance(RegisterInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RegisterInstance(RegisterInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

Parameters
Name Description
request RegisterInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

RegisterInstanceAsync(RegisterInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RegisterInstanceAsync(RegisterInstanceRequest request, CallOptions options)

Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

Parameters
Name Description
request RegisterInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

RegisterInstanceAsync(RegisterInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RegisterInstanceAsync(RegisterInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

Parameters
Name Description
request RegisterInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

ReportInstanceInfo(ReportInstanceInfoRequest, CallOptions)

public virtual Operation ReportInstanceInfo(ReportInstanceInfoRequest request, CallOptions options)

Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

Parameters
Name Description
request ReportInstanceInfoRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

ReportInstanceInfo(ReportInstanceInfoRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ReportInstanceInfo(ReportInstanceInfoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

Parameters
Name Description
request ReportInstanceInfoRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

ReportInstanceInfoAsync(ReportInstanceInfoRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ReportInstanceInfoAsync(ReportInstanceInfoRequest request, CallOptions options)

Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

Parameters
Name Description
request ReportInstanceInfoRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

ReportInstanceInfoAsync(ReportInstanceInfoRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ReportInstanceInfoAsync(ReportInstanceInfoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

Parameters
Name Description
request ReportInstanceInfoRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

ResetInstance(ResetInstanceRequest, CallOptions)

public virtual Operation ResetInstance(ResetInstanceRequest request, CallOptions options)

Resets a notebook instance.

Parameters
Name Description
request ResetInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

ResetInstance(ResetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ResetInstance(ResetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Resets a notebook instance.

Parameters
Name Description
request ResetInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

ResetInstanceAsync(ResetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ResetInstanceAsync(ResetInstanceRequest request, CallOptions options)

Resets a notebook instance.

Parameters
Name Description
request ResetInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

ResetInstanceAsync(ResetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ResetInstanceAsync(ResetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Resets a notebook instance.

Parameters
Name Description
request ResetInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

RollbackInstance(RollbackInstanceRequest, CallOptions)

public virtual Operation RollbackInstance(RollbackInstanceRequest request, CallOptions options)

Rollbacks a notebook instance to the previous version.

Parameters
Name Description
request RollbackInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

RollbackInstance(RollbackInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RollbackInstance(RollbackInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Rollbacks a notebook instance to the previous version.

Parameters
Name Description
request RollbackInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

RollbackInstanceAsync(RollbackInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RollbackInstanceAsync(RollbackInstanceRequest request, CallOptions options)

Rollbacks a notebook instance to the previous version.

Parameters
Name Description
request RollbackInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

RollbackInstanceAsync(RollbackInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RollbackInstanceAsync(RollbackInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Rollbacks a notebook instance to the previous version.

Parameters
Name Description
request RollbackInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

SetInstanceAccelerator(SetInstanceAcceleratorRequest, CallOptions)

public virtual Operation SetInstanceAccelerator(SetInstanceAcceleratorRequest request, CallOptions options)

Updates the guest accelerators of a single Instance.

Parameters
Name Description
request SetInstanceAcceleratorRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

SetInstanceAccelerator(SetInstanceAcceleratorRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SetInstanceAccelerator(SetInstanceAcceleratorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the guest accelerators of a single Instance.

Parameters
Name Description
request SetInstanceAcceleratorRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest request, CallOptions options)

Updates the guest accelerators of a single Instance.

Parameters
Name Description
request SetInstanceAcceleratorRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the guest accelerators of a single Instance.

Parameters
Name Description
request SetInstanceAcceleratorRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

SetInstanceLabels(SetInstanceLabelsRequest, CallOptions)

public virtual Operation SetInstanceLabels(SetInstanceLabelsRequest request, CallOptions options)

Replaces all the labels of an Instance.

Parameters
Name Description
request SetInstanceLabelsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

SetInstanceLabels(SetInstanceLabelsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SetInstanceLabels(SetInstanceLabelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Replaces all the labels of an Instance.

Parameters
Name Description
request SetInstanceLabelsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

SetInstanceLabelsAsync(SetInstanceLabelsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetInstanceLabelsAsync(SetInstanceLabelsRequest request, CallOptions options)

Replaces all the labels of an Instance.

Parameters
Name Description
request SetInstanceLabelsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

SetInstanceLabelsAsync(SetInstanceLabelsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetInstanceLabelsAsync(SetInstanceLabelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Replaces all the labels of an Instance.

Parameters
Name Description
request SetInstanceLabelsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

SetInstanceMachineType(SetInstanceMachineTypeRequest, CallOptions)

public virtual Operation SetInstanceMachineType(SetInstanceMachineTypeRequest request, CallOptions options)

Updates the machine type of a single Instance.

Parameters
Name Description
request SetInstanceMachineTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

SetInstanceMachineType(SetInstanceMachineTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SetInstanceMachineType(SetInstanceMachineTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the machine type of a single Instance.

Parameters
Name Description
request SetInstanceMachineTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest request, CallOptions options)

Updates the machine type of a single Instance.

Parameters
Name Description
request SetInstanceMachineTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the machine type of a single Instance.

Parameters
Name Description
request SetInstanceMachineTypeRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

StartInstance(StartInstanceRequest, CallOptions)

public virtual Operation StartInstance(StartInstanceRequest request, CallOptions options)

Starts a notebook instance.

Parameters
Name Description
request StartInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

StartInstance(StartInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation StartInstance(StartInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Starts a notebook instance.

Parameters
Name Description
request StartInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

StartInstanceAsync(StartInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StartInstanceAsync(StartInstanceRequest request, CallOptions options)

Starts a notebook instance.

Parameters
Name Description
request StartInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

StartInstanceAsync(StartInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> StartInstanceAsync(StartInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Starts a notebook instance.

Parameters
Name Description
request StartInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

StopInstance(StopInstanceRequest, CallOptions)

public virtual Operation StopInstance(StopInstanceRequest request, CallOptions options)

Stops a notebook instance.

Parameters
Name Description
request StopInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

StopInstance(StopInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation StopInstance(StopInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Stops a notebook instance.

Parameters
Name Description
request StopInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

StopInstanceAsync(StopInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StopInstanceAsync(StopInstanceRequest request, CallOptions options)

Stops a notebook instance.

Parameters
Name Description
request StopInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

StopInstanceAsync(StopInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> StopInstanceAsync(StopInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Stops a notebook instance.

Parameters
Name Description
request StopInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

TriggerSchedule(TriggerScheduleRequest, CallOptions)

public virtual Operation TriggerSchedule(TriggerScheduleRequest request, CallOptions options)

Triggers execution of an existing schedule.

Parameters
Name Description
request TriggerScheduleRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

TriggerSchedule(TriggerScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation TriggerSchedule(TriggerScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Triggers execution of an existing schedule.

Parameters
Name Description
request TriggerScheduleRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

TriggerScheduleAsync(TriggerScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> TriggerScheduleAsync(TriggerScheduleRequest request, CallOptions options)

Triggers execution of an existing schedule.

Parameters
Name Description
request TriggerScheduleRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

TriggerScheduleAsync(TriggerScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> TriggerScheduleAsync(TriggerScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Triggers execution of an existing schedule.

Parameters
Name Description
request TriggerScheduleRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateInstanceConfig(UpdateInstanceConfigRequest, CallOptions)

public virtual Operation UpdateInstanceConfig(UpdateInstanceConfigRequest request, CallOptions options)

Update Notebook Instance configurations.

Parameters
Name Description
request UpdateInstanceConfigRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateInstanceConfig(UpdateInstanceConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateInstanceConfig(UpdateInstanceConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update Notebook Instance configurations.

Parameters
Name Description
request UpdateInstanceConfigRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

UpdateInstanceConfigAsync(UpdateInstanceConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateInstanceConfigAsync(UpdateInstanceConfigRequest request, CallOptions options)

Update Notebook Instance configurations.

Parameters
Name Description
request UpdateInstanceConfigRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateInstanceConfigAsync(UpdateInstanceConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateInstanceConfigAsync(UpdateInstanceConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update Notebook Instance configurations.

Parameters
Name Description
request UpdateInstanceConfigRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest, CallOptions)

public virtual UpdateInstanceMetadataItemsResponse UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request, CallOptions options)

Add/update metadata items for an instance.

Parameters
Name Description
request UpdateInstanceMetadataItemsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
UpdateInstanceMetadataItemsResponse

The response received from the server.

UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest, Metadata, DateTime?, CancellationToken)

public virtual UpdateInstanceMetadataItemsResponse UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Add/update metadata items for an instance.

Parameters
Name Description
request UpdateInstanceMetadataItemsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
UpdateInstanceMetadataItemsResponse

The response received from the server.

UpdateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest, CallOptions)

public virtual AsyncUnaryCall<UpdateInstanceMetadataItemsResponse> UpdateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest request, CallOptions options)

Add/update metadata items for an instance.

Parameters
Name Description
request UpdateInstanceMetadataItemsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallUpdateInstanceMetadataItemsResponse

The call object.

UpdateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<UpdateInstanceMetadataItemsResponse> UpdateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Add/update metadata items for an instance.

Parameters
Name Description
request UpdateInstanceMetadataItemsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallUpdateInstanceMetadataItemsResponse

The call object.

UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest, CallOptions)

public virtual Operation UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request, CallOptions options)

Updates the Shielded instance configuration of a single Instance.

Parameters
Name Description
request UpdateShieldedInstanceConfigRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the Shielded instance configuration of a single Instance.

Parameters
Name Description
request UpdateShieldedInstanceConfigRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigRequest request, CallOptions options)

Updates the Shielded instance configuration of a single Instance.

Parameters
Name Description
request UpdateShieldedInstanceConfigRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the Shielded instance configuration of a single Instance.

Parameters
Name Description
request UpdateShieldedInstanceConfigRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpgradeInstance(UpgradeInstanceRequest, CallOptions)

public virtual Operation UpgradeInstance(UpgradeInstanceRequest request, CallOptions options)

Upgrades a notebook instance to the latest version.

Parameters
Name Description
request UpgradeInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpgradeInstance(UpgradeInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpgradeInstance(UpgradeInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Upgrades a notebook instance to the latest version.

Parameters
Name Description
request UpgradeInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

UpgradeInstanceAsync(UpgradeInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpgradeInstanceAsync(UpgradeInstanceRequest request, CallOptions options)

Upgrades a notebook instance to the latest version.

Parameters
Name Description
request UpgradeInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpgradeInstanceAsync(UpgradeInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpgradeInstanceAsync(UpgradeInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Upgrades a notebook instance to the latest version.

Parameters
Name Description
request UpgradeInstanceRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpgradeInstanceInternal(UpgradeInstanceInternalRequest, CallOptions)

public virtual Operation UpgradeInstanceInternal(UpgradeInstanceInternalRequest request, CallOptions options)

Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.

Parameters
Name Description
request UpgradeInstanceInternalRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpgradeInstanceInternal(UpgradeInstanceInternalRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpgradeInstanceInternal(UpgradeInstanceInternalRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.

Parameters
Name Description
request UpgradeInstanceInternalRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest request, CallOptions options)

Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.

Parameters
Name Description
request UpgradeInstanceInternalRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.

Parameters
Name Description
request UpgradeInstanceInternalRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.