AI Platform Notebooks v1beta1 API - Class NotebookServiceClientImpl (2.0.0-beta04)

Version 2.0.0-beta04

• 2.0.0-beta05 (latest)
• 2.0.0-beta04
• 1.0.0-beta04

public sealed class NotebookServiceClientImpl : NotebookServiceClient

Reference documentation and code samples for the AI Platform Notebooks v1beta1 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.GetInstanceAsync(GetInstanceRequest, CancellationToken)

NotebookServiceClient.CreateInstanceAsync(CreateInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceCreateInstance(string, CallSettings)

NotebookServiceClient.PollOnceCreateInstanceAsync(string, CallSettings)

NotebookServiceClient.RegisterInstanceAsync(RegisterInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceRegisterInstance(string, CallSettings)

NotebookServiceClient.PollOnceRegisterInstanceAsync(string, CallSettings)

NotebookServiceClient.SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, CancellationToken)

NotebookServiceClient.PollOnceSetInstanceAccelerator(string, CallSettings)

NotebookServiceClient.PollOnceSetInstanceAcceleratorAsync(string, CallSettings)

NotebookServiceClient.SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, CancellationToken)

NotebookServiceClient.PollOnceSetInstanceMachineType(string, CallSettings)

NotebookServiceClient.PollOnceSetInstanceMachineTypeAsync(string, CallSettings)

NotebookServiceClient.SetInstanceLabelsAsync(SetInstanceLabelsRequest, CancellationToken)

NotebookServiceClient.PollOnceSetInstanceLabels(string, CallSettings)

NotebookServiceClient.PollOnceSetInstanceLabelsAsync(string, CallSettings)

NotebookServiceClient.DeleteInstanceAsync(DeleteInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceDeleteInstance(string, CallSettings)

NotebookServiceClient.PollOnceDeleteInstanceAsync(string, CallSettings)

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.ReportInstanceInfoAsync(ReportInstanceInfoRequest, CancellationToken)

NotebookServiceClient.PollOnceReportInstanceInfo(string, CallSettings)

NotebookServiceClient.PollOnceReportInstanceInfoAsync(string, CallSettings)

NotebookServiceClient.IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, CancellationToken)

NotebookServiceClient.UpgradeInstanceAsync(UpgradeInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceUpgradeInstance(string, CallSettings)

NotebookServiceClient.PollOnceUpgradeInstanceAsync(string, CallSettings)

NotebookServiceClient.UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest, CancellationToken)

NotebookServiceClient.PollOnceUpgradeInstanceInternal(string, CallSettings)

NotebookServiceClient.PollOnceUpgradeInstanceInternalAsync(string, CallSettings)

NotebookServiceClient.GetEnvironmentAsync(GetEnvironmentRequest, CancellationToken)

NotebookServiceClient.CreateEnvironmentAsync(CreateEnvironmentRequest, CancellationToken)

NotebookServiceClient.PollOnceCreateEnvironment(string, CallSettings)

NotebookServiceClient.PollOnceCreateEnvironmentAsync(string, CallSettings)

NotebookServiceClient.DeleteEnvironmentAsync(DeleteEnvironmentRequest, CancellationToken)

NotebookServiceClient.PollOnceDeleteEnvironment(string, CallSettings)

NotebookServiceClient.PollOnceDeleteEnvironmentAsync(string, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Notebooks.V1Beta1

Assembly

Google.Cloud.Notebooks.V1Beta1.dll

Remarks

API v1beta1 service for Cloud AI Platform Notebooks.

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

CreateEnvironmentOperationsClient

public override OperationsClient CreateEnvironmentOperationsClient { get; }

The long-running operations client for CreateEnvironment.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.CreateEnvironmentOperationsClient

CreateInstanceOperationsClient

public override OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.CreateInstanceOperationsClient

DeleteEnvironmentOperationsClient

public override OperationsClient DeleteEnvironmentOperationsClient { get; }

The long-running operations client for DeleteEnvironment.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.DeleteEnvironmentOperationsClient

DeleteInstanceOperationsClient

public override OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.DeleteInstanceOperationsClient

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

RegisterInstanceOperationsClient

public override OperationsClient RegisterInstanceOperationsClient { get; }

The long-running operations client for RegisterInstance.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.RegisterInstanceOperationsClient

ReportInstanceInfoOperationsClient

public override OperationsClient ReportInstanceInfoOperationsClient { get; }

The long-running operations client for ReportInstanceInfo.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.ReportInstanceInfoOperationsClient

ResetInstanceOperationsClient

public override OperationsClient ResetInstanceOperationsClient { get; }

The long-running operations client for ResetInstance.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.ResetInstanceOperationsClient

SetInstanceAcceleratorOperationsClient

public override OperationsClient SetInstanceAcceleratorOperationsClient { get; }

The long-running operations client for SetInstanceAccelerator.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.SetInstanceAcceleratorOperationsClient

SetInstanceLabelsOperationsClient

public override OperationsClient SetInstanceLabelsOperationsClient { get; }

The long-running operations client for SetInstanceLabels.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.SetInstanceLabelsOperationsClient

SetInstanceMachineTypeOperationsClient

public override OperationsClient SetInstanceMachineTypeOperationsClient { get; }

The long-running operations client for SetInstanceMachineType.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.SetInstanceMachineTypeOperationsClient

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

UpgradeInstanceInternalOperationsClient

public override OperationsClient UpgradeInstanceInternalOperationsClient { get; }

The long-running operations client for UpgradeInstanceInternal.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.UpgradeInstanceInternalOperationsClient

UpgradeInstanceOperationsClient

public override OperationsClient UpgradeInstanceOperationsClient { get; }

The long-running operations client for UpgradeInstance.

Property Value
Type	Description
OperationsClient

Overrides

NotebookServiceClient.UpgradeInstanceOperationsClient

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
OperationEnvironmentOperationMetadata	The RPC response.

Overrides

NotebookServiceClient.CreateEnvironment(CreateEnvironmentRequest, CallSettings)

CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

public override 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
TaskOperationEnvironmentOperationMetadata	A Task containing the RPC response.

Overrides

NotebookServiceClient.CreateEnvironmentAsync(CreateEnvironmentRequest, 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)

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
OperationEmptyOperationMetadata	The RPC response.

Overrides

NotebookServiceClient.DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

public override 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
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Overrides

NotebookServiceClient.DeleteEnvironmentAsync(DeleteEnvironmentRequest, 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)

GetEnvironment(GetEnvironmentRequest, CallSettings)

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

Gets details of a single Environment.

Parameters
Name	Description
request	GetEnvironmentRequest 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
Environment	The RPC response.

Overrides

NotebookServiceClient.GetEnvironment(GetEnvironmentRequest, CallSettings)

GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

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

Gets details of a single Environment.

Parameters
Name	Description
request	GetEnvironmentRequest 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
TaskEnvironment	A Task containing the RPC response.

Overrides

NotebookServiceClient.GetEnvironmentAsync(GetEnvironmentRequest, 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)

IsInstanceUpgradeable(IsInstanceUpgradeableRequest, CallSettings)

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

Check if a notebook instance is upgradable. Deprecated. Please consider using v1.

Parameters
Name	Description
request	IsInstanceUpgradeableRequest 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
IsInstanceUpgradeableResponse	The RPC response.

Overrides

NotebookServiceClient.IsInstanceUpgradeable(IsInstanceUpgradeableRequest, CallSettings)

IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, CallSettings)

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

