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

public class 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 > ClientBase<NotebookService.NotebookServiceClient> > 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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

NotebookServiceClient(ChannelBase)

public NotebookServiceClient(ChannelBase channel)

Creates a new client for NotebookService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

NotebookServiceClient(ClientBase.ClientBaseConfiguration)

protected NotebookServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateEnvironment(CreateEnvironmentRequest, CallOptions)

public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, CallOptions options)

Creates a new Environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateEnvironment(CreateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a new Environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateEnvironmentAsync(CreateEnvironmentRequest, CallOptions)

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

Creates a new Environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateEnvironmentAsync(CreateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a new Environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

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
NameDescription
requestCreateExecutionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateExecution(CreateExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a new Execution in a given project and location.

Parameters
NameDescription
requestCreateExecutionRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestCreateExecutionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateExecutionAsync(CreateExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a new Execution in a given project and location.

Parameters
NameDescription
requestCreateExecutionRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateInstance(CreateInstanceRequest, CallOptions)

public virtual Operation CreateInstance(CreateInstanceRequest request, CallOptions options)

Creates a new Instance in a given project and location.

Parameters
NameDescription
requestCreateInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateInstance(CreateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a new Instance in a given project and location.

Parameters
NameDescription
requestCreateInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestCreateInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateInstanceAsync(CreateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a new Instance in a given project and location.

Parameters
NameDescription
requestCreateInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

Returns
TypeDescription
Operations.OperationsClient

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
NameDescription
requestCreateScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateSchedule(CreateScheduleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestCreateScheduleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestCreateScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateScheduleAsync(CreateScheduleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestCreateScheduleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteEnvironment(DeleteEnvironmentRequest, CallOptions)

public virtual Operation DeleteEnvironment(DeleteEnvironmentRequest request, CallOptions options)

Deletes a single Environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteEnvironment(DeleteEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a single Environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallOptions)

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

Deletes a single Environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a single Environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteExecution(DeleteExecutionRequest, CallOptions)

public virtual Operation DeleteExecution(DeleteExecutionRequest request, CallOptions options)

Deletes execution

Parameters
NameDescription
requestDeleteExecutionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteExecution(DeleteExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes execution

Parameters
NameDescription
requestDeleteExecutionRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteExecutionAsync(DeleteExecutionRequest, CallOptions)

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

Deletes execution

Parameters
NameDescription
requestDeleteExecutionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteExecutionAsync(DeleteExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes execution

Parameters
NameDescription
requestDeleteExecutionRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteInstance(DeleteInstanceRequest, CallOptions)

public virtual Operation DeleteInstance(DeleteInstanceRequest request, CallOptions options)

Deletes a single Instance.

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteInstance(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a single Instance.

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteInstanceAsync(DeleteInstanceRequest, CallOptions)

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

Deletes a single Instance.

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteInstanceAsync(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a single Instance.

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteSchedule(DeleteScheduleRequest, CallOptions)

public virtual Operation DeleteSchedule(DeleteScheduleRequest request, CallOptions options)

Deletes schedule and all underlying jobs

Parameters
NameDescription
requestDeleteScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteSchedule(DeleteScheduleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes schedule and all underlying jobs

Parameters
NameDescription
requestDeleteScheduleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestDeleteScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteScheduleAsync(DeleteScheduleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes schedule and all underlying jobs

Parameters
NameDescription
requestDeleteScheduleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

GetEnvironment(GetEnvironmentRequest, CallOptions)

public virtual Environment GetEnvironment(GetEnvironmentRequest request, CallOptions options)

Gets details of a single Environment.

Parameters
NameDescription
requestGetEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Environment

The response received from the server.

GetEnvironment(GetEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets details of a single Environment.

Parameters
NameDescription
requestGetEnvironmentRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestGetEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Environment>

The call object.

GetEnvironmentAsync(GetEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets details of a single Environment.

Parameters
NameDescription
requestGetEnvironmentRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Environment>

The call object.

GetExecution(GetExecutionRequest, CallOptions)

public virtual Execution GetExecution(GetExecutionRequest request, CallOptions options)

Gets details of executions

Parameters
NameDescription
requestGetExecutionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Execution

The response received from the server.

GetExecution(GetExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets details of executions

Parameters
NameDescription
requestGetExecutionRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Execution

The response received from the server.

GetExecutionAsync(GetExecutionRequest, CallOptions)

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

Gets details of executions

Parameters
NameDescription
requestGetExecutionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Execution>

The call object.

GetExecutionAsync(GetExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets details of executions

Parameters
NameDescription
requestGetExecutionRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Execution>

The call object.

GetInstance(GetInstanceRequest, CallOptions)

public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)

Gets details of a single Instance.

Parameters
NameDescription
requestGetInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Instance

The response received from the server.

GetInstance(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets details of a single Instance.

Parameters
NameDescription
requestGetInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestGetInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Instance>

The call object.

GetInstanceAsync(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets details of a single Instance.

Parameters
NameDescription
requestGetInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Instance>

The call object.

GetInstanceHealth(GetInstanceHealthRequest, CallOptions)

public virtual GetInstanceHealthResponse GetInstanceHealth(GetInstanceHealthRequest request, CallOptions options)

Check if a notebook instance is healthy.

Parameters
NameDescription
requestGetInstanceHealthRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
GetInstanceHealthResponse

The response received from the server.

GetInstanceHealth(GetInstanceHealthRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Check if a notebook instance is healthy.

Parameters
NameDescription
requestGetInstanceHealthRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestGetInstanceHealthRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<GetInstanceHealthResponse>

The call object.

GetInstanceHealthAsync(GetInstanceHealthRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Check if a notebook instance is healthy.

Parameters
NameDescription
requestGetInstanceHealthRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<GetInstanceHealthResponse>

The call object.

GetSchedule(GetScheduleRequest, CallOptions)

public virtual Schedule GetSchedule(GetScheduleRequest request, CallOptions options)

Gets details of schedule

Parameters
NameDescription
requestGetScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Schedule

The response received from the server.

GetSchedule(GetScheduleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets details of schedule

Parameters
NameDescription
requestGetScheduleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Schedule

The response received from the server.

GetScheduleAsync(GetScheduleRequest, CallOptions)

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

Gets details of schedule

Parameters
NameDescription
requestGetScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Schedule>

The call object.

GetScheduleAsync(GetScheduleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets details of schedule

Parameters
NameDescription
requestGetScheduleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Schedule>

The call object.

IsInstanceUpgradeable(IsInstanceUpgradeableRequest, CallOptions)

public virtual IsInstanceUpgradeableResponse IsInstanceUpgradeable(IsInstanceUpgradeableRequest request, CallOptions options)

Check if a notebook instance is upgradable.

Parameters
NameDescription
requestIsInstanceUpgradeableRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
IsInstanceUpgradeableResponse

The response received from the server.

IsInstanceUpgradeable(IsInstanceUpgradeableRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Check if a notebook instance is upgradable.

Parameters
NameDescription
requestIsInstanceUpgradeableRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestIsInstanceUpgradeableRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<IsInstanceUpgradeableResponse>

The call object.

IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Check if a notebook instance is upgradable.

Parameters
NameDescription
requestIsInstanceUpgradeableRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<IsInstanceUpgradeableResponse>

The call object.

ListEnvironments(ListEnvironmentsRequest, CallOptions)

public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, CallOptions options)

Lists environments in a project.

Parameters
NameDescription
requestListEnvironmentsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListEnvironmentsResponse

The response received from the server.

ListEnvironments(ListEnvironmentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists environments in a project.

Parameters
NameDescription
requestListEnvironmentsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListEnvironmentsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListEnvironmentsResponse>

The call object.

ListEnvironmentsAsync(ListEnvironmentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists environments in a project.

Parameters
NameDescription
requestListEnvironmentsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListEnvironmentsResponse>

The call object.

ListExecutions(ListExecutionsRequest, CallOptions)

public virtual ListExecutionsResponse ListExecutions(ListExecutionsRequest request, CallOptions options)

Lists executions in a given project and location

Parameters
NameDescription
requestListExecutionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListExecutionsResponse

The response received from the server.

ListExecutions(ListExecutionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists executions in a given project and location

Parameters
NameDescription
requestListExecutionsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListExecutionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListExecutionsResponse>

The call object.

ListExecutionsAsync(ListExecutionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists executions in a given project and location

Parameters
NameDescription
requestListExecutionsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListExecutionsResponse>

The call object.

ListInstances(ListInstancesRequest, CallOptions)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, CallOptions options)

Lists instances in a given project and location.

Parameters
NameDescription
requestListInstancesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListInstancesResponse

The response received from the server.

ListInstances(ListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists instances in a given project and location.

Parameters
NameDescription
requestListInstancesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListInstancesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListInstancesResponse>

The call object.

ListInstancesAsync(ListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists instances in a given project and location.

Parameters
NameDescription
requestListInstancesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListInstancesResponse>

The call object.

ListSchedules(ListSchedulesRequest, CallOptions)

public virtual ListSchedulesResponse ListSchedules(ListSchedulesRequest request, CallOptions options)

Lists schedules in a given project and location.

Parameters
NameDescription
requestListSchedulesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListSchedulesResponse

The response received from the server.

ListSchedules(ListSchedulesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists schedules in a given project and location.

Parameters
NameDescription
requestListSchedulesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListSchedulesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListSchedulesResponse>

The call object.

ListSchedulesAsync(ListSchedulesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists schedules in a given project and location.

Parameters
NameDescription
requestListSchedulesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListSchedulesResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
NotebookService.NotebookServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Notebooks.V1.NotebookService.NotebookServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

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
NameDescription
requestRegisterInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RegisterInstance(RegisterInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestRegisterInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestRegisterInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

RegisterInstanceAsync(RegisterInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestRegisterInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

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
NameDescription
requestReportInstanceInfoRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ReportInstanceInfo(ReportInstanceInfoRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestReportInstanceInfoRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestReportInstanceInfoRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ReportInstanceInfoAsync(ReportInstanceInfoRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestReportInstanceInfoRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ResetInstance(ResetInstanceRequest, CallOptions)

public virtual Operation ResetInstance(ResetInstanceRequest request, CallOptions options)

Resets a notebook instance.

Parameters
NameDescription
requestResetInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ResetInstance(ResetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Resets a notebook instance.

Parameters
NameDescription
requestResetInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ResetInstanceAsync(ResetInstanceRequest, CallOptions)

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

Resets a notebook instance.

Parameters
NameDescription
requestResetInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ResetInstanceAsync(ResetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Resets a notebook instance.

Parameters
NameDescription
requestResetInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

RollbackInstance(RollbackInstanceRequest, CallOptions)

public virtual Operation RollbackInstance(RollbackInstanceRequest request, CallOptions options)

Rollbacks a notebook instance to the previous version.

Parameters
NameDescription
requestRollbackInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RollbackInstance(RollbackInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Rollbacks a notebook instance to the previous version.

Parameters
NameDescription
requestRollbackInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestRollbackInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

RollbackInstanceAsync(RollbackInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Rollbacks a notebook instance to the previous version.

Parameters
NameDescription
requestRollbackInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetInstanceAccelerator(SetInstanceAcceleratorRequest, CallOptions)

public virtual Operation SetInstanceAccelerator(SetInstanceAcceleratorRequest request, CallOptions options)

Updates the guest accelerators of a single Instance.

Parameters
NameDescription
requestSetInstanceAcceleratorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetInstanceAccelerator(SetInstanceAcceleratorRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the guest accelerators of a single Instance.

Parameters
NameDescription
requestSetInstanceAcceleratorRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestSetInstanceAcceleratorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the guest accelerators of a single Instance.

Parameters
NameDescription
requestSetInstanceAcceleratorRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetInstanceLabels(SetInstanceLabelsRequest, CallOptions)

public virtual Operation SetInstanceLabels(SetInstanceLabelsRequest request, CallOptions options)

Replaces all the labels of an Instance.

Parameters
NameDescription
requestSetInstanceLabelsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetInstanceLabels(SetInstanceLabelsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Replaces all the labels of an Instance.

Parameters
NameDescription
requestSetInstanceLabelsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestSetInstanceLabelsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetInstanceLabelsAsync(SetInstanceLabelsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Replaces all the labels of an Instance.

Parameters
NameDescription
requestSetInstanceLabelsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetInstanceMachineType(SetInstanceMachineTypeRequest, CallOptions)

public virtual Operation SetInstanceMachineType(SetInstanceMachineTypeRequest request, CallOptions options)

Updates the machine type of a single Instance.

Parameters
NameDescription
requestSetInstanceMachineTypeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetInstanceMachineType(SetInstanceMachineTypeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the machine type of a single Instance.

Parameters
NameDescription
requestSetInstanceMachineTypeRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestSetInstanceMachineTypeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the machine type of a single Instance.

Parameters
NameDescription
requestSetInstanceMachineTypeRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StartInstance(StartInstanceRequest, CallOptions)

public virtual Operation StartInstance(StartInstanceRequest request, CallOptions options)

Starts a notebook instance.

Parameters
NameDescription
requestStartInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

StartInstance(StartInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Starts a notebook instance.

Parameters
NameDescription
requestStartInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

StartInstanceAsync(StartInstanceRequest, CallOptions)

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

Starts a notebook instance.

Parameters
NameDescription
requestStartInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StartInstanceAsync(StartInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Starts a notebook instance.

Parameters
NameDescription
requestStartInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StopInstance(StopInstanceRequest, CallOptions)

public virtual Operation StopInstance(StopInstanceRequest request, CallOptions options)

Stops a notebook instance.

Parameters
NameDescription
requestStopInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

StopInstance(StopInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Stops a notebook instance.

Parameters
NameDescription
requestStopInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

StopInstanceAsync(StopInstanceRequest, CallOptions)

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

Stops a notebook instance.

Parameters
NameDescription
requestStopInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StopInstanceAsync(StopInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Stops a notebook instance.

Parameters
NameDescription
requestStopInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

TriggerSchedule(TriggerScheduleRequest, CallOptions)

public virtual Operation TriggerSchedule(TriggerScheduleRequest request, CallOptions options)

Triggers execution of an existing schedule.

Parameters
NameDescription
requestTriggerScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

TriggerSchedule(TriggerScheduleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Triggers execution of an existing schedule.

Parameters
NameDescription
requestTriggerScheduleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestTriggerScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

TriggerScheduleAsync(TriggerScheduleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Triggers execution of an existing schedule.

Parameters
NameDescription
requestTriggerScheduleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateInstanceConfig(UpdateInstanceConfigRequest, CallOptions)

public virtual Operation UpdateInstanceConfig(UpdateInstanceConfigRequest request, CallOptions options)

Update Notebook Instance configurations.

Parameters
NameDescription
requestUpdateInstanceConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateInstanceConfig(UpdateInstanceConfigRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Update Notebook Instance configurations.

Parameters
NameDescription
requestUpdateInstanceConfigRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateInstanceConfigAsync(UpdateInstanceConfigRequest, CallOptions)

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

Update Notebook Instance configurations.

Parameters
NameDescription
requestUpdateInstanceConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateInstanceConfigAsync(UpdateInstanceConfigRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Update Notebook Instance configurations.

Parameters
NameDescription
requestUpdateInstanceConfigRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest, CallOptions)

public virtual UpdateInstanceMetadataItemsResponse UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request, CallOptions options)

Add/update metadata items for an instance.

Parameters
NameDescription
requestUpdateInstanceMetadataItemsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
UpdateInstanceMetadataItemsResponse

The response received from the server.

UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Add/update metadata items for an instance.

Parameters
NameDescription
requestUpdateInstanceMetadataItemsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestUpdateInstanceMetadataItemsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<UpdateInstanceMetadataItemsResponse>

The call object.

UpdateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Add/update metadata items for an instance.

Parameters
NameDescription
requestUpdateInstanceMetadataItemsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<UpdateInstanceMetadataItemsResponse>

The call object.

UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest, CallOptions)

public virtual Operation UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request, CallOptions options)

Updates the Shielded instance configuration of a single Instance.

Parameters
NameDescription
requestUpdateShieldedInstanceConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the Shielded instance configuration of a single Instance.

Parameters
NameDescription
requestUpdateShieldedInstanceConfigRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestUpdateShieldedInstanceConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the Shielded instance configuration of a single Instance.

Parameters
NameDescription
requestUpdateShieldedInstanceConfigRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpgradeInstance(UpgradeInstanceRequest, CallOptions)

public virtual Operation UpgradeInstance(UpgradeInstanceRequest request, CallOptions options)

Upgrades a notebook instance to the latest version.

Parameters
NameDescription
requestUpgradeInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpgradeInstance(UpgradeInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Upgrades a notebook instance to the latest version.

Parameters
NameDescription
requestUpgradeInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestUpgradeInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpgradeInstanceAsync(UpgradeInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Upgrades a notebook instance to the latest version.

Parameters
NameDescription
requestUpgradeInstanceRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

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
NameDescription
requestUpgradeInstanceInternalRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpgradeInstanceInternal(UpgradeInstanceInternalRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestUpgradeInstanceInternalRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestUpgradeInstanceInternalRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestUpgradeInstanceInternalRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.