AI Platform Notebooks v1 API - Class ManagedNotebookServiceClientImpl (2.0.0)

public sealed class ManagedNotebookServiceClientImpl : ManagedNotebookServiceClient

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

ManagedNotebookService client wrapper implementation, for convenient use.

Inheritance

Object > ManagedNotebookServiceClient > ManagedNotebookServiceClientImpl

Inherited Members

ManagedNotebookServiceClient.DefaultEndpoint

ManagedNotebookServiceClient.DefaultScopes

ManagedNotebookServiceClient.ServiceMetadata

ManagedNotebookServiceClient.CreateAsync(CancellationToken)

ManagedNotebookServiceClient.Create()

ManagedNotebookServiceClient.ShutdownDefaultChannelsAsync()

ManagedNotebookServiceClient.ListRuntimes(String, String, Nullable<Int32>, CallSettings)

ManagedNotebookServiceClient.ListRuntimesAsync(String, String, Nullable<Int32>, CallSettings)

ManagedNotebookServiceClient.ListRuntimes(LocationName, String, Nullable<Int32>, CallSettings)

ManagedNotebookServiceClient.ListRuntimesAsync(LocationName, String, Nullable<Int32>, CallSettings)

ManagedNotebookServiceClient.GetRuntimeAsync(GetRuntimeRequest, CancellationToken)

ManagedNotebookServiceClient.GetRuntime(String, CallSettings)

ManagedNotebookServiceClient.GetRuntimeAsync(String, CallSettings)

ManagedNotebookServiceClient.GetRuntimeAsync(String, CancellationToken)

ManagedNotebookServiceClient.GetRuntime(RuntimeName, CallSettings)

ManagedNotebookServiceClient.GetRuntimeAsync(RuntimeName, CallSettings)

ManagedNotebookServiceClient.GetRuntimeAsync(RuntimeName, CancellationToken)

ManagedNotebookServiceClient.CreateRuntimeAsync(CreateRuntimeRequest, CancellationToken)

ManagedNotebookServiceClient.PollOnceCreateRuntime(String, CallSettings)

ManagedNotebookServiceClient.PollOnceCreateRuntimeAsync(String, CallSettings)

ManagedNotebookServiceClient.CreateRuntime(String, String, Runtime, CallSettings)

ManagedNotebookServiceClient.CreateRuntimeAsync(String, String, Runtime, CallSettings)

ManagedNotebookServiceClient.CreateRuntimeAsync(String, String, Runtime, CancellationToken)

ManagedNotebookServiceClient.CreateRuntime(RuntimeName, String, Runtime, CallSettings)

ManagedNotebookServiceClient.CreateRuntimeAsync(RuntimeName, String, Runtime, CallSettings)

ManagedNotebookServiceClient.CreateRuntimeAsync(RuntimeName, String, Runtime, CancellationToken)

ManagedNotebookServiceClient.DeleteRuntimeAsync(DeleteRuntimeRequest, CancellationToken)

ManagedNotebookServiceClient.PollOnceDeleteRuntime(String, CallSettings)

ManagedNotebookServiceClient.PollOnceDeleteRuntimeAsync(String, CallSettings)

ManagedNotebookServiceClient.DeleteRuntime(String, CallSettings)

ManagedNotebookServiceClient.DeleteRuntimeAsync(String, CallSettings)

ManagedNotebookServiceClient.DeleteRuntimeAsync(String, CancellationToken)

ManagedNotebookServiceClient.DeleteRuntime(RuntimeName, CallSettings)

ManagedNotebookServiceClient.DeleteRuntimeAsync(RuntimeName, CallSettings)

ManagedNotebookServiceClient.DeleteRuntimeAsync(RuntimeName, CancellationToken)

ManagedNotebookServiceClient.StartRuntimeAsync(StartRuntimeRequest, CancellationToken)

ManagedNotebookServiceClient.PollOnceStartRuntime(String, CallSettings)

ManagedNotebookServiceClient.PollOnceStartRuntimeAsync(String, CallSettings)

