public sealed class NotebookServiceClientImpl : NotebookServiceClient
Reference documentation and code samples for the AI Platform Notebooks v1 API class NotebookServiceClientImpl.
NotebookService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Notebooks.V1Assembly
Google.Cloud.Notebooks.V1.dll
Remarks
API v1 service for Cloud AI Platform Notebooks.
Constructors
NotebookServiceClientImpl(NotebookService.NotebookServiceClient, NotebookServiceSettings, ILogger)
public NotebookServiceClientImpl(NotebookService.NotebookServiceClient grpcClient, NotebookServiceSettings settings, ILogger logger)
Constructs a client wrapper for the NotebookService service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient | NotebookService.NotebookServiceClient The underlying gRPC client. |
settings | NotebookServiceSettings The base NotebookServiceSettings used within this client. |
logger | ILogger Optional ILogger to use within this client. |
Properties
CreateEnvironmentOperationsClient
public override OperationsClient CreateEnvironmentOperationsClient { get; }
The long-running operations client for CreateEnvironment
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateExecutionOperationsClient
public override OperationsClient CreateExecutionOperationsClient { get; }
The long-running operations client for CreateExecution
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateInstanceOperationsClient
public override OperationsClient CreateInstanceOperationsClient { get; }
The long-running operations client for CreateInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateScheduleOperationsClient
public override OperationsClient CreateScheduleOperationsClient { get; }
The long-running operations client for CreateSchedule
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteEnvironmentOperationsClient
public override OperationsClient DeleteEnvironmentOperationsClient { get; }
The long-running operations client for DeleteEnvironment
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteExecutionOperationsClient
public override OperationsClient DeleteExecutionOperationsClient { get; }
The long-running operations client for DeleteExecution
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteInstanceOperationsClient
public override OperationsClient DeleteInstanceOperationsClient { get; }
The long-running operations client for DeleteInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteScheduleOperationsClient
public override OperationsClient DeleteScheduleOperationsClient { get; }
The long-running operations client for DeleteSchedule
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DiagnoseInstanceOperationsClient
public override OperationsClient DiagnoseInstanceOperationsClient { get; }
The long-running operations client for DiagnoseInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override NotebookService.NotebookServiceClient GrpcClient { get; }
The underlying gRPC NotebookService client
Property Value | |
---|---|
Type | Description |
NotebookService.NotebookServiceClient |
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 |
RegisterInstanceOperationsClient
public override OperationsClient RegisterInstanceOperationsClient { get; }
The long-running operations client for RegisterInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ReportInstanceInfoOperationsClient
public override OperationsClient ReportInstanceInfoOperationsClient { get; }
The long-running operations client for ReportInstanceInfo
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ResetInstanceOperationsClient
public override OperationsClient ResetInstanceOperationsClient { get; }
The long-running operations client for ResetInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
RollbackInstanceOperationsClient
public override OperationsClient RollbackInstanceOperationsClient { get; }
The long-running operations client for RollbackInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
SetInstanceAcceleratorOperationsClient
public override OperationsClient SetInstanceAcceleratorOperationsClient { get; }
The long-running operations client for SetInstanceAccelerator
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
SetInstanceLabelsOperationsClient
public override OperationsClient SetInstanceLabelsOperationsClient { get; }
The long-running operations client for SetInstanceLabels
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
SetInstanceMachineTypeOperationsClient
public override OperationsClient SetInstanceMachineTypeOperationsClient { get; }
The long-running operations client for SetInstanceMachineType
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
StartInstanceOperationsClient
public override OperationsClient StartInstanceOperationsClient { get; }
The long-running operations client for StartInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
StopInstanceOperationsClient
public override OperationsClient StopInstanceOperationsClient { get; }
The long-running operations client for StopInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
TriggerScheduleOperationsClient
public override OperationsClient TriggerScheduleOperationsClient { get; }
The long-running operations client for TriggerSchedule
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateInstanceConfigOperationsClient
public override OperationsClient UpdateInstanceConfigOperationsClient { get; }
The long-running operations client for UpdateInstanceConfig
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateShieldedInstanceConfigOperationsClient
public override OperationsClient UpdateShieldedInstanceConfigOperationsClient { get; }
The long-running operations client for UpdateShieldedInstanceConfig
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpgradeInstanceInternalOperationsClient
public override OperationsClient UpgradeInstanceInternalOperationsClient { get; }
The long-running operations client for UpgradeInstanceInternal
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpgradeInstanceOperationsClient
public override OperationsClient UpgradeInstanceOperationsClient { get; }
The long-running operations client for UpgradeInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
CreateEnvironment(CreateEnvironmentRequest, CallSettings)
public override Operation<Environment, OperationMetadata> CreateEnvironment(CreateEnvironmentRequest request, CallSettings callSettings = null)
Creates a new Environment.
Parameters | |
---|---|
Name | Description |
request | CreateEnvironmentRequest 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<Environment, OperationMetadata> | The RPC response. |
CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)
public override async Task<Operation<Environment, OperationMetadata>> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallSettings callSettings = null)
Creates a new Environment.
Parameters | |
---|---|
Name | Description |
request | CreateEnvironmentRequest 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<Environment, OperationMetadata>> | A Task containing the RPC response. |
CreateExecution(CreateExecutionRequest, CallSettings)
public override Operation<Execution, OperationMetadata> CreateExecution(CreateExecutionRequest request, CallSettings callSettings = null)
Creates a new Execution in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateExecutionRequest 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<Execution, OperationMetadata> | The RPC response. |
CreateExecutionAsync(CreateExecutionRequest, CallSettings)
public override async Task<Operation<Execution, OperationMetadata>> CreateExecutionAsync(CreateExecutionRequest request, CallSettings callSettings = null)
Creates a new Execution in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateExecutionRequest 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<Execution, OperationMetadata>> | A Task containing the RPC response. |
CreateInstance(CreateInstanceRequest, CallSettings)
public override Operation<Instance, OperationMetadata> CreateInstance(CreateInstanceRequest request, CallSettings callSettings = null)
Creates a new Instance in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateInstanceRequest 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<Instance, OperationMetadata> | The RPC response. |
CreateInstanceAsync(CreateInstanceRequest, CallSettings)
public override async Task<Operation<Instance, OperationMetadata>> CreateInstanceAsync(CreateInstanceRequest request, CallSettings callSettings = null)
Creates a new Instance in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateInstanceRequest 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<Instance, OperationMetadata>> | A Task containing the RPC response. |
CreateSchedule(CreateScheduleRequest, CallSettings)
public override Operation<Schedule, OperationMetadata> CreateSchedule(CreateScheduleRequest request, CallSettings callSettings = null)
Creates a new Scheduled Notebook in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateScheduleRequest 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<Schedule, OperationMetadata> | The RPC response. |
CreateScheduleAsync(CreateScheduleRequest, CallSettings)
public override async Task<Operation<Schedule, OperationMetadata>> CreateScheduleAsync(CreateScheduleRequest request, CallSettings callSettings = null)
Creates a new Scheduled Notebook in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateScheduleRequest 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<Schedule, OperationMetadata>> | A Task containing the RPC response. |
DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteEnvironment(DeleteEnvironmentRequest request, CallSettings callSettings = null)
Deletes a single Environment.
Parameters | |
---|---|
Name | Description |
request | DeleteEnvironmentRequest 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. |
DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)
public override async Task<Operation<Empty, OperationMetadata>> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CallSettings callSettings = null)
Deletes a single Environment.
Parameters | |
---|---|
Name | Description |
request | DeleteEnvironmentRequest 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. |
DeleteExecution(DeleteExecutionRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteExecution(DeleteExecutionRequest request, CallSettings callSettings = null)
Deletes execution
Parameters | |
---|---|
Name | Description |
request | DeleteExecutionRequest 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. |
DeleteExecutionAsync(DeleteExecutionRequest, CallSettings)
public override async Task<Operation<Empty, OperationMetadata>> DeleteExecutionAsync(DeleteExecutionRequest request, CallSettings callSettings = null)
Deletes execution
Parameters | |
---|---|
Name | Description |
request | DeleteExecutionRequest 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. |
DeleteInstance(DeleteInstanceRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteInstance(DeleteInstanceRequest request, CallSettings callSettings = null)
Deletes a single Instance.
Parameters | |
---|---|
Name | Description |
request | DeleteInstanceRequest 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. |
DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)
public override async Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(DeleteInstanceRequest request, CallSettings callSettings = null)
Deletes a single Instance.
Parameters | |
---|---|
Name | Description |
request | DeleteInstanceRequest 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. |
DeleteSchedule(DeleteScheduleRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteSchedule(DeleteScheduleRequest request, CallSettings callSettings = null)
Deletes schedule and all underlying jobs
Parameters | |
---|---|
Name | Description |
request | DeleteScheduleRequest 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. |
DeleteScheduleAsync(DeleteScheduleRequest, CallSettings)
public override async Task<Operation<Empty, OperationMetadata>> DeleteScheduleAsync(DeleteScheduleRequest request, CallSettings callSettings = null)
Deletes schedule and all underlying jobs
Parameters | |
---|---|
Name | Description |
request | DeleteScheduleRequest 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. |
DiagnoseInstance(DiagnoseInstanceRequest, CallSettings)
public override Operation<Instance, OperationMetadata> DiagnoseInstance(DiagnoseInstanceRequest request, CallSettings callSettings = null)
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
Parameters | |
---|---|
Name | Description |
request | DiagnoseInstanceRequest 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<Instance, OperationMetadata> | The RPC response. |