Class NotebookServiceClientImpl (1.0.0-beta04)

public sealed class NotebookServiceClientImpl : NotebookServiceClient

NotebookService client wrapper implementation, for convenient use.

Inheritance

Object > NotebookServiceClient > NotebookServiceClientImpl

Namespace

Google.Cloud.Notebooks.V1Beta1

Assembly

Google.Cloud.Notebooks.V1Beta1.dll

Remarks

API v1beta1 service for Cloud AI Platform Notebooks.

Constructors

NotebookServiceClientImpl(NotebookService.NotebookServiceClient, NotebookServiceSettings)

public NotebookServiceClientImpl(NotebookService.NotebookServiceClient grpcClient, NotebookServiceSettings settings)

Constructs a client wrapper for the NotebookService service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientNotebookService.NotebookServiceClient

The underlying gRPC client.

settingsNotebookServiceSettings

The base NotebookServiceSettings used within this client.

Properties

CreateEnvironmentOperationsClient

public override OperationsClient CreateEnvironmentOperationsClient { get; }

The long-running operations client for CreateEnvironment.

Property Value
TypeDescription
OperationsClient
Overrides

CreateInstanceOperationsClient

public override OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteEnvironmentOperationsClient

public override OperationsClient DeleteEnvironmentOperationsClient { get; }

The long-running operations client for DeleteEnvironment.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteInstanceOperationsClient

public override OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override NotebookService.NotebookServiceClient GrpcClient { get; }

The underlying gRPC NotebookService client

Property Value
TypeDescription
NotebookService.NotebookServiceClient
Overrides

RegisterInstanceOperationsClient

public override OperationsClient RegisterInstanceOperationsClient { get; }

The long-running operations client for RegisterInstance.

Property Value
TypeDescription
OperationsClient
Overrides

ReportInstanceInfoOperationsClient

public override OperationsClient ReportInstanceInfoOperationsClient { get; }

The long-running operations client for ReportInstanceInfo.

Property Value
TypeDescription
OperationsClient
Overrides

ResetInstanceOperationsClient

public override OperationsClient ResetInstanceOperationsClient { get; }

The long-running operations client for ResetInstance.

Property Value
TypeDescription
OperationsClient
Overrides

SetInstanceAcceleratorOperationsClient

public override OperationsClient SetInstanceAcceleratorOperationsClient { get; }

The long-running operations client for SetInstanceAccelerator.

Property Value
TypeDescription
OperationsClient
Overrides

SetInstanceLabelsOperationsClient

public override OperationsClient SetInstanceLabelsOperationsClient { get; }

The long-running operations client for SetInstanceLabels.

Property Value
TypeDescription
OperationsClient
Overrides

SetInstanceMachineTypeOperationsClient

public override OperationsClient SetInstanceMachineTypeOperationsClient { get; }

The long-running operations client for SetInstanceMachineType.

Property Value
TypeDescription
OperationsClient
Overrides

StartInstanceOperationsClient

public override OperationsClient StartInstanceOperationsClient { get; }

The long-running operations client for StartInstance.

Property Value
TypeDescription
OperationsClient
Overrides

StopInstanceOperationsClient

public override OperationsClient StopInstanceOperationsClient { get; }

The long-running operations client for StopInstance.

Property Value
TypeDescription
OperationsClient
Overrides

UpgradeInstanceInternalOperationsClient

public override OperationsClient UpgradeInstanceInternalOperationsClient { get; }

The long-running operations client for UpgradeInstanceInternal.

Property Value
TypeDescription
OperationsClient
Overrides

UpgradeInstanceOperationsClient

public override OperationsClient UpgradeInstanceOperationsClient { get; }

The long-running operations client for UpgradeInstance.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

CreateEnvironment(CreateEnvironmentRequest, CallSettings)

public override Operation<Environment, OperationMetadata> CreateEnvironment(CreateEnvironmentRequest request, CallSettings callSettings = null)

Creates a new Environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Environment, OperationMetadata>

The RPC response.

Overrides

CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

public override Task<Operation<Environment, OperationMetadata>> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallSettings callSettings = null)

Creates a new Environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Environment, OperationMetadata>>

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Instance, OperationMetadata>

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Instance, OperationMetadata>>

A Task containing the RPC response.

Overrides

DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteEnvironment(DeleteEnvironmentRequest request, CallSettings callSettings = null)

Deletes a single Environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Overrides

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

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

Deletes a single Environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Overrides

DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

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

Deletes a single Instance.

Parameters
NameDescription
requestDeleteInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Overrides

GetEnvironment(GetEnvironmentRequest, CallSettings)

public override Environment GetEnvironment(GetEnvironmentRequest request, CallSettings callSettings = null)

Gets details of a single Environment.

Parameters
NameDescription
requestGetEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Environment

The RPC response.

Overrides

GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

public override Task<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CallSettings callSettings = null)

Gets details of a single Environment.

Parameters
NameDescription
requestGetEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Environment>

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Instance>

A Task containing the RPC response.

Overrides

IsInstanceUpgradeable(IsInstanceUpgradeableRequest, CallSettings)

public override IsInstanceUpgradeableResponse IsInstanceUpgradeable(IsInstanceUpgradeableRequest request, CallSettings callSettings = null)

Check if a notebook instance is upgradable.

Parameters
NameDescription
requestIsInstanceUpgradeableRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
IsInstanceUpgradeableResponse

The RPC response.

Overrides

IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, CallSettings)

public override Task<IsInstanceUpgradeableResponse> IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest request, CallSettings callSettings = null)

Check if a notebook instance is upgradable.

