Cloud AI Platform v1 API - Class NotebookService.NotebookServiceClient (3.5.0)

public class NotebookService.NotebookServiceClient : ClientBase<NotebookService.NotebookServiceClient>

Reference documentation and code samples for the Cloud AI Platform v1 API class NotebookService.NotebookServiceClient.

Client for NotebookService

Inheritance

object > ClientBase > ClientBaseNotebookServiceNotebookServiceClient > NotebookService.NotebookServiceClient

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.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
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

NotebookServiceClient(ChannelBase)

public NotebookServiceClient(ChannelBase channel)

Creates a new client for NotebookService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

NotebookServiceClient(ClientBaseConfiguration)

protected NotebookServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AssignNotebookRuntime(AssignNotebookRuntimeRequest, CallOptions)

public virtual Operation AssignNotebookRuntime(AssignNotebookRuntimeRequest request, CallOptions options)

Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.

Parameters
Name Description
request AssignNotebookRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

AssignNotebookRuntime(AssignNotebookRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.

Parameters
Name Description
request AssignNotebookRuntimeRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

AssignNotebookRuntimeAsync(AssignNotebookRuntimeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> AssignNotebookRuntimeAsync(AssignNotebookRuntimeRequest request, CallOptions options)

Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.

Parameters
Name Description
request AssignNotebookRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

AssignNotebookRuntimeAsync(AssignNotebookRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.

Parameters
Name Description
request AssignNotebookRuntimeRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type Description
IAMPolicyIAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateNotebookExecutionJob(CreateNotebookExecutionJobRequest, CallOptions)

public virtual Operation CreateNotebookExecutionJob(CreateNotebookExecutionJobRequest request, CallOptions options)

Creates a NotebookExecutionJob.

Parameters
Name Description
request CreateNotebookExecutionJobRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateNotebookExecutionJob(CreateNotebookExecutionJobRequest, Metadata, DateTime?, CancellationToken)

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

Creates a NotebookExecutionJob.

Parameters
Name Description
request CreateNotebookExecutionJobRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateNotebookExecutionJobAsync(CreateNotebookExecutionJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateNotebookExecutionJobAsync(CreateNotebookExecutionJobRequest request, CallOptions options)

Creates a NotebookExecutionJob.

Parameters
Name Description
request CreateNotebookExecutionJobRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateNotebookExecutionJobAsync(CreateNotebookExecutionJobRequest, Metadata, DateTime?, CancellationToken)

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

Creates a NotebookExecutionJob.

Parameters
Name Description
request CreateNotebookExecutionJobRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateNotebookRuntimeTemplate(CreateNotebookRuntimeTemplateRequest, CallOptions)

public virtual Operation CreateNotebookRuntimeTemplate(CreateNotebookRuntimeTemplateRequest request, CallOptions options)

Creates a NotebookRuntimeTemplate.

Parameters
Name Description
request CreateNotebookRuntimeTemplateRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateNotebookRuntimeTemplate(CreateNotebookRuntimeTemplateRequest, Metadata, DateTime?, CancellationToken)

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

Creates a NotebookRuntimeTemplate.

Parameters
Name Description
request CreateNotebookRuntimeTemplateRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateNotebookRuntimeTemplateAsync(CreateNotebookRuntimeTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateNotebookRuntimeTemplateAsync(CreateNotebookRuntimeTemplateRequest request, CallOptions options)

Creates a NotebookRuntimeTemplate.

Parameters
Name Description
request CreateNotebookRuntimeTemplateRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateNotebookRuntimeTemplateAsync(CreateNotebookRuntimeTemplateRequest, Metadata, DateTime?, CancellationToken)

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

Creates a NotebookRuntimeTemplate.

Parameters
Name Description
request CreateNotebookRuntimeTemplateRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

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
Type Description
OperationsOperationsClient

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

DeleteNotebookExecutionJob(DeleteNotebookExecutionJobRequest, CallOptions)

public virtual Operation DeleteNotebookExecutionJob(DeleteNotebookExecutionJobRequest request, CallOptions options)

Deletes a NotebookExecutionJob.

Parameters
Name Description
request DeleteNotebookExecutionJobRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteNotebookExecutionJob(DeleteNotebookExecutionJobRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a NotebookExecutionJob.

Parameters
Name Description
request DeleteNotebookExecutionJobRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteNotebookExecutionJobAsync(DeleteNotebookExecutionJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteNotebookExecutionJobAsync(DeleteNotebookExecutionJobRequest request, CallOptions options)

Deletes a NotebookExecutionJob.

Parameters
Name Description
request DeleteNotebookExecutionJobRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteNotebookExecutionJobAsync(DeleteNotebookExecutionJobRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a NotebookExecutionJob.

Parameters
Name Description
request DeleteNotebookExecutionJobRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteNotebookRuntime(DeleteNotebookRuntimeRequest, CallOptions)

public virtual Operation DeleteNotebookRuntime(DeleteNotebookRuntimeRequest request, CallOptions options)

Deletes a NotebookRuntime.

Parameters
Name Description
request DeleteNotebookRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteNotebookRuntime(DeleteNotebookRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a NotebookRuntime.

Parameters
Name Description
request DeleteNotebookRuntimeRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteNotebookRuntimeAsync(DeleteNotebookRuntimeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteNotebookRuntimeAsync(DeleteNotebookRuntimeRequest request, CallOptions options)

Deletes a NotebookRuntime.

Parameters
Name Description
request DeleteNotebookRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteNotebookRuntimeAsync(DeleteNotebookRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a NotebookRuntime.

Parameters
Name Description
request DeleteNotebookRuntimeRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteNotebookRuntimeTemplate(DeleteNotebookRuntimeTemplateRequest, CallOptions)

public virtual Operation DeleteNotebookRuntimeTemplate(DeleteNotebookRuntimeTemplateRequest request, CallOptions options)

Deletes a NotebookRuntimeTemplate.

Parameters
Name Description
request DeleteNotebookRuntimeTemplateRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteNotebookRuntimeTemplate(DeleteNotebookRuntimeTemplateRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a NotebookRuntimeTemplate.

Parameters
Name Description
request DeleteNotebookRuntimeTemplateRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteNotebookRuntimeTemplateAsync(DeleteNotebookRuntimeTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteNotebookRuntimeTemplateAsync(DeleteNotebookRuntimeTemplateRequest request, CallOptions options)

Deletes a NotebookRuntimeTemplate.

Parameters
Name Description
request DeleteNotebookRuntimeTemplateRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteNotebookRuntimeTemplateAsync(DeleteNotebookRuntimeTemplateRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a NotebookRuntimeTemplate.

Parameters
Name Description
request DeleteNotebookRuntimeTemplateRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

GetNotebookExecutionJob(GetNotebookExecutionJobRequest, CallOptions)

public virtual NotebookExecutionJob GetNotebookExecutionJob(GetNotebookExecutionJobRequest request, CallOptions options)

Gets a NotebookExecutionJob.

Parameters
Name Description
request GetNotebookExecutionJobRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
NotebookExecutionJob

The response received from the server.

GetNotebookExecutionJob(GetNotebookExecutionJobRequest, Metadata, DateTime?, CancellationToken)

public virtual NotebookExecutionJob GetNotebookExecutionJob(GetNotebookExecutionJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a NotebookExecutionJob.

Parameters
Name Description
request GetNotebookExecutionJobRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
NotebookExecutionJob

The response received from the server.

GetNotebookExecutionJobAsync(GetNotebookExecutionJobRequest, CallOptions)

public virtual AsyncUnaryCall<NotebookExecutionJob> GetNotebookExecutionJobAsync(GetNotebookExecutionJobRequest request, CallOptions options)

Gets a NotebookExecutionJob.

Parameters
Name Description
request GetNotebookExecutionJobRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallNotebookExecutionJob

The call object.

GetNotebookExecutionJobAsync(GetNotebookExecutionJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NotebookExecutionJob> GetNotebookExecutionJobAsync(GetNotebookExecutionJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a NotebookExecutionJob.

Parameters
Name Description
request GetNotebookExecutionJobRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallNotebookExecutionJob

The call object.

GetNotebookRuntime(GetNotebookRuntimeRequest, CallOptions)

public virtual NotebookRuntime GetNotebookRuntime(GetNotebookRuntimeRequest request, CallOptions options)

Gets a NotebookRuntime.

Parameters
Name Description
request GetNotebookRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
NotebookRuntime

The response received from the server.

GetNotebookRuntime(GetNotebookRuntimeRequest, Metadata, DateTime?, CancellationToken)

public virtual NotebookRuntime GetNotebookRuntime(GetNotebookRuntimeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a NotebookRuntime.

Parameters
Name Description
request GetNotebookRuntimeRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
NotebookRuntime

The response received from the server.

GetNotebookRuntimeAsync(GetNotebookRuntimeRequest, CallOptions)

public virtual AsyncUnaryCall<NotebookRuntime> GetNotebookRuntimeAsync(GetNotebookRuntimeRequest request, CallOptions options)

Gets a NotebookRuntime.

Parameters
Name Description
request GetNotebookRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallNotebookRuntime

The call object.

GetNotebookRuntimeAsync(GetNotebookRuntimeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NotebookRuntime> GetNotebookRuntimeAsync(GetNotebookRuntimeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a NotebookRuntime.

Parameters
Name Description
request GetNotebookRuntimeRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallNotebookRuntime

The call object.

GetNotebookRuntimeTemplate(GetNotebookRuntimeTemplateRequest, CallOptions)

public virtual NotebookRuntimeTemplate GetNotebookRuntimeTemplate(GetNotebookRuntimeTemplateRequest request, CallOptions options)

Gets a NotebookRuntimeTemplate.

Parameters
Name Description
request GetNotebookRuntimeTemplateRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
NotebookRuntimeTemplate

The response received from the server.

GetNotebookRuntimeTemplate(GetNotebookRuntimeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual NotebookRuntimeTemplate GetNotebookRuntimeTemplate(GetNotebookRuntimeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a NotebookRuntimeTemplate.

Parameters
Name Description
request GetNotebookRuntimeTemplateRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
NotebookRuntimeTemplate

The response received from the server.

GetNotebookRuntimeTemplateAsync(GetNotebookRuntimeTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<NotebookRuntimeTemplate> GetNotebookRuntimeTemplateAsync(GetNotebookRuntimeTemplateRequest request, CallOptions options)

Gets a NotebookRuntimeTemplate.

Parameters
Name Description
request GetNotebookRuntimeTemplateRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallNotebookRuntimeTemplate

The call object.

GetNotebookRuntimeTemplateAsync(GetNotebookRuntimeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NotebookRuntimeTemplate> GetNotebookRuntimeTemplateAsync(GetNotebookRuntimeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a NotebookRuntimeTemplate.

Parameters
Name Description
request GetNotebookRuntimeTemplateRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallNotebookRuntimeTemplate

The call object.

ListNotebookExecutionJobs(ListNotebookExecutionJobsRequest, CallOptions)

public virtual ListNotebookExecutionJobsResponse ListNotebookExecutionJobs(ListNotebookExecutionJobsRequest request, CallOptions options)

Lists NotebookExecutionJobs in a Location.

Parameters
Name Description
request ListNotebookExecutionJobsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListNotebookExecutionJobsResponse

The response received from the server.

ListNotebookExecutionJobs(ListNotebookExecutionJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListNotebookExecutionJobsResponse ListNotebookExecutionJobs(ListNotebookExecutionJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists NotebookExecutionJobs in a Location.

Parameters
Name Description
request ListNotebookExecutionJobsRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListNotebookExecutionJobsResponse

The response received from the server.

ListNotebookExecutionJobsAsync(ListNotebookExecutionJobsRequest, CallOptions)

public virtual AsyncUnaryCall<ListNotebookExecutionJobsResponse> ListNotebookExecutionJobsAsync(ListNotebookExecutionJobsRequest request, CallOptions options)

Lists NotebookExecutionJobs in a Location.

Parameters
Name Description
request ListNotebookExecutionJobsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListNotebookExecutionJobsResponse

The call object.

ListNotebookExecutionJobsAsync(ListNotebookExecutionJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListNotebookExecutionJobsResponse> ListNotebookExecutionJobsAsync(ListNotebookExecutionJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists NotebookExecutionJobs in a Location.

Parameters
Name Description
request ListNotebookExecutionJobsRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListNotebookExecutionJobsResponse

The call object.

ListNotebookRuntimeTemplates(ListNotebookRuntimeTemplatesRequest, CallOptions)

public virtual ListNotebookRuntimeTemplatesResponse ListNotebookRuntimeTemplates(ListNotebookRuntimeTemplatesRequest request, CallOptions options)

Lists NotebookRuntimeTemplates in a Location.

Parameters
Name Description
request ListNotebookRuntimeTemplatesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListNotebookRuntimeTemplatesResponse

The response received from the server.

ListNotebookRuntimeTemplates(ListNotebookRuntimeTemplatesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListNotebookRuntimeTemplatesResponse ListNotebookRuntimeTemplates(ListNotebookRuntimeTemplatesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists NotebookRuntimeTemplates in a Location.

Parameters
Name Description
request ListNotebookRuntimeTemplatesRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListNotebookRuntimeTemplatesResponse

The response received from the server.

ListNotebookRuntimeTemplatesAsync(ListNotebookRuntimeTemplatesRequest, CallOptions)

public virtual AsyncUnaryCall<ListNotebookRuntimeTemplatesResponse> ListNotebookRuntimeTemplatesAsync(ListNotebookRuntimeTemplatesRequest request, CallOptions options)

Lists NotebookRuntimeTemplates in a Location.

Parameters
Name Description
request ListNotebookRuntimeTemplatesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListNotebookRuntimeTemplatesResponse

The call object.

ListNotebookRuntimeTemplatesAsync(ListNotebookRuntimeTemplatesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListNotebookRuntimeTemplatesResponse> ListNotebookRuntimeTemplatesAsync(ListNotebookRuntimeTemplatesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists NotebookRuntimeTemplates in a Location.

Parameters
Name Description
request ListNotebookRuntimeTemplatesRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListNotebookRuntimeTemplatesResponse

The call object.

ListNotebookRuntimes(ListNotebookRuntimesRequest, CallOptions)

public virtual ListNotebookRuntimesResponse ListNotebookRuntimes(ListNotebookRuntimesRequest request, CallOptions options)

Lists NotebookRuntimes in a Location.

Parameters
Name Description
request ListNotebookRuntimesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListNotebookRuntimesResponse

The response received from the server.

ListNotebookRuntimes(ListNotebookRuntimesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListNotebookRuntimesResponse ListNotebookRuntimes(ListNotebookRuntimesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists NotebookRuntimes in a Location.

Parameters
Name Description
request ListNotebookRuntimesRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListNotebookRuntimesResponse

The response received from the server.

ListNotebookRuntimesAsync(ListNotebookRuntimesRequest, CallOptions)

public virtual AsyncUnaryCall<ListNotebookRuntimesResponse> ListNotebookRuntimesAsync(ListNotebookRuntimesRequest request, CallOptions options)

Lists NotebookRuntimes in a Location.

Parameters
Name Description
request ListNotebookRuntimesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListNotebookRuntimesResponse

The call object.

ListNotebookRuntimesAsync(ListNotebookRuntimesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListNotebookRuntimesResponse> ListNotebookRuntimesAsync(ListNotebookRuntimesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists NotebookRuntimes in a Location.

Parameters
Name Description
request ListNotebookRuntimesRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListNotebookRuntimesResponse

The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
NotebookServiceNotebookServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.AIPlatform.V1.NotebookService.NotebookServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

StartNotebookRuntime(StartNotebookRuntimeRequest, CallOptions)

public virtual Operation StartNotebookRuntime(StartNotebookRuntimeRequest request, CallOptions options)

Starts a NotebookRuntime.

Parameters
Name Description
request StartNotebookRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

StartNotebookRuntime(StartNotebookRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Starts a NotebookRuntime.

Parameters
Name Description
request StartNotebookRuntimeRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

StartNotebookRuntimeAsync(StartNotebookRuntimeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StartNotebookRuntimeAsync(StartNotebookRuntimeRequest request, CallOptions options)

Starts a NotebookRuntime.

Parameters
Name Description
request StartNotebookRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

StartNotebookRuntimeAsync(StartNotebookRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Starts a NotebookRuntime.

Parameters
Name Description
request StartNotebookRuntimeRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateNotebookRuntimeTemplate(UpdateNotebookRuntimeTemplateRequest, CallOptions)

public virtual NotebookRuntimeTemplate UpdateNotebookRuntimeTemplate(UpdateNotebookRuntimeTemplateRequest request, CallOptions options)

Updates a NotebookRuntimeTemplate.

Parameters
Name Description
request UpdateNotebookRuntimeTemplateRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
NotebookRuntimeTemplate

The response received from the server.

UpdateNotebookRuntimeTemplate(UpdateNotebookRuntimeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual NotebookRuntimeTemplate UpdateNotebookRuntimeTemplate(UpdateNotebookRuntimeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a NotebookRuntimeTemplate.

Parameters
Name Description
request UpdateNotebookRuntimeTemplateRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
NotebookRuntimeTemplate

The response received from the server.

UpdateNotebookRuntimeTemplateAsync(UpdateNotebookRuntimeTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<NotebookRuntimeTemplate> UpdateNotebookRuntimeTemplateAsync(UpdateNotebookRuntimeTemplateRequest request, CallOptions options)

Updates a NotebookRuntimeTemplate.

Parameters
Name Description
request UpdateNotebookRuntimeTemplateRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallNotebookRuntimeTemplate

The call object.

UpdateNotebookRuntimeTemplateAsync(UpdateNotebookRuntimeTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NotebookRuntimeTemplate> UpdateNotebookRuntimeTemplateAsync(UpdateNotebookRuntimeTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a NotebookRuntimeTemplate.

Parameters
Name Description
request UpdateNotebookRuntimeTemplateRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallNotebookRuntimeTemplate

The call object.

UpgradeNotebookRuntime(UpgradeNotebookRuntimeRequest, CallOptions)

public virtual Operation UpgradeNotebookRuntime(UpgradeNotebookRuntimeRequest request, CallOptions options)

Upgrades a NotebookRuntime.

Parameters
Name Description
request UpgradeNotebookRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpgradeNotebookRuntime(UpgradeNotebookRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Upgrades a NotebookRuntime.

Parameters
Name Description
request UpgradeNotebookRuntimeRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

UpgradeNotebookRuntimeAsync(UpgradeNotebookRuntimeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpgradeNotebookRuntimeAsync(UpgradeNotebookRuntimeRequest request, CallOptions options)

Upgrades a NotebookRuntime.

Parameters
Name Description
request UpgradeNotebookRuntimeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpgradeNotebookRuntimeAsync(UpgradeNotebookRuntimeRequest, Metadata, DateTime?, CancellationToken)

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

Upgrades a NotebookRuntime.

Parameters
Name Description
request UpgradeNotebookRuntimeRequest

The request to send to the server.

headers Metadata

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

deadline System.DateTime

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.