Class NotebookService.NotebookServiceClient

public class NotebookServiceClient : ClientBase<NotebookService.NotebookServiceClient>

Client for NotebookService

Inheritance

Object > ClientBase > ClientBase<NotebookService.NotebookServiceClient> > NotebookService.NotebookServiceClient

Namespace

Google.Cloud.Notebooks.V1Beta1

Assembly

Google.Cloud.Notebooks.V1Beta1.dll

Constructors

NotebookServiceClient()

protected NotebookServiceClient()

Protected parameterless constructor to allow creation of test doubles.

NotebookServiceClient(CallInvoker)

public NotebookServiceClient(CallInvoker callInvoker)

Creates a new client for NotebookService that uses a custom CallInvoker.

Parameter
TypeNameDescription
CallInvokercallInvoker

The callInvoker to use to make remote calls.

NotebookServiceClient(ChannelBase)

public NotebookServiceClient(ChannelBase channel)

Creates a new client for NotebookService

Parameter
TypeNameDescription
ChannelBasechannel

The channel to use to make remote calls.

NotebookServiceClient(ClientBase.ClientBaseConfiguration)

protected NotebookServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
TypeNameDescription
ClientBase.ClientBaseConfigurationconfiguration

The client configuration.

Methods

CreateEnvironment(CreateEnvironmentRequest, CallOptions)

public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, CallOptions options)

Creates a new Environment.

