AI Platform Notebooks v1 API - Class ManagedNotebookService.ManagedNotebookServiceClient (2.5.0)

public class ManagedNotebookService.ManagedNotebookServiceClient : ClientBase<ManagedNotebookService.ManagedNotebookServiceClient>

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

Client for ManagedNotebookService

Inheritance

object > ClientBase > ClientBaseManagedNotebookServiceManagedNotebookServiceClient > ManagedNotebookService.ManagedNotebookServiceClient

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Constructors

ManagedNotebookServiceClient()

protected ManagedNotebookServiceClient()

Protected parameterless constructor to allow creation of test doubles.

ManagedNotebookServiceClient(CallInvoker)

public ManagedNotebookServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

ManagedNotebookServiceClient(ChannelBase)

public ManagedNotebookServiceClient(ChannelBase channel)

Creates a new client for ManagedNotebookService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

ManagedNotebookServiceClient(ClientBaseConfiguration)

protected ManagedNotebookServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

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.

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.

CreateRuntime(CreateRuntimeRequest, CallOptions)

public virtual Operation CreateRuntime(CreateRuntimeRequest request, CallOptions options)

Creates a new Runtime in a given project and location.

Parameters
Name Description
request CreateRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateRuntime(CreateRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Runtime in a given project and location.

Parameters
Name Description
request CreateRuntimeRequest

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.

CreateRuntimeAsync(CreateRuntimeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateRuntimeAsync(CreateRuntimeRequest request, CallOptions options)

Creates a new Runtime in a given project and location.

Parameters
Name Description
request CreateRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateRuntimeAsync(CreateRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Runtime in a given project and location.

Parameters
Name Description
request CreateRuntimeRequest

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.

DeleteRuntime(DeleteRuntimeRequest, CallOptions)

public virtual Operation DeleteRuntime(DeleteRuntimeRequest request, CallOptions options)

Deletes a single Runtime.

Parameters
Name Description
request DeleteRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteRuntime(DeleteRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single Runtime.

Parameters
Name Description
request DeleteRuntimeRequest

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.

DeleteRuntimeAsync(DeleteRuntimeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteRuntimeAsync(DeleteRuntimeRequest request, CallOptions options)

Deletes a single Runtime.

Parameters
Name Description
request DeleteRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteRuntimeAsync(DeleteRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single Runtime.

Parameters
Name Description
request DeleteRuntimeRequest

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.

DiagnoseRuntime(DiagnoseRuntimeRequest, CallOptions)

public virtual Operation DiagnoseRuntime(DiagnoseRuntimeRequest request, CallOptions options)

Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.

Parameters
Name Description
request DiagnoseRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DiagnoseRuntime(DiagnoseRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.

Parameters
Name Description
request DiagnoseRuntimeRequest

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.

DiagnoseRuntimeAsync(DiagnoseRuntimeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DiagnoseRuntimeAsync(DiagnoseRuntimeRequest request, CallOptions options)

Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.

Parameters
Name Description
request DiagnoseRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DiagnoseRuntimeAsync(DiagnoseRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.

Parameters
Name Description
request DiagnoseRuntimeRequest

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.

GetRuntime(GetRuntimeRequest, CallOptions)

public virtual Runtime GetRuntime(GetRuntimeRequest request, CallOptions options)

Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.

Parameters
Name Description
request GetRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Runtime

The response received from the server.

GetRuntime(GetRuntimeRequest, Metadata, DateTime?, CancellationToken)

public virtual Runtime GetRuntime(GetRuntimeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.

Parameters
Name Description
request GetRuntimeRequest

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
Runtime

The response received from the server.

GetRuntimeAsync(GetRuntimeRequest, CallOptions)

public virtual AsyncUnaryCall<Runtime> GetRuntimeAsync(GetRuntimeRequest request, CallOptions options)

Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.

Parameters
Name Description
request GetRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRuntime

The call object.

GetRuntimeAsync(GetRuntimeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Runtime> GetRuntimeAsync(GetRuntimeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.

Parameters
Name Description
request GetRuntimeRequest

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
AsyncUnaryCallRuntime

The call object.

ListRuntimes(ListRuntimesRequest, CallOptions)

public virtual ListRuntimesResponse ListRuntimes(ListRuntimesRequest request, CallOptions options)

Lists Runtimes in a given project and location.

Parameters
Name Description
request ListRuntimesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListRuntimesResponse

The response received from the server.

ListRuntimes(ListRuntimesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListRuntimesResponse ListRuntimes(ListRuntimesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Runtimes in a given project and location.

Parameters
Name Description
request ListRuntimesRequest

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
ListRuntimesResponse

The response received from the server.

ListRuntimesAsync(ListRuntimesRequest, CallOptions)

public virtual AsyncUnaryCall<ListRuntimesResponse> ListRuntimesAsync(ListRuntimesRequest request, CallOptions options)

Lists Runtimes in a given project and location.

Parameters
Name Description
request ListRuntimesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListRuntimesResponse

The call object.

ListRuntimesAsync(ListRuntimesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListRuntimesResponse> ListRuntimesAsync(ListRuntimesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Runtimes in a given project and location.

Parameters
Name Description
request ListRuntimesRequest

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
AsyncUnaryCallListRuntimesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override ManagedNotebookService.ManagedNotebookServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
ManagedNotebookServiceManagedNotebookServiceClient
Overrides

RefreshRuntimeTokenInternal(RefreshRuntimeTokenInternalRequest, CallOptions)

public virtual RefreshRuntimeTokenInternalResponse RefreshRuntimeTokenInternal(RefreshRuntimeTokenInternalRequest request, CallOptions options)

Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.

Parameters
Name Description
request RefreshRuntimeTokenInternalRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
RefreshRuntimeTokenInternalResponse

The response received from the server.

RefreshRuntimeTokenInternal(RefreshRuntimeTokenInternalRequest, Metadata, DateTime?, CancellationToken)

public virtual RefreshRuntimeTokenInternalResponse RefreshRuntimeTokenInternal(RefreshRuntimeTokenInternalRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.

Parameters
Name Description
request RefreshRuntimeTokenInternalRequest

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
RefreshRuntimeTokenInternalResponse

The response received from the server.

RefreshRuntimeTokenInternalAsync(RefreshRuntimeTokenInternalRequest, CallOptions)

public virtual AsyncUnaryCall<RefreshRuntimeTokenInternalResponse> RefreshRuntimeTokenInternalAsync(RefreshRuntimeTokenInternalRequest request, CallOptions options)

Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.

Parameters
Name Description
request RefreshRuntimeTokenInternalRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRefreshRuntimeTokenInternalResponse

The call object.

RefreshRuntimeTokenInternalAsync(RefreshRuntimeTokenInternalRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RefreshRuntimeTokenInternalResponse> RefreshRuntimeTokenInternalAsync(RefreshRuntimeTokenInternalRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.

Parameters
Name Description
request RefreshRuntimeTokenInternalRequest

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
AsyncUnaryCallRefreshRuntimeTokenInternalResponse

The call object.

ReportRuntimeEvent(ReportRuntimeEventRequest, CallOptions)

public virtual Operation ReportRuntimeEvent(ReportRuntimeEventRequest request, CallOptions options)

Report and process a runtime event.

Parameters
Name Description
request ReportRuntimeEventRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

ReportRuntimeEvent(ReportRuntimeEventRequest, Metadata, DateTime?, CancellationToken)

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

Report and process a runtime event.

Parameters
Name Description
request ReportRuntimeEventRequest

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.

ReportRuntimeEventAsync(ReportRuntimeEventRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ReportRuntimeEventAsync(ReportRuntimeEventRequest request, CallOptions options)

Report and process a runtime event.

Parameters
Name Description
request ReportRuntimeEventRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

ReportRuntimeEventAsync(ReportRuntimeEventRequest, Metadata, DateTime?, CancellationToken)

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

Report and process a runtime event.

Parameters
Name Description
request ReportRuntimeEventRequest

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.

ResetRuntime(ResetRuntimeRequest, CallOptions)

public virtual Operation ResetRuntime(ResetRuntimeRequest request, CallOptions options)

Resets a Managed Notebook Runtime.

Parameters
Name Description
request ResetRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

ResetRuntime(ResetRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Resets a Managed Notebook Runtime.

Parameters
Name Description
request ResetRuntimeRequest

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.

ResetRuntimeAsync(ResetRuntimeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ResetRuntimeAsync(ResetRuntimeRequest request, CallOptions options)

Resets a Managed Notebook Runtime.

Parameters
Name Description
request ResetRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

ResetRuntimeAsync(ResetRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Resets a Managed Notebook Runtime.

Parameters
Name Description
request ResetRuntimeRequest

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.

StartRuntime(StartRuntimeRequest, CallOptions)

public virtual Operation StartRuntime(StartRuntimeRequest request, CallOptions options)

Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Parameters
Name Description
request StartRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

StartRuntime(StartRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Parameters
Name Description
request StartRuntimeRequest

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.

StartRuntimeAsync(StartRuntimeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StartRuntimeAsync(StartRuntimeRequest request, CallOptions options)

Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Parameters
Name Description
request StartRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

StartRuntimeAsync(StartRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Parameters
Name Description
request StartRuntimeRequest

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.

StopRuntime(StopRuntimeRequest, CallOptions)

public virtual Operation StopRuntime(StopRuntimeRequest request, CallOptions options)

Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Parameters
Name Description
request StopRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

StopRuntime(StopRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Parameters
Name Description
request StopRuntimeRequest

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.

StopRuntimeAsync(StopRuntimeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StopRuntimeAsync(StopRuntimeRequest request, CallOptions options)

Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Parameters
Name Description
request StopRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

StopRuntimeAsync(StopRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Parameters
Name Description
request StopRuntimeRequest

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.

SwitchRuntime(SwitchRuntimeRequest, CallOptions)

public virtual Operation SwitchRuntime(SwitchRuntimeRequest request, CallOptions options)

Switch a Managed Notebook Runtime.

Parameters
Name Description
request SwitchRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

SwitchRuntime(SwitchRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Switch a Managed Notebook Runtime.

Parameters
Name Description
request SwitchRuntimeRequest

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.

SwitchRuntimeAsync(SwitchRuntimeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SwitchRuntimeAsync(SwitchRuntimeRequest request, CallOptions options)

Switch a Managed Notebook Runtime.

Parameters
Name Description
request SwitchRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

SwitchRuntimeAsync(SwitchRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Switch a Managed Notebook Runtime.

Parameters
Name Description
request SwitchRuntimeRequest

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.

UpdateRuntime(UpdateRuntimeRequest, CallOptions)

public virtual Operation UpdateRuntime(UpdateRuntimeRequest request, CallOptions options)

Update Notebook Runtime configuration.

Parameters
Name Description
request UpdateRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateRuntime(UpdateRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Update Notebook Runtime configuration.

Parameters
Name Description
request UpdateRuntimeRequest

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.

UpdateRuntimeAsync(UpdateRuntimeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateRuntimeAsync(UpdateRuntimeRequest request, CallOptions options)

Update Notebook Runtime configuration.

Parameters
Name Description
request UpdateRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateRuntimeAsync(UpdateRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Update Notebook Runtime configuration.

Parameters
Name Description
request UpdateRuntimeRequest

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.

UpgradeRuntime(UpgradeRuntimeRequest, CallOptions)

public virtual Operation UpgradeRuntime(UpgradeRuntimeRequest request, CallOptions options)

Upgrades a Managed Notebook Runtime to the latest version.

Parameters
Name Description
request UpgradeRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpgradeRuntime(UpgradeRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Upgrades a Managed Notebook Runtime to the latest version.

Parameters
Name Description
request UpgradeRuntimeRequest

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.

UpgradeRuntimeAsync(UpgradeRuntimeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpgradeRuntimeAsync(UpgradeRuntimeRequest request, CallOptions options)

Upgrades a Managed Notebook Runtime to the latest version.

Parameters
Name Description
request UpgradeRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpgradeRuntimeAsync(UpgradeRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Upgrades a Managed Notebook Runtime to the latest version.

Parameters
Name Description
request UpgradeRuntimeRequest

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.