Notebooks v2 API - Class NotebookServiceClientImpl (1.1.0)

public sealed class NotebookServiceClientImpl : NotebookServiceClient

Reference documentation and code samples for the Notebooks v2 API class NotebookServiceClientImpl.

NotebookService client wrapper implementation, for convenient use.

Inheritance

object > NotebookServiceClient > NotebookServiceClientImpl

Namespace

Google.Cloud.Notebooks.V2

Assembly

Google.Cloud.Notebooks.V2.dll

Remarks

API v2 service for Workbench Notebooks Instances.

Constructors

NotebookServiceClientImpl(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 NotebookServiceNotebookServiceClient

The underlying gRPC client.

settings NotebookServiceSettings

The base NotebookServiceSettings used within this client.

logger ILogger

Optional ILogger to use within this client.

Properties

CreateInstanceOperationsClient

public override OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
Type Description
OperationsClient
Overrides

DeleteInstanceOperationsClient

public override OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value
Type Description
OperationsClient
Overrides

DiagnoseInstanceOperationsClient

public override OperationsClient DiagnoseInstanceOperationsClient { get; }

The long-running operations client for DiagnoseInstance.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override NotebookService.NotebookServiceClient GrpcClient { get; }

The underlying gRPC NotebookService client

Property Value
Type Description
NotebookServiceNotebookServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

ResetInstanceOperationsClient

public override OperationsClient ResetInstanceOperationsClient { get; }

The long-running operations client for ResetInstance.

Property Value
Type Description
OperationsClient
Overrides

RollbackInstanceOperationsClient

public override OperationsClient RollbackInstanceOperationsClient { get; }

The long-running operations client for RollbackInstance.

Property Value
Type Description
OperationsClient
Overrides

StartInstanceOperationsClient

public override OperationsClient StartInstanceOperationsClient { get; }

The long-running operations client for StartInstance.

Property Value
Type Description
OperationsClient
Overrides

StopInstanceOperationsClient

public override OperationsClient StopInstanceOperationsClient { get; }

The long-running operations client for StopInstance.

Property Value
Type Description
OperationsClient
Overrides

UpdateInstanceOperationsClient

public override OperationsClient UpdateInstanceOperationsClient { get; }

The long-running operations client for UpdateInstance.

Property Value
Type Description
OperationsClient
Overrides

UpgradeInstanceOperationsClient

public override OperationsClient UpgradeInstanceOperationsClient { get; }

The long-running operations client for UpgradeInstance.

Property Value
Type Description
OperationsClient
Overrides

Methods

CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest, CallSettings)

public override CheckInstanceUpgradabilityResponse CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest request, CallSettings callSettings = null)

Checks whether a notebook instance is upgradable.

Parameters
Name Description
request CheckInstanceUpgradabilityRequest

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
CheckInstanceUpgradabilityResponse

The RPC response.

Overrides

CheckInstanceUpgradabilityAsync(CheckInstanceUpgradabilityRequest, CallSettings)

public override Task<CheckInstanceUpgradabilityResponse> CheckInstanceUpgradabilityAsync(CheckInstanceUpgradabilityRequest request, CallSettings callSettings = null)

Checks whether a notebook instance is upgradable.

Parameters
Name Description
request CheckInstanceUpgradabilityRequest

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
TaskCheckInstanceUpgradabilityResponse

A Task containing the RPC response.

Overrides

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
OperationInstanceOperationMetadata

The RPC response.

Overrides

CreateInstanceAsync(CreateInstanceRequest, CallSettings)

public override 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
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Overrides

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
OperationEmptyOperationMetadata

The RPC response.

Overrides

DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

public override 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
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Overrides

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
OperationInstanceOperationMetadata

The RPC response.

Overrides