Parameters
TypeNameDescription
CreateEnvironmentRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateEnvironment(CreateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a new Environment.

Parameters
TypeNameDescription
CreateEnvironmentRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateEnvironmentAsync(CreateEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallOptions options)

Creates a new Environment.

Parameters
TypeNameDescription
CreateEnvironmentRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateEnvironmentAsync(CreateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateEnvironmentAsync(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a new Environment.

Parameters
TypeNameDescription
CreateEnvironmentRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateInstance(CreateInstanceRequest, CallOptions)

public virtual Operation CreateInstance(CreateInstanceRequest request, CallOptions options)

Creates a new Instance in a given project and location.

Parameters
TypeNameDescription
CreateInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateInstance(CreateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateInstance(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a new Instance in a given project and location.

Parameters
TypeNameDescription
CreateInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateInstanceAsync(CreateInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, CallOptions options)

Creates a new Instance in a given project and location.

Parameters
TypeNameDescription
CreateInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateInstanceAsync(CreateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a new Instance in a given project and location.

Parameters
TypeNameDescription
CreateInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

DeleteEnvironment(DeleteEnvironmentRequest, CallOptions)

public virtual Operation DeleteEnvironment(DeleteEnvironmentRequest request, CallOptions options)

Deletes a single Environment.

Parameters
TypeNameDescription
DeleteEnvironmentRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteEnvironment(DeleteEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteEnvironment(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes a single Environment.

Parameters
TypeNameDescription
DeleteEnvironmentRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CallOptions options)

Deletes a single Environment.

Parameters
TypeNameDescription
DeleteEnvironmentRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes a single Environment.

Parameters
TypeNameDescription
DeleteEnvironmentRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteInstance(DeleteInstanceRequest, CallOptions)

public virtual Operation DeleteInstance(DeleteInstanceRequest request, CallOptions options)

Deletes a single Instance.

Parameters
TypeNameDescription
DeleteInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteInstance(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteInstance(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes a single Instance.

Parameters
TypeNameDescription
DeleteInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteInstanceAsync(DeleteInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, CallOptions options)

Deletes a single Instance.

Parameters
TypeNameDescription
DeleteInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteInstanceAsync(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes a single Instance.

Parameters
TypeNameDescription
DeleteInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

GetEnvironment(GetEnvironmentRequest, CallOptions)

public virtual Environment GetEnvironment(GetEnvironmentRequest request, CallOptions options)

Gets details of a single Environment.

Parameters
TypeNameDescription
GetEnvironmentRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Environment

The response received from the server.

GetEnvironment(GetEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Environment GetEnvironment(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single Environment.

Parameters
TypeNameDescription
GetEnvironmentRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Environment

The response received from the server.

GetEnvironmentAsync(GetEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CallOptions options)

Gets details of a single Environment.

Parameters
TypeNameDescription
GetEnvironmentRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Environment>

The call object.

GetEnvironmentAsync(GetEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single Environment.

Parameters
TypeNameDescription
GetEnvironmentRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Environment>

The call object.

GetInstance(GetInstanceRequest, CallOptions)

public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)

Gets details of a single Instance.

Parameters
TypeNameDescription
GetInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Instance

The response received from the server.

GetInstance(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Instance GetInstance(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single Instance.

Parameters
TypeNameDescription
GetInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Instance

The response received from the server.

GetInstanceAsync(GetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, CallOptions options)

Gets details of a single Instance.

Parameters
TypeNameDescription
GetInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Instance>

The call object.

GetInstanceAsync(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single Instance.

Parameters
TypeNameDescription
GetInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Instance>

The call object.

IsInstanceUpgradeable(IsInstanceUpgradeableRequest, CallOptions)

public virtual IsInstanceUpgradeableResponse IsInstanceUpgradeable(IsInstanceUpgradeableRequest request, CallOptions options)

Check if a notebook instance is upgradable.

Parameters
TypeNameDescription
IsInstanceUpgradeableRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
IsInstanceUpgradeableResponse

The response received from the server.

IsInstanceUpgradeable(IsInstanceUpgradeableRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual IsInstanceUpgradeableResponse IsInstanceUpgradeable(IsInstanceUpgradeableRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Check if a notebook instance is upgradable.

Parameters
TypeNameDescription
IsInstanceUpgradeableRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
IsInstanceUpgradeableResponse

The response received from the server.

IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, CallOptions)

public virtual AsyncUnaryCall<IsInstanceUpgradeableResponse> IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest request, CallOptions options)

Check if a notebook instance is upgradable.

Parameters
TypeNameDescription
IsInstanceUpgradeableRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<IsInstanceUpgradeableResponse>

The call object.

IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<IsInstanceUpgradeableResponse> IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Check if a notebook instance is upgradable.

Parameters
TypeNameDescription
IsInstanceUpgradeableRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<IsInstanceUpgradeableResponse>

The call object.

ListEnvironments(ListEnvironmentsRequest, CallOptions)

public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, CallOptions options)

Lists environments in a project.

Parameters
TypeNameDescription
ListEnvironmentsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
ListEnvironmentsResponse

The response received from the server.

ListEnvironments(ListEnvironmentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists environments in a project.

Parameters
TypeNameDescription
ListEnvironmentsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListEnvironmentsResponse

The response received from the server.

ListEnvironmentsAsync(ListEnvironmentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEnvironmentsResponse> ListEnvironmentsAsync(ListEnvironmentsRequest request, CallOptions options)

Lists environments in a project.

Parameters
TypeNameDescription
ListEnvironmentsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListEnvironmentsResponse>

The call object.

ListEnvironmentsAsync(ListEnvironmentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListEnvironmentsResponse> ListEnvironmentsAsync(ListEnvironmentsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists environments in a project.

Parameters
TypeNameDescription
ListEnvironmentsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListEnvironmentsResponse>

The call object.

ListInstances(ListInstancesRequest, CallOptions)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, CallOptions options)

Lists instances in a given project and location.

Parameters
TypeNameDescription
ListInstancesRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
ListInstancesResponse

The response received from the server.

ListInstances(ListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists instances in a given project and location.

Parameters
TypeNameDescription
ListInstancesRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListInstancesResponse

The response received from the server.

ListInstancesAsync(ListInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, CallOptions options)

Lists instances in a given project and location.

Parameters
TypeNameDescription
ListInstancesRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListInstancesResponse>

The call object.

ListInstancesAsync(ListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists instances in a given project and location.

Parameters
TypeNameDescription
ListInstancesRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListInstancesResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override NotebookService.NotebookServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
TypeNameDescription
ClientBase.ClientBaseConfigurationconfiguration
Returns
TypeDescription
NotebookService.NotebookServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Notebooks.V1Beta1.NotebookService.NotebookServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

RegisterInstance(RegisterInstanceRequest, CallOptions)

public virtual Operation RegisterInstance(RegisterInstanceRequest request, CallOptions options)

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
TypeNameDescription
RegisterInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RegisterInstance(RegisterInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation RegisterInstance(RegisterInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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
TypeNameDescription
RegisterInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

RegisterInstanceAsync(RegisterInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RegisterInstanceAsync(RegisterInstanceRequest request, CallOptions options)

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
TypeNameDescription
RegisterInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

RegisterInstanceAsync(RegisterInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> RegisterInstanceAsync(RegisterInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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
TypeNameDescription
RegisterInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ReportInstanceInfo(ReportInstanceInfoRequest, CallOptions)

public virtual Operation ReportInstanceInfo(ReportInstanceInfoRequest request, CallOptions options)

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
TypeNameDescription
ReportInstanceInfoRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ReportInstanceInfo(ReportInstanceInfoRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ReportInstanceInfo(ReportInstanceInfoRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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
TypeNameDescription
ReportInstanceInfoRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ReportInstanceInfoAsync(ReportInstanceInfoRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ReportInstanceInfoAsync(ReportInstanceInfoRequest request, CallOptions options)

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
TypeNameDescription
ReportInstanceInfoRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ReportInstanceInfoAsync(ReportInstanceInfoRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ReportInstanceInfoAsync(ReportInstanceInfoRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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
TypeNameDescription
ReportInstanceInfoRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ResetInstance(ResetInstanceRequest, CallOptions)

public virtual Operation ResetInstance(ResetInstanceRequest request, CallOptions options)

Resets a notebook instance.

Parameters
TypeNameDescription
ResetInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ResetInstance(ResetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ResetInstance(ResetInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Resets a notebook instance.

Parameters
TypeNameDescription
ResetInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ResetInstanceAsync(ResetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ResetInstanceAsync(ResetInstanceRequest request, CallOptions options)

Resets a notebook instance.

Parameters
TypeNameDescription
ResetInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ResetInstanceAsync(ResetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ResetInstanceAsync(ResetInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Resets a notebook instance.

Parameters
TypeNameDescription
ResetInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetInstanceAccelerator(SetInstanceAcceleratorRequest, CallOptions)

public virtual Operation SetInstanceAccelerator(SetInstanceAcceleratorRequest request, CallOptions options)

Updates the guest accelerators of a single Instance.

Parameters
TypeNameDescription
SetInstanceAcceleratorRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetInstanceAccelerator(SetInstanceAcceleratorRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation SetInstanceAccelerator(SetInstanceAcceleratorRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the guest accelerators of a single Instance.

Parameters
TypeNameDescription
SetInstanceAcceleratorRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest request, CallOptions options)

Updates the guest accelerators of a single Instance.

Parameters
TypeNameDescription
SetInstanceAcceleratorRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the guest accelerators of a single Instance.

Parameters
TypeNameDescription
SetInstanceAcceleratorRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetInstanceLabels(SetInstanceLabelsRequest, CallOptions)

public virtual Operation SetInstanceLabels(SetInstanceLabelsRequest request, CallOptions options)

Updates the labels of an Instance.

Parameters
TypeNameDescription
SetInstanceLabelsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetInstanceLabels(SetInstanceLabelsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation SetInstanceLabels(SetInstanceLabelsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the labels of an Instance.

Parameters
TypeNameDescription
SetInstanceLabelsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetInstanceLabelsAsync(SetInstanceLabelsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetInstanceLabelsAsync(SetInstanceLabelsRequest request, CallOptions options)

Updates the labels of an Instance.

Parameters
TypeNameDescription
SetInstanceLabelsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetInstanceLabelsAsync(SetInstanceLabelsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetInstanceLabelsAsync(SetInstanceLabelsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the labels of an Instance.

Parameters
TypeNameDescription
SetInstanceLabelsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetInstanceMachineType(SetInstanceMachineTypeRequest, CallOptions)

public virtual Operation SetInstanceMachineType(SetInstanceMachineTypeRequest request, CallOptions options)

Updates the machine type of a single Instance.

Parameters
TypeNameDescription
SetInstanceMachineTypeRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetInstanceMachineType(SetInstanceMachineTypeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation SetInstanceMachineType(SetInstanceMachineTypeRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the machine type of a single Instance.

Parameters
TypeNameDescription
SetInstanceMachineTypeRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest request, CallOptions options)

Updates the machine type of a single Instance.

Parameters
TypeNameDescription
SetInstanceMachineTypeRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the machine type of a single Instance.

Parameters
TypeNameDescription
SetInstanceMachineTypeRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StartInstance(StartInstanceRequest, CallOptions)

public virtual Operation StartInstance(StartInstanceRequest request, CallOptions options)

Starts a notebook instance.

Parameters
TypeNameDescription
StartInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

StartInstance(StartInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation StartInstance(StartInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Starts a notebook instance.

Parameters
TypeNameDescription
StartInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

StartInstanceAsync(StartInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StartInstanceAsync(StartInstanceRequest request, CallOptions options)

Starts a notebook instance.

Parameters
TypeNameDescription
StartInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StartInstanceAsync(StartInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> StartInstanceAsync(StartInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Starts a notebook instance.

Parameters
TypeNameDescription
StartInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StopInstance(StopInstanceRequest, CallOptions)

public virtual Operation StopInstance(StopInstanceRequest request, CallOptions options)

Stops a notebook instance.

Parameters
TypeNameDescription
StopInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

StopInstance(StopInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation StopInstance(StopInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Stops a notebook instance.

Parameters
TypeNameDescription
StopInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

StopInstanceAsync(StopInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StopInstanceAsync(StopInstanceRequest request, CallOptions options)

Stops a notebook instance.

Parameters
TypeNameDescription
StopInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StopInstanceAsync(StopInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> StopInstanceAsync(StopInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Stops a notebook instance.

Parameters
TypeNameDescription
StopInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpgradeInstance(UpgradeInstanceRequest, CallOptions)

public virtual Operation UpgradeInstance(UpgradeInstanceRequest request, CallOptions options)

Upgrades a notebook instance to the latest version.

Parameters
TypeNameDescription
UpgradeInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpgradeInstance(UpgradeInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpgradeInstance(UpgradeInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Upgrades a notebook instance to the latest version.

Parameters
TypeNameDescription
UpgradeInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpgradeInstanceAsync(UpgradeInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpgradeInstanceAsync(UpgradeInstanceRequest request, CallOptions options)

Upgrades a notebook instance to the latest version.

Parameters
TypeNameDescription
UpgradeInstanceRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpgradeInstanceAsync(UpgradeInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpgradeInstanceAsync(UpgradeInstanceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Upgrades a notebook instance to the latest version.

Parameters
TypeNameDescription
UpgradeInstanceRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpgradeInstanceInternal(UpgradeInstanceInternalRequest, CallOptions)

public virtual Operation UpgradeInstanceInternal(UpgradeInstanceInternalRequest request, CallOptions options)

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

Parameters
TypeNameDescription
UpgradeInstanceInternalRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpgradeInstanceInternal(UpgradeInstanceInternalRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpgradeInstanceInternal(UpgradeInstanceInternalRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
TypeNameDescription
UpgradeInstanceInternalRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest request, CallOptions options)

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

Parameters
TypeNameDescription
UpgradeInstanceInternalRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
TypeNameDescription
UpgradeInstanceInternalRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.