ManagedNotebookServiceClient.StartRuntime(String, CallSettings)

ManagedNotebookServiceClient.StartRuntimeAsync(String, CallSettings)

ManagedNotebookServiceClient.StartRuntimeAsync(String, CancellationToken)

ManagedNotebookServiceClient.StopRuntimeAsync(StopRuntimeRequest, CancellationToken)

ManagedNotebookServiceClient.PollOnceStopRuntime(String, CallSettings)

ManagedNotebookServiceClient.PollOnceStopRuntimeAsync(String, CallSettings)

ManagedNotebookServiceClient.StopRuntime(String, CallSettings)

ManagedNotebookServiceClient.StopRuntimeAsync(String, CallSettings)

ManagedNotebookServiceClient.StopRuntimeAsync(String, CancellationToken)

ManagedNotebookServiceClient.SwitchRuntimeAsync(SwitchRuntimeRequest, CancellationToken)

ManagedNotebookServiceClient.PollOnceSwitchRuntime(String, CallSettings)

ManagedNotebookServiceClient.PollOnceSwitchRuntimeAsync(String, CallSettings)

ManagedNotebookServiceClient.SwitchRuntime(String, CallSettings)

ManagedNotebookServiceClient.SwitchRuntimeAsync(String, CallSettings)

ManagedNotebookServiceClient.SwitchRuntimeAsync(String, CancellationToken)

ManagedNotebookServiceClient.ResetRuntimeAsync(ResetRuntimeRequest, CancellationToken)

ManagedNotebookServiceClient.PollOnceResetRuntime(String, CallSettings)

ManagedNotebookServiceClient.PollOnceResetRuntimeAsync(String, CallSettings)

ManagedNotebookServiceClient.ResetRuntime(String, CallSettings)

ManagedNotebookServiceClient.ResetRuntimeAsync(String, CallSettings)

ManagedNotebookServiceClient.ResetRuntimeAsync(String, CancellationToken)

ManagedNotebookServiceClient.ReportRuntimeEventAsync(ReportRuntimeEventRequest, CancellationToken)

ManagedNotebookServiceClient.PollOnceReportRuntimeEvent(String, CallSettings)

ManagedNotebookServiceClient.PollOnceReportRuntimeEventAsync(String, CallSettings)

ManagedNotebookServiceClient.ReportRuntimeEvent(String, CallSettings)

ManagedNotebookServiceClient.ReportRuntimeEventAsync(String, CallSettings)

ManagedNotebookServiceClient.ReportRuntimeEventAsync(String, CancellationToken)

ManagedNotebookServiceClient.ReportRuntimeEvent(RuntimeName, CallSettings)

ManagedNotebookServiceClient.ReportRuntimeEventAsync(RuntimeName, CallSettings)

ManagedNotebookServiceClient.ReportRuntimeEventAsync(RuntimeName, CancellationToken)

ManagedNotebookServiceClient.RefreshRuntimeTokenInternalAsync(RefreshRuntimeTokenInternalRequest, CancellationToken)

ManagedNotebookServiceClient.RefreshRuntimeTokenInternal(String, String, CallSettings)

ManagedNotebookServiceClient.RefreshRuntimeTokenInternalAsync(String, String, CallSettings)

ManagedNotebookServiceClient.RefreshRuntimeTokenInternalAsync(String, String, CancellationToken)

ManagedNotebookServiceClient.RefreshRuntimeTokenInternal(RuntimeName, String, CallSettings)

ManagedNotebookServiceClient.RefreshRuntimeTokenInternalAsync(RuntimeName, String, CallSettings)