Parameters
NameDescription
requestIsInstanceUpgradeableRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<IsInstanceUpgradeableResponse>

A Task containing the RPC response.

Overrides

ListEnvironments(ListEnvironmentsRequest, CallSettings)

public override PagedEnumerable<ListEnvironmentsResponse, Environment> ListEnvironments(ListEnvironmentsRequest request, CallSettings callSettings = null)

Lists environments in a project.

Parameters
NameDescription
requestListEnvironmentsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListEnvironmentsResponse, Environment>

A pageable sequence of Environment resources.

Overrides

ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

public override PagedAsyncEnumerable<ListEnvironmentsResponse, Environment> ListEnvironmentsAsync(ListEnvironmentsRequest request, CallSettings callSettings = null)

Lists environments in a project.

Parameters
NameDescription
requestListEnvironmentsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListEnvironmentsResponse, Environment>

A pageable asynchronous sequence of Environment resources.

Overrides

ListInstances(ListInstancesRequest, CallSettings)

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

Lists instances in a given project and location.

Parameters
NameDescription
requestListInstancesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListInstancesResponse, Instance>

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListInstancesResponse, Instance>

A pageable asynchronous sequence of Instance resources.

Overrides

RegisterInstance(RegisterInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> RegisterInstance(RegisterInstanceRequest request, CallSettings callSettings = null)

Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

Parameters
NameDescription
requestRegisterInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Instance, OperationMetadata>

The RPC response.

Overrides

RegisterInstanceAsync(RegisterInstanceRequest, CallSettings)

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

Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

Parameters
NameDescription
requestRegisterInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Instance, OperationMetadata>>

A Task containing the RPC response.

Overrides

ReportInstanceInfo(ReportInstanceInfoRequest, CallSettings)

public override Operation<Instance, OperationMetadata> ReportInstanceInfo(ReportInstanceInfoRequest request, CallSettings callSettings = null)

Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

Parameters
NameDescription
requestReportInstanceInfoRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Instance, OperationMetadata>

The RPC response.

Overrides

ReportInstanceInfoAsync(ReportInstanceInfoRequest, CallSettings)

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

Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

Parameters
NameDescription
requestReportInstanceInfoRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Instance, OperationMetadata>>

A Task containing the RPC response.

Overrides

ResetInstance(ResetInstanceRequest, CallSettings)

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

Resets a notebook instance.

Parameters
NameDescription
requestResetInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Instance, OperationMetadata>

The RPC response.

Overrides

ResetInstanceAsync(ResetInstanceRequest, CallSettings)

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

Resets a notebook instance.

Parameters
NameDescription
requestResetInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Instance, OperationMetadata>>

A Task containing the RPC response.

Overrides

SetInstanceAccelerator(SetInstanceAcceleratorRequest, CallSettings)

public override Operation<Instance, OperationMetadata> SetInstanceAccelerator(SetInstanceAcceleratorRequest request, CallSettings callSettings = null)

Updates the guest accelerators of a single Instance.

Parameters
NameDescription
requestSetInstanceAcceleratorRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Instance, OperationMetadata>

The RPC response.

Overrides

SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, CallSettings)

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

Updates the guest accelerators of a single Instance.

Parameters
NameDescription
requestSetInstanceAcceleratorRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Instance, OperationMetadata>>

A Task containing the RPC response.

Overrides

SetInstanceLabels(SetInstanceLabelsRequest, CallSettings)

public override Operation<Instance, OperationMetadata> SetInstanceLabels(SetInstanceLabelsRequest request, CallSettings callSettings = null)

Updates the labels of an Instance.

Parameters
NameDescription
requestSetInstanceLabelsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Instance, OperationMetadata>

The RPC response.

Overrides

SetInstanceLabelsAsync(SetInstanceLabelsRequest, CallSettings)

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

Updates the labels of an Instance.

Parameters
NameDescription
requestSetInstanceLabelsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Instance, OperationMetadata>>

A Task containing the RPC response.

Overrides

SetInstanceMachineType(SetInstanceMachineTypeRequest, CallSettings)

public override Operation<Instance, OperationMetadata> SetInstanceMachineType(SetInstanceMachineTypeRequest request, CallSettings callSettings = null)

Updates the machine type of a single Instance.

Parameters
NameDescription
requestSetInstanceMachineTypeRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Instance, OperationMetadata>

The RPC response.

Overrides

SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, CallSettings)

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

Updates the machine type of a single Instance.

Parameters
NameDescription
requestSetInstanceMachineTypeRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Instance, OperationMetadata>>

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Instance, OperationMetadata>

The RPC response.

Overrides

StartInstanceAsync(StartInstanceRequest, CallSettings)

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

Starts a notebook instance.

Parameters
NameDescription
requestStartInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Instance, OperationMetadata>>

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Instance, OperationMetadata>

The RPC response.

Overrides

StopInstanceAsync(StopInstanceRequest, CallSettings)

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

Stops a notebook instance.

Parameters
NameDescription
requestStopInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Instance, OperationMetadata>>

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Instance, OperationMetadata>

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Instance, OperationMetadata>>

A Task containing the RPC response.

Overrides

UpgradeInstanceInternal(UpgradeInstanceInternalRequest, CallSettings)

public override Operation<Instance, OperationMetadata> UpgradeInstanceInternal(UpgradeInstanceInternalRequest request, CallSettings callSettings = null)

Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.

Parameters
NameDescription
requestUpgradeInstanceInternalRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Instance, OperationMetadata>

The RPC response.

Overrides

UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest, CallSettings)

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

Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.

Parameters
NameDescription
requestUpgradeInstanceInternalRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Instance, OperationMetadata>>

A Task containing the RPC response.

Overrides