Class ManagedNotebookService.ManagedNotebookServiceClient

public class ManagedNotebookServiceClient : ClientBase<ManagedNotebookService.ManagedNotebookServiceClient>

Client for ManagedNotebookService

Inheritance

Object > ClientBase > ClientBase<ManagedNotebookService.ManagedNotebookServiceClient> > 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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

ManagedNotebookServiceClient(ChannelBase)

public ManagedNotebookServiceClient(ChannelBase channel)

Creates a new client for ManagedNotebookService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

ManagedNotebookServiceClient(ClientBase.ClientBaseConfiguration)

protected ManagedNotebookServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

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.

CreateRuntime(CreateRuntimeRequest, CallOptions)

public virtual Operation CreateRuntime(CreateRuntimeRequest request, CallOptions options)

Creates a new Runtime in a given project and location.

Parameters
NameDescription
requestCreateRuntimeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateRuntime(CreateRuntimeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a new Runtime in a given project and location.

Parameters
NameDescription
requestCreateRuntimeRequest

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.

CreateRuntimeAsync(CreateRuntimeRequest, CallOptions)

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

Creates a new Runtime in a given project and location.

Parameters
NameDescription
requestCreateRuntimeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateRuntimeAsync(CreateRuntimeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a new Runtime in a given project and location.

Parameters
NameDescription
requestCreateRuntimeRequest

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.

DeleteRuntime(DeleteRuntimeRequest, CallOptions)

public virtual Operation DeleteRuntime(DeleteRuntimeRequest request, CallOptions options)

Deletes a single Runtime.

Parameters
NameDescription
requestDeleteRuntimeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteRuntime(DeleteRuntimeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a single Runtime.

Parameters
NameDescription
requestDeleteRuntimeRequest

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.

DeleteRuntimeAsync(DeleteRuntimeRequest, CallOptions)

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

Deletes a single Runtime.

Parameters
NameDescription
requestDeleteRuntimeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteRuntimeAsync(DeleteRuntimeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a single Runtime.

Parameters
NameDescription
requestDeleteRuntimeRequest

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.

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Runtime

The response received from the server.

GetRuntime(GetRuntimeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestGetRuntimeRequest

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Runtime>

The call object.

GetRuntimeAsync(GetRuntimeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestGetRuntimeRequest

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<Runtime>

The call object.

ListRuntimes(ListRuntimesRequest, CallOptions)

public virtual ListRuntimesResponse ListRuntimes(ListRuntimesRequest request, CallOptions options)

Lists Runtimes in a given project and location.

Parameters
NameDescription
requestListRuntimesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListRuntimesResponse

The response received from the server.

ListRuntimes(ListRuntimesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists Runtimes in a given project and location.

Parameters
NameDescription
requestListRuntimesRequest

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListRuntimesResponse>

The call object.

ListRuntimesAsync(ListRuntimesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists Runtimes in a given project and location.

Parameters
NameDescription
requestListRuntimesRequest

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<ListRuntimesResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

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

ReportRuntimeEvent(ReportRuntimeEventRequest, CallOptions)

public virtual Operation ReportRuntimeEvent(ReportRuntimeEventRequest request, CallOptions options)

Report and process a runtime event.

Parameters
NameDescription
requestReportRuntimeEventRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ReportRuntimeEvent(ReportRuntimeEventRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Report and process a runtime event.

Parameters
NameDescription
requestReportRuntimeEventRequest

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.

ReportRuntimeEventAsync(ReportRuntimeEventRequest, CallOptions)

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

Report and process a runtime event.

Parameters
NameDescription
requestReportRuntimeEventRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ReportRuntimeEventAsync(ReportRuntimeEventRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Report and process a runtime event.

Parameters
NameDescription
requestReportRuntimeEventRequest

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.

ResetRuntime(ResetRuntimeRequest, CallOptions)

public virtual Operation ResetRuntime(ResetRuntimeRequest request, CallOptions options)

Resets a Managed Notebook Runtime.

Parameters
NameDescription
requestResetRuntimeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ResetRuntime(ResetRuntimeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Resets a Managed Notebook Runtime.

Parameters
NameDescription
requestResetRuntimeRequest

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.

ResetRuntimeAsync(ResetRuntimeRequest, CallOptions)

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

Resets a Managed Notebook Runtime.

Parameters
NameDescription
requestResetRuntimeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ResetRuntimeAsync(ResetRuntimeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Resets a Managed Notebook Runtime.

Parameters
NameDescription
requestResetRuntimeRequest

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.

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

StartRuntime(StartRuntimeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

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.

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StartRuntimeAsync(StartRuntimeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

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.

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

StopRuntime(StopRuntimeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

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.

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StopRuntimeAsync(StopRuntimeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

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.

SwitchRuntime(SwitchRuntimeRequest, CallOptions)

public virtual Operation SwitchRuntime(SwitchRuntimeRequest request, CallOptions options)

Switch a Managed Notebook Runtime.

Parameters
NameDescription
requestSwitchRuntimeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SwitchRuntime(SwitchRuntimeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Switch a Managed Notebook Runtime.

Parameters
NameDescription
requestSwitchRuntimeRequest

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.

SwitchRuntimeAsync(SwitchRuntimeRequest, CallOptions)

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

Switch a Managed Notebook Runtime.

Parameters
NameDescription
requestSwitchRuntimeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SwitchRuntimeAsync(SwitchRuntimeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Switch a Managed Notebook Runtime.

Parameters
NameDescription
requestSwitchRuntimeRequest

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.