public sealed class ManagedNotebookServiceClientImpl : ManagedNotebookServiceClientReference documentation and code samples for the AI Platform Notebooks v1 API class ManagedNotebookServiceClientImpl.
ManagedNotebookService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Notebooks.V1Assembly
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 | |
|---|---|
| Name | Description |
grpcClient | ManagedNotebookServiceManagedNotebookServiceClientThe underlying gRPC client. |
settings | ManagedNotebookServiceSettingsThe base ManagedNotebookServiceSettings used within this client. |
logger | ILoggerOptional 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 | |
DeleteRuntimeOperationsClient
public override OperationsClient DeleteRuntimeOperationsClient { get; }The long-running operations client for DeleteRuntime.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DiagnoseRuntimeOperationsClient
public override OperationsClient DiagnoseRuntimeOperationsClient { get; }The long-running operations client for DiagnoseRuntime.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override ManagedNotebookService.ManagedNotebookServiceClient GrpcClient { get; }The underlying gRPC ManagedNotebookService client
| Property Value | |
|---|---|
| Type | Description |
ManagedNotebookServiceManagedNotebookServiceClient | |
IAMPolicyClient
public override IAMPolicyClient IAMPolicyClient { get; }The IAMPolicyClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
IAMPolicyClient | |
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient | |
ReportRuntimeEventOperationsClient
public override OperationsClient ReportRuntimeEventOperationsClient { get; }The long-running operations client for ReportRuntimeEvent.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
ResetRuntimeOperationsClient
public override OperationsClient ResetRuntimeOperationsClient { get; }The long-running operations client for ResetRuntime.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
StartRuntimeOperationsClient
public override OperationsClient StartRuntimeOperationsClient { get; }The long-running operations client for StartRuntime.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
StopRuntimeOperationsClient
public override OperationsClient StopRuntimeOperationsClient { get; }The long-running operations client for StopRuntime.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SwitchRuntimeOperationsClient
public override OperationsClient SwitchRuntimeOperationsClient { get; }The long-running operations client for SwitchRuntime.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateRuntimeOperationsClient
public override OperationsClient UpdateRuntimeOperationsClient { get; }The long-running operations client for UpdateRuntime.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpgradeRuntimeOperationsClient
public override OperationsClient UpgradeRuntimeOperationsClient { get; }The long-running operations client for UpgradeRuntime.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
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 | CreateRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationRuntimeOperationMetadata | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | CreateRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationRuntimeOperationMetadata | A Task containing the RPC response. |
DeleteRuntime(DeleteRuntimeRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteRuntime(DeleteRuntimeRequest request, CallSettings callSettings = null)Deletes a single Runtime.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata | The RPC response. |
DeleteRuntimeAsync(DeleteRuntimeRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteRuntimeAsync(DeleteRuntimeRequest request, CallSettings callSettings = null)Deletes a single Runtime.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | DiagnoseRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationRuntimeOperationMetadata | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | DiagnoseRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationRuntimeOperationMetadata | A Task containing the RPC response. |
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 | GetRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Runtime | The RPC response. |
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 | GetRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskRuntime | A Task containing the RPC response. |
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 | ListRuntimesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListRuntimesResponseRuntime | A pageable sequence of Runtime resources. |
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 | ListRuntimesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListRuntimesResponseRuntime | A pageable asynchronous sequence of Runtime resources. |
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 | RefreshRuntimeTokenInternalRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
RefreshRuntimeTokenInternalResponse | The RPC response. |
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 | RefreshRuntimeTokenInternalRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskRefreshRuntimeTokenInternalResponse | A Task containing the RPC response. |
ReportRuntimeEvent(ReportRuntimeEventRequest, CallSettings)
public override Operation<Runtime, OperationMetadata> ReportRuntimeEvent(ReportRuntimeEventRequest request, CallSettings callSettings = null)Report and process a runtime event.
| Parameters | |
|---|---|
| Name | Description |
request | ReportRuntimeEventRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationRuntimeOperationMetadata | The RPC response. |
ReportRuntimeEventAsync(ReportRuntimeEventRequest, CallSettings)
public override Task<Operation<Runtime, OperationMetadata>> ReportRuntimeEventAsync(ReportRuntimeEventRequest request, CallSettings callSettings = null)Report and process a runtime event.
| Parameters | |
|---|---|
| Name | Description |
request | ReportRuntimeEventRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationRuntimeOperationMetadata | A Task containing the RPC response. |
ResetRuntime(ResetRuntimeRequest, CallSettings)
public override Operation<Runtime, OperationMetadata> ResetRuntime(ResetRuntimeRequest request, CallSettings callSettings = null)Resets a Managed Notebook Runtime.
| Parameters | |
|---|---|
| Name | Description |
request | ResetRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationRuntimeOperationMetadata | The RPC response. |
ResetRuntimeAsync(ResetRuntimeRequest, CallSettings)
public override Task<Operation<Runtime, OperationMetadata>> ResetRuntimeAsync(ResetRuntimeRequest request, CallSettings callSettings = null)Resets a Managed Notebook Runtime.
| Parameters | |
|---|---|
| Name | Description |
request | ResetRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationRuntimeOperationMetadata | A Task containing the RPC response. |
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 | StartRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationRuntimeOperationMetadata | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | StartRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationRuntimeOperationMetadata | A Task containing the RPC response. |
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 | StopRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationRuntimeOperationMetadata | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | StopRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationRuntimeOperationMetadata | A Task containing the RPC response. |
SwitchRuntime(SwitchRuntimeRequest, CallSettings)
public override Operation<Runtime, OperationMetadata> SwitchRuntime(SwitchRuntimeRequest request, CallSettings callSettings = null)Switch a Managed Notebook Runtime.
| Parameters | |
|---|---|
| Name | Description |
request | SwitchRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationRuntimeOperationMetadata | The RPC response. |
SwitchRuntimeAsync(SwitchRuntimeRequest, CallSettings)
public override Task<Operation<Runtime, OperationMetadata>> SwitchRuntimeAsync(SwitchRuntimeRequest request, CallSettings callSettings = null)Switch a Managed Notebook Runtime.
| Parameters | |
|---|---|
| Name | Description |
request | SwitchRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationRuntimeOperationMetadata | A Task containing the RPC response. |
UpdateRuntime(UpdateRuntimeRequest, CallSettings)
public override Operation<Runtime, OperationMetadata> UpdateRuntime(UpdateRuntimeRequest request, CallSettings callSettings = null)Update Notebook Runtime configuration.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationRuntimeOperationMetadata | The RPC response. |
UpdateRuntimeAsync(UpdateRuntimeRequest, CallSettings)
public override Task<Operation<Runtime, OperationMetadata>> UpdateRuntimeAsync(UpdateRuntimeRequest request, CallSettings callSettings = null)Update Notebook Runtime configuration.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationRuntimeOperationMetadata | A Task containing the RPC response. |
UpgradeRuntime(UpgradeRuntimeRequest, CallSettings)
public override Operation<Runtime, OperationMetadata> UpgradeRuntime(UpgradeRuntimeRequest request, CallSettings callSettings = null)Upgrades a Managed Notebook Runtime to the latest version.
| Parameters | |
|---|---|
| Name | Description |
request | UpgradeRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationRuntimeOperationMetadata | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | UpgradeRuntimeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationRuntimeOperationMetadata | A Task containing the RPC response. |