Check if a notebook instance is upgradable. Deprecated. Please consider using v1.

Parameters
Name	Description
request	IsInstanceUpgradeableRequest 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
TaskIsInstanceUpgradeableResponse	A Task containing the RPC response.

Overrides

NotebookServiceClient.IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, CallSettings)

ListEnvironments(ListEnvironmentsRequest, CallSettings)

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

Lists environments in a project.

Parameters
Name	Description
request	ListEnvironmentsRequest 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
PagedEnumerableListEnvironmentsResponseEnvironment	A pageable sequence of Environment resources.

Overrides

NotebookServiceClient.ListEnvironments(ListEnvironmentsRequest, CallSettings)

ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

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

Lists environments in a project.

Parameters
Name	Description
request	ListEnvironmentsRequest 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
PagedAsyncEnumerableListEnvironmentsResponseEnvironment	A pageable asynchronous sequence of Environment resources.

Overrides

NotebookServiceClient.ListEnvironmentsAsync(ListEnvironmentsRequest, 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)

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
Name	Description
request	RegisterInstanceRequest 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.RegisterInstance(RegisterInstanceRequest, CallSettings)

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
Name	Description
request	RegisterInstanceRequest 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.RegisterInstanceAsync(RegisterInstanceRequest, CallSettings)

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
Name	Description
request	ReportInstanceInfoRequest 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.ReportInstanceInfo(ReportInstanceInfoRequest, CallSettings)

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
Name	Description
request	ReportInstanceInfoRequest 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.ReportInstanceInfoAsync(ReportInstanceInfoRequest, 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)

SetInstanceAccelerator(SetInstanceAcceleratorRequest, CallSettings)

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

Updates the guest accelerators of a single Instance.

Parameters
Name	Description
request	SetInstanceAcceleratorRequest 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.SetInstanceAccelerator(SetInstanceAcceleratorRequest, CallSettings)

SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, CallSettings)

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

Updates the guest accelerators of a single Instance.

Parameters
Name	Description
request	SetInstanceAcceleratorRequest 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.SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, CallSettings)

SetInstanceLabels(SetInstanceLabelsRequest, CallSettings)

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

Updates the labels of an Instance.

Parameters
Name	Description
request	SetInstanceLabelsRequest 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.SetInstanceLabels(SetInstanceLabelsRequest, CallSettings)

SetInstanceLabelsAsync(SetInstanceLabelsRequest, CallSettings)

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

Updates the labels of an Instance.

Parameters
Name	Description
request	SetInstanceLabelsRequest 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.SetInstanceLabelsAsync(SetInstanceLabelsRequest, CallSettings)

SetInstanceMachineType(SetInstanceMachineTypeRequest, CallSettings)

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

Updates the machine type of a single Instance.

Parameters
Name	Description
request	SetInstanceMachineTypeRequest 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.SetInstanceMachineType(SetInstanceMachineTypeRequest, CallSettings)

SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, CallSettings)

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

Updates the machine type of a single Instance.

Parameters
Name	Description
request	SetInstanceMachineTypeRequest 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.SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, 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)

UpgradeInstance(UpgradeInstanceRequest, CallSettings)

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

Upgrades a notebook instance to the latest version. Deprecated. Please consider using v1.

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)

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

Upgrades a notebook instance to the latest version. Deprecated. Please consider using v1.

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)

UpgradeInstanceInternal(UpgradeInstanceInternalRequest, CallSettings)

[Obsolete]
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. Deprecated. Please consider using v1.

Parameters
Name	Description
request	UpgradeInstanceInternalRequest 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.UpgradeInstanceInternal(UpgradeInstanceInternalRequest, CallSettings)

UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest, CallSettings)

[Obsolete]
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. Deprecated. Please consider using v1.

Parameters
Name	Description
request	UpgradeInstanceInternalRequest 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.UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest, CallSettings)