ManagedNotebookServiceClient.RefreshRuntimeTokenInternalAsync(RuntimeName, String, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Remarks

API v1 service for Managed Notebooks.

Constructors

ManagedNotebookServiceClientImpl(ManagedNotebookService.ManagedNotebookServiceClient, ManagedNotebookServiceSettings, ILogger)

public ManagedNotebookServiceClientImpl(ManagedNotebookService.ManagedNotebookServiceClient grpcClient, ManagedNotebookServiceSettings settings, ILogger logger)

Constructs a client wrapper for the ManagedNotebookService service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`ManagedNotebookService.ManagedNotebookServiceClient` The underlying gRPC client.
`settings`	`ManagedNotebookServiceSettings` The base ManagedNotebookServiceSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

CreateRuntimeOperationsClient

public override OperationsClient CreateRuntimeOperationsClient { get; }

The long-running operations client for CreateRuntime.

Property Value
Type	Description
`OperationsClient`

Overrides

ManagedNotebookServiceClient.CreateRuntimeOperationsClient

DeleteRuntimeOperationsClient

public override OperationsClient DeleteRuntimeOperationsClient { get; }

The long-running operations client for DeleteRuntime.

Property Value
Type	Description
`OperationsClient`

Overrides

ManagedNotebookServiceClient.DeleteRuntimeOperationsClient

GrpcClient

public override ManagedNotebookService.ManagedNotebookServiceClient GrpcClient { get; }

The underlying gRPC ManagedNotebookService client

Property Value
Type	Description
`ManagedNotebookService.ManagedNotebookServiceClient`

Overrides

ManagedNotebookServiceClient.GrpcClient

ReportRuntimeEventOperationsClient

public override OperationsClient ReportRuntimeEventOperationsClient { get; }

The long-running operations client for ReportRuntimeEvent.

Property Value
Type	Description
`OperationsClient`

Overrides

ManagedNotebookServiceClient.ReportRuntimeEventOperationsClient

ResetRuntimeOperationsClient

public override OperationsClient ResetRuntimeOperationsClient { get; }

The long-running operations client for ResetRuntime.

Property Value
Type	Description
`OperationsClient`

Overrides

ManagedNotebookServiceClient.ResetRuntimeOperationsClient

StartRuntimeOperationsClient

public override OperationsClient StartRuntimeOperationsClient { get; }

The long-running operations client for StartRuntime.

Property Value
Type	Description
`OperationsClient`

Overrides

ManagedNotebookServiceClient.StartRuntimeOperationsClient

StopRuntimeOperationsClient

public override OperationsClient StopRuntimeOperationsClient { get; }

The long-running operations client for StopRuntime.

Property Value
Type	Description
`OperationsClient`

Overrides

ManagedNotebookServiceClient.StopRuntimeOperationsClient

SwitchRuntimeOperationsClient

public override OperationsClient SwitchRuntimeOperationsClient { get; }

The long-running operations client for SwitchRuntime.

Property Value
Type	Description
`OperationsClient`

Overrides

ManagedNotebookServiceClient.SwitchRuntimeOperationsClient

Methods

CreateRuntime(CreateRuntimeRequest, CallSettings)

public override Operation<Runtime, OperationMetadata> CreateRuntime(CreateRuntimeRequest request, CallSettings callSettings = null)

Creates a new Runtime in a given project and location.

Parameters
Name	Description
`request`	`CreateRuntimeRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Runtime, OperationMetadata>`	The RPC response.

Overrides

ManagedNotebookServiceClient.CreateRuntime(CreateRuntimeRequest, CallSettings)

CreateRuntimeAsync(CreateRuntimeRequest, CallSettings)

public override async Task<Operation<Runtime, OperationMetadata>> CreateRuntimeAsync(CreateRuntimeRequest request, CallSettings callSettings = null)

Creates a new Runtime in a given project and location.

Parameters
Name	Description
`request`	`CreateRuntimeRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Runtime, OperationMetadata>>`	A Task containing the RPC response.

Overrides

ManagedNotebookServiceClient.CreateRuntimeAsync(CreateRuntimeRequest, CallSettings)

DeleteRuntime(DeleteRuntimeRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteRuntime(DeleteRuntimeRequest request, CallSettings callSettings = null)

Deletes a single Runtime.

Parameters
Name	Description
`request`	`DeleteRuntimeRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Empty, OperationMetadata>`	The RPC response.

Overrides

ManagedNotebookServiceClient.DeleteRuntime(DeleteRuntimeRequest, CallSettings)

DeleteRuntimeAsync(DeleteRuntimeRequest, CallSettings)

public override async Task<Operation<Empty, OperationMetadata>> DeleteRuntimeAsync(DeleteRuntimeRequest request, CallSettings callSettings = null)

Deletes a single Runtime.

Parameters
Name	Description
`request`	`DeleteRuntimeRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Empty, OperationMetadata>>`	A Task containing the RPC response.

Overrides

ManagedNotebookServiceClient.DeleteRuntimeAsync(DeleteRuntimeRequest, CallSettings)

GetRuntime(GetRuntimeRequest, CallSettings)

public override Runtime GetRuntime(GetRuntimeRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`GetRuntimeRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Runtime`	The RPC response.

Overrides

ManagedNotebookServiceClient.GetRuntime(GetRuntimeRequest, CallSettings)

GetRuntimeAsync(GetRuntimeRequest, CallSettings)

public override Task<Runtime> GetRuntimeAsync(GetRuntimeRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`GetRuntimeRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Runtime>`	A Task containing the RPC response.

Overrides

ManagedNotebookServiceClient.GetRuntimeAsync(GetRuntimeRequest, CallSettings)

ListRuntimes(ListRuntimesRequest, CallSettings)

public override PagedEnumerable<ListRuntimesResponse, Runtime> ListRuntimes(ListRuntimesRequest request, CallSettings callSettings = null)

Lists Runtimes in a given project and location.

Parameters
Name	Description
`request`	`ListRuntimesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListRuntimesResponse, Runtime>`	A pageable sequence of Runtime resources.

Overrides

ManagedNotebookServiceClient.ListRuntimes(ListRuntimesRequest, CallSettings)

ListRuntimesAsync(ListRuntimesRequest, CallSettings)

public override PagedAsyncEnumerable<ListRuntimesResponse, Runtime> ListRuntimesAsync(ListRuntimesRequest request, CallSettings callSettings = null)

Lists Runtimes in a given project and location.

Parameters
Name	Description
`request`	`ListRuntimesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListRuntimesResponse, Runtime>`	A pageable asynchronous sequence of Runtime resources.

Overrides

ManagedNotebookServiceClient.ListRuntimesAsync(ListRuntimesRequest, CallSettings)

RefreshRuntimeTokenInternal(RefreshRuntimeTokenInternalRequest, CallSettings)

public override RefreshRuntimeTokenInternalResponse RefreshRuntimeTokenInternal(RefreshRuntimeTokenInternalRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`RefreshRuntimeTokenInternalResponse`	The RPC response.

Overrides

ManagedNotebookServiceClient.RefreshRuntimeTokenInternal(RefreshRuntimeTokenInternalRequest, CallSettings)

RefreshRuntimeTokenInternalAsync(RefreshRuntimeTokenInternalRequest, CallSettings)

public override Task<RefreshRuntimeTokenInternalResponse> RefreshRuntimeTokenInternalAsync(RefreshRuntimeTokenInternalRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<RefreshRuntimeTokenInternalResponse>`	A Task containing the RPC response.

Overrides

ManagedNotebookServiceClient.RefreshRuntimeTokenInternalAsync(RefreshRuntimeTokenInternalRequest, CallSettings)

ReportRuntimeEvent(ReportRuntimeEventRequest, CallSettings)

public override Operation<Runtime, OperationMetadata> ReportRuntimeEvent(ReportRuntimeEventRequest request, CallSettings callSettings = null)

Report and process a runtime event.

Parameters
Name	Description
`request`	`ReportRuntimeEventRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Runtime, OperationMetadata>`	The RPC response.

Overrides

ManagedNotebookServiceClient.ReportRuntimeEvent(ReportRuntimeEventRequest, CallSettings)

ReportRuntimeEventAsync(ReportRuntimeEventRequest, CallSettings)

public override async Task<Operation<Runtime, OperationMetadata>> ReportRuntimeEventAsync(ReportRuntimeEventRequest request, CallSettings callSettings = null)

Report and process a runtime event.

Parameters
Name	Description
`request`	`ReportRuntimeEventRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Runtime, OperationMetadata>>`	A Task containing the RPC response.

Overrides

ManagedNotebookServiceClient.ReportRuntimeEventAsync(ReportRuntimeEventRequest, CallSettings)

ResetRuntime(ResetRuntimeRequest, CallSettings)

public override Operation<Runtime, OperationMetadata> ResetRuntime(ResetRuntimeRequest request, CallSettings callSettings = null)

Resets a Managed Notebook Runtime.

Parameters
Name	Description
`request`	`ResetRuntimeRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Runtime, OperationMetadata>`	The RPC response.

Overrides

ManagedNotebookServiceClient.ResetRuntime(ResetRuntimeRequest, CallSettings)

ResetRuntimeAsync(ResetRuntimeRequest, CallSettings)

public override async Task<Operation<Runtime, OperationMetadata>> ResetRuntimeAsync(ResetRuntimeRequest request, CallSettings callSettings = null)

Resets a Managed Notebook Runtime.

Parameters
Name	Description
`request`	`ResetRuntimeRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Runtime, OperationMetadata>>`	A Task containing the RPC response.

Overrides

ManagedNotebookServiceClient.ResetRuntimeAsync(ResetRuntimeRequest, CallSettings)

StartRuntime(StartRuntimeRequest, CallSettings)

public override Operation<Runtime, OperationMetadata> StartRuntime(StartRuntimeRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Runtime, OperationMetadata>`	The RPC response.

Overrides

ManagedNotebookServiceClient.StartRuntime(StartRuntimeRequest, CallSettings)

StartRuntimeAsync(StartRuntimeRequest, CallSettings)

public override async Task<Operation<Runtime, OperationMetadata>> StartRuntimeAsync(StartRuntimeRequest request, CallSettings callSettings = null)

Parameters
Name	Description
`request`	`StartRuntimeRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Runtime, OperationMetadata>>`	A Task containing the RPC response.

Overrides

ManagedNotebookServiceClient.StartRuntimeAsync(StartRuntimeRequest, CallSettings)

StopRuntime(StopRuntimeRequest, CallSettings)

public override Operation<Runtime, OperationMetadata> StopRuntime(StopRuntimeRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Runtime, OperationMetadata>`	The RPC response.

Overrides

ManagedNotebookServiceClient.StopRuntime(StopRuntimeRequest, CallSettings)

StopRuntimeAsync(StopRuntimeRequest, CallSettings)

public override async Task<Operation<Runtime, OperationMetadata>> StopRuntimeAsync(StopRuntimeRequest request, CallSettings callSettings = null)

Parameters
Name	Description
`request`	`StopRuntimeRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Runtime, OperationMetadata>>`	A Task containing the RPC response.

Overrides

ManagedNotebookServiceClient.StopRuntimeAsync(StopRuntimeRequest, CallSettings)

SwitchRuntime(SwitchRuntimeRequest, CallSettings)

public override Operation<Runtime, OperationMetadata> SwitchRuntime(SwitchRuntimeRequest request, CallSettings callSettings = null)

Switch a Managed Notebook Runtime.

Parameters
Name	Description
`request`	`SwitchRuntimeRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Runtime, OperationMetadata>`	The RPC response.

Overrides

ManagedNotebookServiceClient.SwitchRuntime(SwitchRuntimeRequest, CallSettings)

SwitchRuntimeAsync(SwitchRuntimeRequest, CallSettings)

public override async Task<Operation<Runtime, OperationMetadata>> SwitchRuntimeAsync(SwitchRuntimeRequest request, CallSettings callSettings = null)

Switch a Managed Notebook Runtime.

Parameters
Name	Description
`request`	`SwitchRuntimeRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Runtime, OperationMetadata>>`	A Task containing the RPC response.

Overrides

ManagedNotebookServiceClient.SwitchRuntimeAsync(SwitchRuntimeRequest, CallSettings)