Notebooks v2 API - Class NotebookServiceClientImpl (1.2.0)

Version latest

• 1.2.0 (latest)
• 1.1.0
• 1.0.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

Inherited Members

NotebookServiceClient.DefaultEndpoint

NotebookServiceClient.DefaultScopes

NotebookServiceClient.ServiceMetadata

NotebookServiceClient.CreateAsync(CancellationToken)

NotebookServiceClient.Create()

NotebookServiceClient.ShutdownDefaultChannelsAsync()

NotebookServiceClient.ListInstances(string, string, int?, CallSettings)

NotebookServiceClient.ListInstancesAsync(string, string, int?, CallSettings)

NotebookServiceClient.ListInstances(LocationName, string, int?, CallSettings)

NotebookServiceClient.ListInstancesAsync(LocationName, string, int?, CallSettings)

NotebookServiceClient.GetInstanceAsync(GetInstanceRequest, CancellationToken)

NotebookServiceClient.GetInstance(string, CallSettings)

NotebookServiceClient.GetInstanceAsync(string, CallSettings)

NotebookServiceClient.GetInstanceAsync(string, CancellationToken)

NotebookServiceClient.GetInstance(InstanceName, CallSettings)

NotebookServiceClient.GetInstanceAsync(InstanceName, CallSettings)

NotebookServiceClient.GetInstanceAsync(InstanceName, CancellationToken)