DiagnoseInstanceAsync(DiagnoseInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> DiagnoseInstanceAsync(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
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Overrides

GetInstance(GetInstanceRequest, CallSettings)

public override Instance GetInstance(GetInstanceRequest request, CallSettings callSettings = null)

Gets details of a single Instance.

Parameters
Name Description
request GetInstanceRequest

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
Instance

The RPC response.

Overrides

GetInstanceAsync(GetInstanceRequest, CallSettings)

public override Task<Instance> GetInstanceAsync(GetInstanceRequest request, CallSettings callSettings = null)

Gets details of a single Instance.

Parameters
Name Description
request GetInstanceRequest

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
TaskInstance

A Task containing the RPC response.

Overrides

ListInstances(ListInstancesRequest, CallSettings)

public override PagedEnumerable<ListInstancesResponse, Instance> ListInstances(ListInstancesRequest request, CallSettings callSettings = null)

Lists instances in a given project and location.

Parameters
Name Description
request ListInstancesRequest

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
PagedEnumerableListInstancesResponseInstance

A pageable sequence of Instance resources.

Overrides

ListInstancesAsync(ListInstancesRequest, CallSettings)

public override PagedAsyncEnumerable<ListInstancesResponse, Instance> ListInstancesAsync(ListInstancesRequest request, CallSettings callSettings = null)

Lists instances in a given project and location.

Parameters
Name Description
request ListInstancesRequest

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
PagedAsyncEnumerableListInstancesResponseInstance

A pageable asynchronous sequence of Instance resources.

Overrides

ResetInstance(ResetInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> ResetInstance(ResetInstanceRequest request, CallSettings callSettings = null)

Resets a notebook instance.

Parameters
Name Description
request ResetInstanceRequest

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
OperationInstanceOperationMetadata

The RPC response.

Overrides

ResetInstanceAsync(ResetInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> ResetInstanceAsync(ResetInstanceRequest request, CallSettings callSettings = null)

Resets a notebook instance.

Parameters
Name Description
request ResetInstanceRequest

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
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Overrides

RollbackInstance(RollbackInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> RollbackInstance(RollbackInstanceRequest request, CallSettings callSettings = null)

Rollbacks a notebook instance to the previous version.

Parameters
Name Description
request RollbackInstanceRequest

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
OperationInstanceOperationMetadata

The RPC response.

Overrides

RollbackInstanceAsync(RollbackInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> RollbackInstanceAsync(RollbackInstanceRequest request, CallSettings callSettings = null)

Rollbacks a notebook instance to the previous version.

Parameters
Name Description
request RollbackInstanceRequest

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
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Overrides

StartInstance(StartInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> StartInstance(StartInstanceRequest request, CallSettings callSettings = null)

Starts a notebook instance.

Parameters
Name Description
request StartInstanceRequest

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
OperationInstanceOperationMetadata

The RPC response.

Overrides

StartInstanceAsync(StartInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> StartInstanceAsync(StartInstanceRequest request, CallSettings callSettings = null)

Starts a notebook instance.

Parameters
Name Description
request StartInstanceRequest

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
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Overrides

StopInstance(StopInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> StopInstance(StopInstanceRequest request, CallSettings callSettings = null)

Stops a notebook instance.

Parameters
Name Description
request StopInstanceRequest

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
OperationInstanceOperationMetadata

The RPC response.

Overrides

StopInstanceAsync(StopInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> StopInstanceAsync(StopInstanceRequest request, CallSettings callSettings = null)

Stops a notebook instance.

Parameters
Name Description
request StopInstanceRequest

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
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Overrides

UpdateInstance(UpdateInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> UpdateInstance(UpdateInstanceRequest request, CallSettings callSettings = null)

UpdateInstance updates an Instance.

Parameters
Name Description
request UpdateInstanceRequest

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
OperationInstanceOperationMetadata

The RPC response.

Overrides

UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> UpdateInstanceAsync(UpdateInstanceRequest request, CallSettings callSettings = null)

UpdateInstance updates an Instance.

Parameters
Name Description
request UpdateInstanceRequest

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
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Overrides

UpgradeInstance(UpgradeInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> UpgradeInstance(UpgradeInstanceRequest request, CallSettings callSettings = null)

Upgrades a notebook instance to the latest version.

Parameters
Name Description
request UpgradeInstanceRequest

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
OperationInstanceOperationMetadata

The RPC response.

Overrides

UpgradeInstanceAsync(UpgradeInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> UpgradeInstanceAsync(UpgradeInstanceRequest request, CallSettings callSettings = null)

Upgrades a notebook instance to the latest version.

Parameters
Name Description
request UpgradeInstanceRequest

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
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Overrides