AI Platform Notebooks v1 API - Class NotebookServiceClientImpl (2.4.0) 

public sealed class NotebookServiceClientImpl : NotebookServiceClient

Reference documentation and code samples for the AI Platform Notebooks v1 API class NotebookServiceClientImpl.

NotebookService client wrapper implementation, for convenient use.

Inheritance

object > NotebookServiceClient > NotebookServiceClientImpl

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Remarks

API v1 service for Cloud AI Platform Notebooks.

Constructors

NotebookServiceClientImpl(NotebookServiceClient, NotebookServiceSettings, ILogger)

public NotebookServiceClientImpl(NotebookService.NotebookServiceClient grpcClient, NotebookServiceSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient NotebookServiceNotebookServiceClient

The underlying gRPC client.
settings NotebookServiceSettings

The base NotebookServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateEnvironmentOperationsClient

public override OperationsClient CreateEnvironmentOperationsClient { get; }

The long-running operations client for CreateEnvironment.

Property Value
Type Description
OperationsClient
Overrides

CreateExecutionOperationsClient

public override OperationsClient CreateExecutionOperationsClient { get; }

The long-running operations client for CreateExecution.

Property Value
Type Description
OperationsClient
Overrides

CreateInstanceOperationsClient

public override OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
Type Description
OperationsClient
Overrides

CreateScheduleOperationsClient

public override OperationsClient CreateScheduleOperationsClient { get; }

The long-running operations client for CreateSchedule.

Property Value
Type Description
OperationsClient
Overrides

DeleteEnvironmentOperationsClient

public override OperationsClient DeleteEnvironmentOperationsClient { get; }

The long-running operations client for DeleteEnvironment.

Property Value
Type Description
OperationsClient
Overrides

DeleteExecutionOperationsClient

public override OperationsClient DeleteExecutionOperationsClient { get; }

The long-running operations client for DeleteExecution.

Property Value
Type Description
OperationsClient
Overrides

DeleteInstanceOperationsClient

public override OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value
Type Description
OperationsClient
Overrides

DeleteScheduleOperationsClient

public override OperationsClient DeleteScheduleOperationsClient { get; }

The long-running operations client for DeleteSchedule.

Property Value
Type Description
OperationsClient
Overrides

DiagnoseInstanceOperationsClient

public override OperationsClient DiagnoseInstanceOperationsClient { get; }

The long-running operations client for DiagnoseInstance.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override NotebookService.NotebookServiceClient GrpcClient { get; }

The underlying gRPC NotebookService client

Property Value
Type Description
NotebookServiceNotebookServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

RegisterInstanceOperationsClient

public override OperationsClient RegisterInstanceOperationsClient { get; }

The long-running operations client for RegisterInstance.

Property Value
Type Description
OperationsClient
Overrides

ReportInstanceInfoOperationsClient

public override OperationsClient ReportInstanceInfoOperationsClient { get; }

The long-running operations client for ReportInstanceInfo.

Property Value
Type Description
OperationsClient
Overrides

ResetInstanceOperationsClient

public override OperationsClient ResetInstanceOperationsClient { get; }

The long-running operations client for ResetInstance.

Property Value
Type Description
OperationsClient
Overrides

RollbackInstanceOperationsClient

public override OperationsClient RollbackInstanceOperationsClient { get; }

The long-running operations client for RollbackInstance.

Property Value
Type Description
OperationsClient
Overrides

SetInstanceAcceleratorOperationsClient

public override OperationsClient SetInstanceAcceleratorOperationsClient { get; }

The long-running operations client for SetInstanceAccelerator.

Property Value
Type Description
OperationsClient
Overrides

SetInstanceLabelsOperationsClient

public override OperationsClient SetInstanceLabelsOperationsClient { get; }

The long-running operations client for SetInstanceLabels.

Property Value
Type Description
OperationsClient
Overrides

SetInstanceMachineTypeOperationsClient

public override OperationsClient SetInstanceMachineTypeOperationsClient { get; }

The long-running operations client for SetInstanceMachineType.

Property Value
Type Description
OperationsClient
Overrides

StartInstanceOperationsClient

public override OperationsClient StartInstanceOperationsClient { get; }

The long-running operations client for StartInstance.

Property Value
Type Description
OperationsClient
Overrides

StopInstanceOperationsClient

public override OperationsClient StopInstanceOperationsClient { get; }

The long-running operations client for StopInstance.

Property Value
Type Description
OperationsClient
Overrides

TriggerScheduleOperationsClient

public override OperationsClient TriggerScheduleOperationsClient { get; }

The long-running operations client for TriggerSchedule.

Property Value
Type Description
OperationsClient
Overrides

UpdateInstanceConfigOperationsClient

public override OperationsClient UpdateInstanceConfigOperationsClient { get; }

The long-running operations client for UpdateInstanceConfig.

Property Value
Type Description
OperationsClient
Overrides

UpdateShieldedInstanceConfigOperationsClient

public override OperationsClient UpdateShieldedInstanceConfigOperationsClient { get; }

The long-running operations client for UpdateShieldedInstanceConfig.

Property Value
Type Description
OperationsClient
Overrides

UpgradeInstanceInternalOperationsClient

public override OperationsClient UpgradeInstanceInternalOperationsClient { get; }

The long-running operations client for UpgradeInstanceInternal.

Property Value
Type Description
OperationsClient
Overrides

UpgradeInstanceOperationsClient

public override OperationsClient UpgradeInstanceOperationsClient { get; }

The long-running operations client for UpgradeInstance.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateEnvironment(CreateEnvironmentRequest, CallSettings)

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

Creates a new Environment.

Parameters
Name Description
request CreateEnvironmentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEnvironmentOperationMetadata

The RPC response.
Overrides

CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

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

Creates a new Environment.

Parameters
Name Description
request CreateEnvironmentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEnvironmentOperationMetadata

A Task containing the RPC response.
Overrides

CreateExecution(CreateExecutionRequest, CallSettings)

public override Operation<Execution, OperationMetadata> CreateExecution(CreateExecutionRequest request, CallSettings callSettings = null)

Creates a new Execution in a given project and location.

Parameters
Name Description
request CreateExecutionRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationExecutionOperationMetadata

The RPC response.
Overrides

CreateExecutionAsync(CreateExecutionRequest, CallSettings)

public override Task<Operation<Execution, OperationMetadata>> CreateExecutionAsync(CreateExecutionRequest request, CallSettings callSettings = null)

Creates a new Execution in a given project and location.

Parameters
Name Description
request CreateExecutionRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationExecutionOperationMetadata

A Task containing the RPC response.
Overrides

CreateInstance(CreateInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> CreateInstance(CreateInstanceRequest request, CallSettings callSettings = null)

Creates a new Instance in a given project and location.

Parameters
Name Description
request CreateInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

CreateInstanceAsync(CreateInstanceRequest, CallSettings)

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

Creates a new Instance in a given project and location.

Parameters
Name Description
request CreateInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

CreateSchedule(CreateScheduleRequest, CallSettings)

public override Operation<Schedule, OperationMetadata> CreateSchedule(CreateScheduleRequest request, CallSettings callSettings = null)

Creates a new Scheduled Notebook in a given project and location.

Parameters
Name Description
request CreateScheduleRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationScheduleOperationMetadata

The RPC response.
Overrides

CreateScheduleAsync(CreateScheduleRequest, CallSettings)

public override Task<Operation<Schedule, OperationMetadata>> CreateScheduleAsync(CreateScheduleRequest request, CallSettings callSettings = null)

Creates a new Scheduled Notebook in a given project and location.

Parameters
Name Description
request CreateScheduleRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationScheduleOperationMetadata

A Task containing the RPC response.
Overrides

DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

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

Deletes a single Environment.

Parameters
Name Description
request DeleteEnvironmentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

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

Deletes a single Environment.

Parameters
Name Description
request DeleteEnvironmentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteExecution(DeleteExecutionRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteExecution(DeleteExecutionRequest request, CallSettings callSettings = null)

Deletes execution

Parameters
Name Description
request DeleteExecutionRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteExecutionAsync(DeleteExecutionRequest, CallSettings)

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

Deletes execution

Parameters
Name Description
request DeleteExecutionRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteInstance(DeleteInstanceRequest, CallSettings)

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

Deletes a single Instance.

Parameters
Name Description
request DeleteInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

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

Deletes a single Instance.

Parameters
Name Description
request DeleteInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteSchedule(DeleteScheduleRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteSchedule(DeleteScheduleRequest request, CallSettings callSettings = null)

Deletes schedule and all underlying jobs

Parameters
Name Description
request DeleteScheduleRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteScheduleAsync(DeleteScheduleRequest, CallSettings)

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

Deletes schedule and all underlying jobs

Parameters
Name Description
request DeleteScheduleRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DiagnoseInstance(DiagnoseInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> DiagnoseInstance(DiagnoseInstanceRequest request, CallSettings callSettings = null)

Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

Parameters
Name Description
request DiagnoseInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

DiagnoseInstanceAsync(DiagnoseInstanceRequest, CallSettings)

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

Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

Parameters
Name Description
request DiagnoseInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

GetEnvironment(GetEnvironmentRequest, CallSettings)

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

Gets details of a single Environment.

Parameters
Name Description
request GetEnvironmentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Environment

The RPC response.
Overrides

GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

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

Gets details of a single Environment.

Parameters
Name Description
request GetEnvironmentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskEnvironment

A Task containing the RPC response.
Overrides

GetExecution(GetExecutionRequest, CallSettings)

public override Execution GetExecution(GetExecutionRequest request, CallSettings callSettings = null)

Gets details of executions

Parameters
Name Description
request GetExecutionRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Execution

The RPC response.
Overrides

GetExecutionAsync(GetExecutionRequest, CallSettings)

public override Task<Execution> GetExecutionAsync(GetExecutionRequest request, CallSettings callSettings = null)

Gets details of executions

Parameters
Name Description
request GetExecutionRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskExecution

A Task containing the RPC response.
Overrides

GetInstance(GetInstanceRequest, CallSettings)

public override Instance GetInstance(GetInstanceRequest request, CallSettings callSettings = null)

Gets details of a single Instance.

Parameters
Name Description
request GetInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Instance

The RPC response.
Overrides

GetInstanceAsync(GetInstanceRequest, CallSettings)

public override Task<Instance> GetInstanceAsync(GetInstanceRequest request, CallSettings callSettings = null)

Gets details of a single Instance.

Parameters
Name Description
request GetInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskInstance

A Task containing the RPC response.
Overrides

GetInstanceHealth(GetInstanceHealthRequest, CallSettings)

public override GetInstanceHealthResponse GetInstanceHealth(GetInstanceHealthRequest request, CallSettings callSettings = null)

Check if a notebook instance is healthy.

Parameters
Name Description
request GetInstanceHealthRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
GetInstanceHealthResponse

The RPC response.
Overrides

GetInstanceHealthAsync(GetInstanceHealthRequest, CallSettings)

public override Task<GetInstanceHealthResponse> GetInstanceHealthAsync(GetInstanceHealthRequest request, CallSettings callSettings = null)

Check if a notebook instance is healthy.

Parameters
Name Description
request GetInstanceHealthRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskGetInstanceHealthResponse

A Task containing the RPC response.
Overrides

GetSchedule(GetScheduleRequest, CallSettings)

public override Schedule GetSchedule(GetScheduleRequest request, CallSettings callSettings = null)

Gets details of schedule

Parameters
Name Description
request GetScheduleRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Schedule

The RPC response.
Overrides

GetScheduleAsync(GetScheduleRequest, CallSettings)

public override Task<Schedule> GetScheduleAsync(GetScheduleRequest request, CallSettings callSettings = null)

Gets details of schedule

Parameters
Name Description
request GetScheduleRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSchedule

A Task containing the RPC response.
Overrides

IsInstanceUpgradeable(IsInstanceUpgradeableRequest, CallSettings)

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

Check if a notebook instance is upgradable.

Parameters
Name Description
request IsInstanceUpgradeableRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
IsInstanceUpgradeableResponse

The RPC response.
Overrides

IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, CallSettings)

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

Check if a notebook instance is upgradable.

Parameters
Name Description
request IsInstanceUpgradeableRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskIsInstanceUpgradeableResponse

A Task containing the RPC response.
Overrides

ListEnvironments(ListEnvironmentsRequest, CallSettings)

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

Lists environments in a project.

Parameters
Name Description
request ListEnvironmentsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListEnvironmentsResponseEnvironment

A pageable sequence of Environment resources.
Overrides

ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

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

Lists environments in a project.

Parameters
Name Description
request ListEnvironmentsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListEnvironmentsResponseEnvironment

A pageable asynchronous sequence of Environment resources.
Overrides

ListExecutions(ListExecutionsRequest, CallSettings)

public override PagedEnumerable<ListExecutionsResponse, Execution> ListExecutions(ListExecutionsRequest request, CallSettings callSettings = null)

Lists executions in a given project and location

Parameters
Name Description
request ListExecutionsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListExecutionsResponseExecution

A pageable sequence of Execution resources.
Overrides

ListExecutionsAsync(ListExecutionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListExecutionsResponse, Execution> ListExecutionsAsync(ListExecutionsRequest request, CallSettings callSettings = null)

Lists executions in a given project and location

Parameters
Name Description
request ListExecutionsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListExecutionsResponseExecution

A pageable asynchronous sequence of Execution resources.
Overrides

ListInstances(ListInstancesRequest, CallSettings)

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

Lists instances in a given project and location.

Parameters
Name Description
request ListInstancesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListInstancesResponseInstance

A pageable sequence of Instance resources.
Overrides

ListInstancesAsync(ListInstancesRequest, CallSettings)

public override PagedAsyncEnumerable<ListInstancesResponse, Instance> ListInstancesAsync(ListInstancesRequest request, CallSettings callSettings = null)

Lists instances in a given project and location.

Parameters
Name Description
request ListInstancesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListInstancesResponseInstance

A pageable asynchronous sequence of Instance resources.
Overrides

ListSchedules(ListSchedulesRequest, CallSettings)

public override PagedEnumerable<ListSchedulesResponse, Schedule> ListSchedules(ListSchedulesRequest request, CallSettings callSettings = null)

Lists schedules in a given project and location.

Parameters
Name Description
request ListSchedulesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListSchedulesResponseSchedule

A pageable sequence of Schedule resources.
Overrides

ListSchedulesAsync(ListSchedulesRequest, CallSettings)

public override PagedAsyncEnumerable<ListSchedulesResponse, Schedule> ListSchedulesAsync(ListSchedulesRequest request, CallSettings callSettings = null)

Lists schedules in a given project and location.

Parameters
Name Description
request ListSchedulesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListSchedulesResponseSchedule

A pageable asynchronous sequence of Schedule resources.
Overrides

RegisterInstance(RegisterInstanceRequest, CallSettings)

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

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

Parameters
Name Description
request RegisterInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

RegisterInstanceAsync(RegisterInstanceRequest, CallSettings)

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

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

Parameters
Name Description
request RegisterInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

ReportInstanceInfo(ReportInstanceInfoRequest, CallSettings)

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

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

Parameters
Name Description
request ReportInstanceInfoRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

ReportInstanceInfoAsync(ReportInstanceInfoRequest, CallSettings)

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

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

Parameters
Name Description
request ReportInstanceInfoRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

ResetInstance(ResetInstanceRequest, CallSettings)

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

Resets a notebook instance.

Parameters
Name Description
request ResetInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

ResetInstanceAsync(ResetInstanceRequest, CallSettings)

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

Resets a notebook instance.

Parameters
Name Description
request ResetInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

RollbackInstance(RollbackInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> RollbackInstance(RollbackInstanceRequest request, CallSettings callSettings = null)

Rollbacks a notebook instance to the previous version.

Parameters
Name Description
request RollbackInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

RollbackInstanceAsync(RollbackInstanceRequest, CallSettings)

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

Rollbacks a notebook instance to the previous version.

Parameters
Name Description
request RollbackInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

SetInstanceAccelerator(SetInstanceAcceleratorRequest, CallSettings)

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

Updates the guest accelerators of a single Instance.

Parameters
Name Description
request SetInstanceAcceleratorRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, CallSettings)

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

Updates the guest accelerators of a single Instance.

Parameters
Name Description
request SetInstanceAcceleratorRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

SetInstanceLabels(SetInstanceLabelsRequest, CallSettings)

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

Replaces all the labels of an Instance.

Parameters
Name Description
request SetInstanceLabelsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

SetInstanceLabelsAsync(SetInstanceLabelsRequest, CallSettings)

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

Replaces all the labels of an Instance.

Parameters
Name Description
request SetInstanceLabelsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

SetInstanceMachineType(SetInstanceMachineTypeRequest, CallSettings)

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

Updates the machine type of a single Instance.

Parameters
Name Description
request SetInstanceMachineTypeRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, CallSettings)

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

Updates the machine type of a single Instance.

Parameters
Name Description
request SetInstanceMachineTypeRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

StartInstance(StartInstanceRequest, CallSettings)

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

Starts a notebook instance.

Parameters
Name Description
request StartInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

StartInstanceAsync(StartInstanceRequest, CallSettings)

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

Starts a notebook instance.

Parameters
Name Description
request StartInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

StopInstance(StopInstanceRequest, CallSettings)

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

Stops a notebook instance.

Parameters
Name Description
request StopInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

StopInstanceAsync(StopInstanceRequest, CallSettings)

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

Stops a notebook instance.

Parameters
Name Description
request StopInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

TriggerSchedule(TriggerScheduleRequest, CallSettings)

public override Operation<Schedule, OperationMetadata> TriggerSchedule(TriggerScheduleRequest request, CallSettings callSettings = null)

Triggers execution of an existing schedule.

Parameters
Name Description
request TriggerScheduleRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationScheduleOperationMetadata

The RPC response.
Overrides

TriggerScheduleAsync(TriggerScheduleRequest, CallSettings)

public override Task<Operation<Schedule, OperationMetadata>> TriggerScheduleAsync(TriggerScheduleRequest request, CallSettings callSettings = null)

Triggers execution of an existing schedule.

Parameters
Name Description
request TriggerScheduleRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationScheduleOperationMetadata

A Task containing the RPC response.
Overrides

UpdateInstanceConfig(UpdateInstanceConfigRequest, CallSettings)

public override Operation<Instance, OperationMetadata> UpdateInstanceConfig(UpdateInstanceConfigRequest request, CallSettings callSettings = null)

Update Notebook Instance configurations.

Parameters
Name Description
request UpdateInstanceConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

UpdateInstanceConfigAsync(UpdateInstanceConfigRequest, CallSettings)

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

Update Notebook Instance configurations.

Parameters
Name Description
request UpdateInstanceConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest, CallSettings)

public override UpdateInstanceMetadataItemsResponse UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request, CallSettings callSettings = null)

Add/update metadata items for an instance.

Parameters
Name Description
request UpdateInstanceMetadataItemsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
UpdateInstanceMetadataItemsResponse

The RPC response.
Overrides

UpdateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest, CallSettings)

public override Task<UpdateInstanceMetadataItemsResponse> UpdateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest request, CallSettings callSettings = null)

Add/update metadata items for an instance.

Parameters
Name Description
request UpdateInstanceMetadataItemsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskUpdateInstanceMetadataItemsResponse

A Task containing the RPC response.
Overrides

UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest, CallSettings)

public override Operation<Instance, OperationMetadata> UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request, CallSettings callSettings = null)

Updates the Shielded instance configuration of a single Instance.

Parameters
Name Description
request UpdateShieldedInstanceConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigRequest, CallSettings)

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

Updates the Shielded instance configuration of a single Instance.

Parameters
Name Description
request UpdateShieldedInstanceConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

UpgradeInstance(UpgradeInstanceRequest, CallSettings)

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

Upgrades a notebook instance to the latest version.

Parameters
Name Description
request UpgradeInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

UpgradeInstanceAsync(UpgradeInstanceRequest, CallSettings)

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

Upgrades a notebook instance to the latest version.

Parameters
Name Description
request UpgradeInstanceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

UpgradeInstanceInternal(UpgradeInstanceInternalRequest, CallSettings)

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

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

Parameters
Name Description
request UpgradeInstanceInternalRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest, CallSettings)

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

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

Parameters
Name Description
request UpgradeInstanceInternalRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides