AI Platform Notebooks v1 API - Class ManagedNotebookServiceClientImpl (2.3.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

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Remarks

API v1 service for Managed Notebooks.

Constructors

ManagedNotebookServiceClientImpl(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
NameDescription
grpcClientManagedNotebookServiceManagedNotebookServiceClient

The underlying gRPC client.

settingsManagedNotebookServiceSettings

The base ManagedNotebookServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

CreateRuntimeOperationsClient

public override OperationsClient CreateRuntimeOperationsClient { get; }

The long-running operations client for CreateRuntime.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteRuntimeOperationsClient

public override OperationsClient DeleteRuntimeOperationsClient { get; }

The long-running operations client for DeleteRuntime.

Property Value
TypeDescription
OperationsClient
Overrides

DiagnoseRuntimeOperationsClient

public override OperationsClient DiagnoseRuntimeOperationsClient { get; }

The long-running operations client for DiagnoseRuntime.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override ManagedNotebookService.ManagedNotebookServiceClient GrpcClient { get; }

The underlying gRPC ManagedNotebookService client

Property Value
TypeDescription
ManagedNotebookServiceManagedNotebookServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
TypeDescription
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient
Overrides

ReportRuntimeEventOperationsClient

public override OperationsClient ReportRuntimeEventOperationsClient { get; }

The long-running operations client for ReportRuntimeEvent.

Property Value
TypeDescription
OperationsClient
Overrides

ResetRuntimeOperationsClient

public override OperationsClient ResetRuntimeOperationsClient { get; }

The long-running operations client for ResetRuntime.

Property Value
TypeDescription
OperationsClient
Overrides

StartRuntimeOperationsClient

public override OperationsClient StartRuntimeOperationsClient { get; }

The long-running operations client for StartRuntime.

Property Value
TypeDescription
OperationsClient
Overrides

StopRuntimeOperationsClient

public override OperationsClient StopRuntimeOperationsClient { get; }

The long-running operations client for StopRuntime.

Property Value
TypeDescription
OperationsClient
Overrides

SwitchRuntimeOperationsClient

public override OperationsClient SwitchRuntimeOperationsClient { get; }

The long-running operations client for SwitchRuntime.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateRuntimeOperationsClient

public override OperationsClient UpdateRuntimeOperationsClient { get; }

The long-running operations client for UpdateRuntime.

Property Value
TypeDescription
OperationsClient
Overrides

UpgradeRuntimeOperationsClient

public override OperationsClient UpgradeRuntimeOperationsClient { get; }

The long-running operations client for UpgradeRuntime.

Property Value
TypeDescription
OperationsClient
Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationRuntimeOperationMetadata

The RPC response.

Overrides

CreateRuntimeAsync(CreateRuntimeRequest, CallSettings)

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

Creates a new Runtime in a given project and location.

Parameters
NameDescription
requestCreateRuntimeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationRuntimeOperationMetadata

A Task containing the RPC response.

Overrides

DeleteRuntime(DeleteRuntimeRequest, CallSettings)

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

Deletes a single Runtime.

Parameters
NameDescription
requestDeleteRuntimeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyOperationMetadata

The RPC response.

Overrides

DeleteRuntimeAsync(DeleteRuntimeRequest, CallSettings)

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

Deletes a single Runtime.

Parameters
NameDescription
requestDeleteRuntimeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Overrides

DiagnoseRuntime(DiagnoseRuntimeRequest, CallSettings)

public override Operation<Runtime, OperationMetadata> DiagnoseRuntime(DiagnoseRuntimeRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestDiagnoseRuntimeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationRuntimeOperationMetadata

The RPC response.

Overrides

DiagnoseRuntimeAsync(DiagnoseRuntimeRequest, CallSettings)

public override Task<Operation<Runtime, OperationMetadata>> DiagnoseRuntimeAsync(DiagnoseRuntimeRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestDiagnoseRuntimeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationRuntimeOperationMetadata

A Task containing the RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Runtime

The RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskRuntime

A Task containing the RPC response.

Overrides

ListRuntimes(ListRuntimesRequest, CallSettings)

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

Lists Runtimes in a given project and location.

Parameters
NameDescription
requestListRuntimesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListRuntimesResponseRuntime

A pageable sequence of Runtime resources.

Overrides

ListRuntimesAsync(ListRuntimesRequest, CallSettings)

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

Lists Runtimes in a given project and location.

Parameters
NameDescription
requestListRuntimesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListRuntimesResponseRuntime

A pageable asynchronous sequence of Runtime resources.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
RefreshRuntimeTokenInternalResponse

The RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskRefreshRuntimeTokenInternalResponse

A Task containing the RPC response.

Overrides

ReportRuntimeEvent(ReportRuntimeEventRequest, CallSettings)

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

Report and process a runtime event.

Parameters
NameDescription
requestReportRuntimeEventRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationRuntimeOperationMetadata

The RPC response.

Overrides

ReportRuntimeEventAsync(ReportRuntimeEventRequest, CallSettings)

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

Report and process a runtime event.

Parameters
NameDescription
requestReportRuntimeEventRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationRuntimeOperationMetadata

A Task containing the RPC response.

Overrides

ResetRuntime(ResetRuntimeRequest, CallSettings)

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

Resets a Managed Notebook Runtime.

Parameters
NameDescription
requestResetRuntimeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationRuntimeOperationMetadata

The RPC response.

Overrides

ResetRuntimeAsync(ResetRuntimeRequest, CallSettings)

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

Resets a Managed Notebook Runtime.

Parameters
NameDescription
requestResetRuntimeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationRuntimeOperationMetadata

A Task containing the RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationRuntimeOperationMetadata

The RPC response.

Overrides

StartRuntimeAsync(StartRuntimeRequest, CallSettings)

public override Task<Operation<Runtime, OperationMetadata>> StartRuntimeAsync(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
NameDescription
requestStartRuntimeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationRuntimeOperationMetadata

A Task containing the RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationRuntimeOperationMetadata

The RPC response.

Overrides

StopRuntimeAsync(StopRuntimeRequest, CallSettings)

public override Task<Operation<Runtime, OperationMetadata>> StopRuntimeAsync(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
NameDescription
requestStopRuntimeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationRuntimeOperationMetadata

A Task containing the RPC response.

Overrides

SwitchRuntime(SwitchRuntimeRequest, CallSettings)

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

Switch a Managed Notebook Runtime.

Parameters
NameDescription
requestSwitchRuntimeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationRuntimeOperationMetadata

The RPC response.

Overrides

SwitchRuntimeAsync(SwitchRuntimeRequest, CallSettings)

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

Switch a Managed Notebook Runtime.

Parameters
NameDescription
requestSwitchRuntimeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationRuntimeOperationMetadata

A Task containing the RPC response.

Overrides

UpdateRuntime(UpdateRuntimeRequest, CallSettings)

public override Operation<Runtime, OperationMetadata> UpdateRuntime(UpdateRuntimeRequest request, CallSettings callSettings = null)

Update Notebook Runtime configuration.

Parameters
NameDescription
requestUpdateRuntimeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationRuntimeOperationMetadata

The RPC response.

Overrides

UpdateRuntimeAsync(UpdateRuntimeRequest, CallSettings)

public override Task<Operation<Runtime, OperationMetadata>> UpdateRuntimeAsync(UpdateRuntimeRequest request, CallSettings callSettings = null)

Update Notebook Runtime configuration.

Parameters
NameDescription
requestUpdateRuntimeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationRuntimeOperationMetadata

A Task containing the RPC response.

Overrides

UpgradeRuntime(UpgradeRuntimeRequest, CallSettings)

public override Operation<Runtime, OperationMetadata> UpgradeRuntime(UpgradeRuntimeRequest request, CallSettings callSettings = null)

Upgrades a Managed Notebook Runtime to the latest version.

Parameters
NameDescription
requestUpgradeRuntimeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationRuntimeOperationMetadata

The RPC response.

Overrides

UpgradeRuntimeAsync(UpgradeRuntimeRequest, CallSettings)

public override Task<Operation<Runtime, OperationMetadata>> UpgradeRuntimeAsync(UpgradeRuntimeRequest request, CallSettings callSettings = null)

Upgrades a Managed Notebook Runtime to the latest version.

Parameters
NameDescription
requestUpgradeRuntimeRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationRuntimeOperationMetadata

A Task containing the RPC response.

Overrides