NotebookServiceClient.CreateInstanceAsync(CreateInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceCreateInstance(string, CallSettings)

NotebookServiceClient.PollOnceCreateInstanceAsync(string, CallSettings)

NotebookServiceClient.CreateInstance(string, Instance, string, CallSettings)

NotebookServiceClient.CreateInstanceAsync(string, Instance, string, CallSettings)

NotebookServiceClient.CreateInstanceAsync(string, Instance, string, CancellationToken)

NotebookServiceClient.CreateInstance(LocationName, Instance, string, CallSettings)

NotebookServiceClient.CreateInstanceAsync(LocationName, Instance, string, CallSettings)

NotebookServiceClient.CreateInstanceAsync(LocationName, Instance, string, CancellationToken)

NotebookServiceClient.UpdateInstanceAsync(UpdateInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceUpdateInstance(string, CallSettings)

NotebookServiceClient.PollOnceUpdateInstanceAsync(string, CallSettings)

NotebookServiceClient.UpdateInstance(Instance, FieldMask, CallSettings)

NotebookServiceClient.UpdateInstanceAsync(Instance, FieldMask, CallSettings)

NotebookServiceClient.UpdateInstanceAsync(Instance, FieldMask, CancellationToken)

NotebookServiceClient.DeleteInstanceAsync(DeleteInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceDeleteInstance(string, CallSettings)

NotebookServiceClient.PollOnceDeleteInstanceAsync(string, CallSettings)

NotebookServiceClient.DeleteInstance(string, CallSettings)

NotebookServiceClient.DeleteInstanceAsync(string, CallSettings)

NotebookServiceClient.DeleteInstanceAsync(string, CancellationToken)

NotebookServiceClient.DeleteInstance(InstanceName, CallSettings)

NotebookServiceClient.DeleteInstanceAsync(InstanceName, CallSettings)

NotebookServiceClient.DeleteInstanceAsync(InstanceName, CancellationToken)

NotebookServiceClient.StartInstanceAsync(StartInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceStartInstance(string, CallSettings)

NotebookServiceClient.PollOnceStartInstanceAsync(string, CallSettings)

NotebookServiceClient.StopInstanceAsync(StopInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceStopInstance(string, CallSettings)

NotebookServiceClient.PollOnceStopInstanceAsync(string, CallSettings)

NotebookServiceClient.ResetInstanceAsync(ResetInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceResetInstance(string, CallSettings)

NotebookServiceClient.PollOnceResetInstanceAsync(string, CallSettings)

NotebookServiceClient.CheckInstanceUpgradabilityAsync(CheckInstanceUpgradabilityRequest, CancellationToken)

NotebookServiceClient.UpgradeInstanceAsync(UpgradeInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceUpgradeInstance(string, CallSettings)

NotebookServiceClient.PollOnceUpgradeInstanceAsync(string, CallSettings)

NotebookServiceClient.RollbackInstanceAsync(RollbackInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceRollbackInstance(string, CallSettings)

NotebookServiceClient.PollOnceRollbackInstanceAsync(string, CallSettings)

NotebookServiceClient.DiagnoseInstanceAsync(DiagnoseInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceDiagnoseInstance(string, CallSettings)

NotebookServiceClient.PollOnceDiagnoseInstanceAsync(string, CallSettings)

NotebookServiceClient.DiagnoseInstance(string, DiagnosticConfig, CallSettings)

NotebookServiceClient.DiagnoseInstanceAsync(string, DiagnosticConfig, CallSettings)

NotebookServiceClient.DiagnoseInstanceAsync(string, DiagnosticConfig, CancellationToken)

NotebookServiceClient.DiagnoseInstance(InstanceName, DiagnosticConfig, CallSettings)

NotebookServiceClient.DiagnoseInstanceAsync(InstanceName, DiagnosticConfig, CallSettings)

NotebookServiceClient.DiagnoseInstanceAsync(InstanceName, DiagnosticConfig, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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

NotebookServiceClient.CreateInstanceOperationsClient

DeleteInstanceOperationsClient

public override OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.DeleteInstanceOperationsClient

DiagnoseInstanceOperationsClient

public override OperationsClient DiagnoseInstanceOperationsClient { get; }

The long-running operations client for DiagnoseInstance.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.DiagnoseInstanceOperationsClient

GrpcClient

public override NotebookService.NotebookServiceClient GrpcClient { get; }

The underlying gRPC NotebookService client

Property Value
Type	Description
NotebookServiceNotebookServiceClient

Overrides

NotebookServiceClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
IAMPolicyClient

Overrides

NotebookServiceClient.IAMPolicyClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

NotebookServiceClient.LocationsClient

ResetInstanceOperationsClient

public override OperationsClient ResetInstanceOperationsClient { get; }

The long-running operations client for ResetInstance.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.ResetInstanceOperationsClient

RollbackInstanceOperationsClient

public override OperationsClient RollbackInstanceOperationsClient { get; }

The long-running operations client for RollbackInstance.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.RollbackInstanceOperationsClient

StartInstanceOperationsClient

public override OperationsClient StartInstanceOperationsClient { get; }

The long-running operations client for StartInstance.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.StartInstanceOperationsClient

StopInstanceOperationsClient

public override OperationsClient StopInstanceOperationsClient { get; }

The long-running operations client for StopInstance.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.StopInstanceOperationsClient

UpdateInstanceOperationsClient

public override OperationsClient UpdateInstanceOperationsClient { get; }

The long-running operations client for UpdateInstance.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.UpdateInstanceOperationsClient

UpgradeInstanceOperationsClient

public override OperationsClient UpgradeInstanceOperationsClient { get; }

The long-running operations client for UpgradeInstance.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.UpgradeInstanceOperationsClient

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

NotebookServiceClient.CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest, CallSettings)

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

NotebookServiceClient.CheckInstanceUpgradabilityAsync(CheckInstanceUpgradabilityRequest, CallSettings)

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

NotebookServiceClient.CreateInstance(CreateInstanceRequest, CallSettings)

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

NotebookServiceClient.CreateInstanceAsync(CreateInstanceRequest, CallSettings)

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

NotebookServiceClient.DeleteInstance(DeleteInstanceRequest, CallSettings)

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

NotebookServiceClient.DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

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

NotebookServiceClient.DiagnoseInstance(DiagnoseInstanceRequest, CallSettings)

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

NotebookServiceClient.DiagnoseInstanceAsync(DiagnoseInstanceRequest, CallSettings)

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

NotebookServiceClient.GetInstance(GetInstanceRequest, CallSettings)

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

NotebookServiceClient.GetInstanceAsync(GetInstanceRequest, CallSettings)

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

NotebookServiceClient.ListInstances(ListInstancesRequest, CallSettings)

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

NotebookServiceClient.ListInstancesAsync(ListInstancesRequest, CallSettings)

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

NotebookServiceClient.ResetInstance(ResetInstanceRequest, CallSettings)

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

NotebookServiceClient.ResetInstanceAsync(ResetInstanceRequest, CallSettings)

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

NotebookServiceClient.RollbackInstance(RollbackInstanceRequest, CallSettings)

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

NotebookServiceClient.RollbackInstanceAsync(RollbackInstanceRequest, CallSettings)

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

NotebookServiceClient.StartInstance(StartInstanceRequest, CallSettings)

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

NotebookServiceClient.StartInstanceAsync(StartInstanceRequest, CallSettings)

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

NotebookServiceClient.StopInstance(StopInstanceRequest, CallSettings)

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

NotebookServiceClient.StopInstanceAsync(StopInstanceRequest, CallSettings)

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

NotebookServiceClient.UpdateInstance(UpdateInstanceRequest, CallSettings)

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

NotebookServiceClient.UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)

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

NotebookServiceClient.UpgradeInstance(UpgradeInstanceRequest, CallSettings)

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

NotebookServiceClient.UpgradeInstanceAsync(UpgradeInstanceRequest, CallSettings)