AI Platform Notebooks v1 API - Class NotebookServiceClientImpl (2.0.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

Inherited Members

NotebookServiceClient.DefaultEndpoint

NotebookServiceClient.DefaultScopes

NotebookServiceClient.ServiceMetadata

NotebookServiceClient.CreateAsync(CancellationToken)

NotebookServiceClient.Create()

NotebookServiceClient.ShutdownDefaultChannelsAsync()

NotebookServiceClient.ListInstances(String, String, Nullable<Int32>, CallSettings)

NotebookServiceClient.ListInstancesAsync(String, String, Nullable<Int32>, CallSettings)

NotebookServiceClient.GetInstanceAsync(GetInstanceRequest, CancellationToken)

NotebookServiceClient.GetInstance(String, CallSettings)

NotebookServiceClient.GetInstanceAsync(String, CallSettings)

NotebookServiceClient.GetInstanceAsync(String, CancellationToken)

NotebookServiceClient.CreateInstanceAsync(CreateInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceCreateInstance(String, CallSettings)

NotebookServiceClient.PollOnceCreateInstanceAsync(String, CallSettings)

NotebookServiceClient.CreateInstance(String, Instance, String, CallSettings)

NotebookServiceClient.CreateInstanceAsync(String, Instance, String, CallSettings)

NotebookServiceClient.CreateInstanceAsync(String, Instance, String, CancellationToken)

NotebookServiceClient.RegisterInstanceAsync(RegisterInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceRegisterInstance(String, CallSettings)

NotebookServiceClient.PollOnceRegisterInstanceAsync(String, CallSettings)

NotebookServiceClient.SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, CancellationToken)

NotebookServiceClient.PollOnceSetInstanceAccelerator(String, CallSettings)

NotebookServiceClient.PollOnceSetInstanceAcceleratorAsync(String, CallSettings)

NotebookServiceClient.SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, CancellationToken)

NotebookServiceClient.PollOnceSetInstanceMachineType(String, CallSettings)

NotebookServiceClient.PollOnceSetInstanceMachineTypeAsync(String, CallSettings)

NotebookServiceClient.UpdateInstanceConfigAsync(UpdateInstanceConfigRequest, CancellationToken)

NotebookServiceClient.PollOnceUpdateInstanceConfig(String, CallSettings)

NotebookServiceClient.PollOnceUpdateInstanceConfigAsync(String, CallSettings)

NotebookServiceClient.UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigRequest, CancellationToken)

NotebookServiceClient.PollOnceUpdateShieldedInstanceConfig(String, CallSettings)

NotebookServiceClient.PollOnceUpdateShieldedInstanceConfigAsync(String, CallSettings)

NotebookServiceClient.SetInstanceLabelsAsync(SetInstanceLabelsRequest, CancellationToken)

NotebookServiceClient.PollOnceSetInstanceLabels(String, CallSettings)

NotebookServiceClient.PollOnceSetInstanceLabelsAsync(String, CallSettings)

NotebookServiceClient.UpdateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest, CancellationToken)

NotebookServiceClient.DeleteInstanceAsync(DeleteInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceDeleteInstance(String, CallSettings)

NotebookServiceClient.PollOnceDeleteInstanceAsync(String, CallSettings)

NotebookServiceClient.DeleteInstance(String, CallSettings)

NotebookServiceClient.DeleteInstanceAsync(String, CallSettings)

NotebookServiceClient.DeleteInstanceAsync(String, CancellationToken)

NotebookServiceClient.StartInstanceAsync(StartInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceStartInstance(String, CallSettings)

NotebookServiceClient.PollOnceStartInstanceAsync(String, CallSettings)

NotebookServiceClient.StopInstanceAsync(StopInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceStopInstance(String, CallSettings)

NotebookServiceClient.PollOnceStopInstanceAsync(String, CallSettings)

NotebookServiceClient.ResetInstanceAsync(ResetInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceResetInstance(String, CallSettings)

NotebookServiceClient.PollOnceResetInstanceAsync(String, CallSettings)

NotebookServiceClient.ReportInstanceInfoAsync(ReportInstanceInfoRequest, CancellationToken)

NotebookServiceClient.PollOnceReportInstanceInfo(String, CallSettings)

NotebookServiceClient.PollOnceReportInstanceInfoAsync(String, CallSettings)

NotebookServiceClient.IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, CancellationToken)

NotebookServiceClient.GetInstanceHealthAsync(GetInstanceHealthRequest, CancellationToken)

NotebookServiceClient.GetInstanceHealth(String, CallSettings)

NotebookServiceClient.GetInstanceHealthAsync(String, CallSettings)

NotebookServiceClient.GetInstanceHealthAsync(String, CancellationToken)

NotebookServiceClient.GetInstanceHealth(InstanceName, CallSettings)

NotebookServiceClient.GetInstanceHealthAsync(InstanceName, CallSettings)

NotebookServiceClient.GetInstanceHealthAsync(InstanceName, CancellationToken)

NotebookServiceClient.UpgradeInstanceAsync(UpgradeInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceUpgradeInstance(String, CallSettings)

NotebookServiceClient.PollOnceUpgradeInstanceAsync(String, CallSettings)

NotebookServiceClient.RollbackInstanceAsync(RollbackInstanceRequest, CancellationToken)

NotebookServiceClient.PollOnceRollbackInstance(String, CallSettings)

NotebookServiceClient.PollOnceRollbackInstanceAsync(String, CallSettings)

NotebookServiceClient.UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest, CancellationToken)

NotebookServiceClient.PollOnceUpgradeInstanceInternal(String, CallSettings)

NotebookServiceClient.PollOnceUpgradeInstanceInternalAsync(String, CallSettings)

NotebookServiceClient.ListEnvironments(String, String, Nullable<Int32>, CallSettings)

NotebookServiceClient.ListEnvironmentsAsync(String, String, Nullable<Int32>, CallSettings)

NotebookServiceClient.GetEnvironmentAsync(GetEnvironmentRequest, CancellationToken)

NotebookServiceClient.GetEnvironment(String, CallSettings)

NotebookServiceClient.GetEnvironmentAsync(String, CallSettings)

NotebookServiceClient.GetEnvironmentAsync(String, CancellationToken)

NotebookServiceClient.CreateEnvironmentAsync(CreateEnvironmentRequest, CancellationToken)

NotebookServiceClient.PollOnceCreateEnvironment(String, CallSettings)

NotebookServiceClient.PollOnceCreateEnvironmentAsync(String, CallSettings)

NotebookServiceClient.CreateEnvironment(String, Environment, String, CallSettings)

NotebookServiceClient.CreateEnvironmentAsync(String, Environment, String, CallSettings)

NotebookServiceClient.CreateEnvironmentAsync(String, Environment, String, CancellationToken)

NotebookServiceClient.DeleteEnvironmentAsync(DeleteEnvironmentRequest, CancellationToken)

NotebookServiceClient.PollOnceDeleteEnvironment(String, CallSettings)

NotebookServiceClient.PollOnceDeleteEnvironmentAsync(String, CallSettings)

NotebookServiceClient.DeleteEnvironment(String, CallSettings)

NotebookServiceClient.DeleteEnvironmentAsync(String, CallSettings)

NotebookServiceClient.DeleteEnvironmentAsync(String, CancellationToken)

NotebookServiceClient.ListSchedules(String, String, Nullable<Int32>, CallSettings)

NotebookServiceClient.ListSchedulesAsync(String, String, Nullable<Int32>, CallSettings)

NotebookServiceClient.ListSchedules(ScheduleName, String, Nullable<Int32>, CallSettings)

NotebookServiceClient.ListSchedulesAsync(ScheduleName, String, Nullable<Int32>, CallSettings)

NotebookServiceClient.GetScheduleAsync(GetScheduleRequest, CancellationToken)

NotebookServiceClient.GetSchedule(String, CallSettings)

NotebookServiceClient.GetScheduleAsync(String, CallSettings)

NotebookServiceClient.GetScheduleAsync(String, CancellationToken)

NotebookServiceClient.GetSchedule(ScheduleName, CallSettings)

NotebookServiceClient.GetScheduleAsync(ScheduleName, CallSettings)

NotebookServiceClient.GetScheduleAsync(ScheduleName, CancellationToken)

NotebookServiceClient.DeleteScheduleAsync(DeleteScheduleRequest, CancellationToken)

NotebookServiceClient.PollOnceDeleteSchedule(String, CallSettings)

NotebookServiceClient.PollOnceDeleteScheduleAsync(String, CallSettings)

NotebookServiceClient.DeleteSchedule(String, CallSettings)

NotebookServiceClient.DeleteScheduleAsync(String, CallSettings)

NotebookServiceClient.DeleteScheduleAsync(String, CancellationToken)

NotebookServiceClient.DeleteSchedule(ScheduleName, CallSettings)

NotebookServiceClient.DeleteScheduleAsync(ScheduleName, CallSettings)

NotebookServiceClient.DeleteScheduleAsync(ScheduleName, CancellationToken)

NotebookServiceClient.CreateScheduleAsync(CreateScheduleRequest, CancellationToken)

NotebookServiceClient.PollOnceCreateSchedule(String, CallSettings)

NotebookServiceClient.PollOnceCreateScheduleAsync(String, CallSettings)

NotebookServiceClient.CreateSchedule(String, Schedule, String, CallSettings)

NotebookServiceClient.CreateScheduleAsync(String, Schedule, String, CallSettings)

NotebookServiceClient.CreateScheduleAsync(String, Schedule, String, CancellationToken)

NotebookServiceClient.CreateSchedule(ScheduleName, Schedule, String, CallSettings)

NotebookServiceClient.CreateScheduleAsync(ScheduleName, Schedule, String, CallSettings)

NotebookServiceClient.CreateScheduleAsync(ScheduleName, Schedule, String, CancellationToken)

NotebookServiceClient.TriggerScheduleAsync(TriggerScheduleRequest, CancellationToken)

NotebookServiceClient.PollOnceTriggerSchedule(String, CallSettings)

NotebookServiceClient.PollOnceTriggerScheduleAsync(String, CallSettings)

NotebookServiceClient.ListExecutions(String, String, Nullable<Int32>, CallSettings)

NotebookServiceClient.ListExecutionsAsync(String, String, Nullable<Int32>, CallSettings)

NotebookServiceClient.ListExecutions(ExecutionName, String, Nullable<Int32>, CallSettings)

NotebookServiceClient.ListExecutionsAsync(ExecutionName, String, Nullable<Int32>, CallSettings)

NotebookServiceClient.GetExecutionAsync(GetExecutionRequest, CancellationToken)

NotebookServiceClient.GetExecution(String, CallSettings)

NotebookServiceClient.GetExecutionAsync(String, CallSettings)

NotebookServiceClient.GetExecutionAsync(String, CancellationToken)

NotebookServiceClient.GetExecution(ExecutionName, CallSettings)

NotebookServiceClient.GetExecutionAsync(ExecutionName, CallSettings)

NotebookServiceClient.GetExecutionAsync(ExecutionName, CancellationToken)

NotebookServiceClient.DeleteExecutionAsync(DeleteExecutionRequest, CancellationToken)

NotebookServiceClient.PollOnceDeleteExecution(String, CallSettings)

NotebookServiceClient.PollOnceDeleteExecutionAsync(String, CallSettings)

NotebookServiceClient.DeleteExecution(String, CallSettings)

NotebookServiceClient.DeleteExecutionAsync(String, CallSettings)

NotebookServiceClient.DeleteExecutionAsync(String, CancellationToken)

NotebookServiceClient.DeleteExecution(ExecutionName, CallSettings)

NotebookServiceClient.DeleteExecutionAsync(ExecutionName, CallSettings)

NotebookServiceClient.DeleteExecutionAsync(ExecutionName, CancellationToken)

NotebookServiceClient.CreateExecutionAsync(CreateExecutionRequest, CancellationToken)

NotebookServiceClient.PollOnceCreateExecution(String, CallSettings)

NotebookServiceClient.PollOnceCreateExecutionAsync(String, CallSettings)

NotebookServiceClient.CreateExecution(String, Execution, String, CallSettings)

NotebookServiceClient.CreateExecutionAsync(String, Execution, String, CallSettings)

NotebookServiceClient.CreateExecutionAsync(String, Execution, String, CancellationToken)

NotebookServiceClient.CreateExecution(ExecutionName, Execution, String, CallSettings)

NotebookServiceClient.CreateExecutionAsync(ExecutionName, Execution, String, CallSettings)

NotebookServiceClient.CreateExecutionAsync(ExecutionName, Execution, String, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Remarks

API v1 service for Cloud AI Platform Notebooks.

Constructors

NotebookServiceClientImpl(NotebookService.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	NotebookService.NotebookServiceClient The underlying gRPC client.
settings	NotebookServiceSettings The base NotebookServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

CreateEnvironmentOperationsClient

public override OperationsClient CreateEnvironmentOperationsClient { get; }

The long-running operations client for CreateEnvironment.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.CreateEnvironmentOperationsClient

CreateExecutionOperationsClient

public override OperationsClient CreateExecutionOperationsClient { get; }

The long-running operations client for CreateExecution.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.CreateExecutionOperationsClient

CreateInstanceOperationsClient

public override OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.CreateInstanceOperationsClient

CreateScheduleOperationsClient

public override OperationsClient CreateScheduleOperationsClient { get; }

The long-running operations client for CreateSchedule.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.CreateScheduleOperationsClient

DeleteEnvironmentOperationsClient

public override OperationsClient DeleteEnvironmentOperationsClient { get; }

The long-running operations client for DeleteEnvironment.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.DeleteEnvironmentOperationsClient

DeleteExecutionOperationsClient

public override OperationsClient DeleteExecutionOperationsClient { get; }

The long-running operations client for DeleteExecution.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.DeleteExecutionOperationsClient

DeleteInstanceOperationsClient

public override OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.DeleteInstanceOperationsClient

DeleteScheduleOperationsClient

public override OperationsClient DeleteScheduleOperationsClient { get; }

The long-running operations client for DeleteSchedule.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.DeleteScheduleOperationsClient

GrpcClient

public override NotebookService.NotebookServiceClient GrpcClient { get; }

The underlying gRPC NotebookService client

Property Value

Type	Description
NotebookService.NotebookServiceClient

Overrides

NotebookServiceClient.GrpcClient

RegisterInstanceOperationsClient

public override OperationsClient RegisterInstanceOperationsClient { get; }

The long-running operations client for RegisterInstance.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.RegisterInstanceOperationsClient

ReportInstanceInfoOperationsClient

public override OperationsClient ReportInstanceInfoOperationsClient { get; }

The long-running operations client for ReportInstanceInfo.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.ReportInstanceInfoOperationsClient

ResetInstanceOperationsClient

public override OperationsClient ResetInstanceOperationsClient { get; }

The long-running operations client for ResetInstance.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.ResetInstanceOperationsClient

RollbackInstanceOperationsClient

public override OperationsClient RollbackInstanceOperationsClient { get; }

The long-running operations client for RollbackInstance.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.RollbackInstanceOperationsClient

SetInstanceAcceleratorOperationsClient

public override OperationsClient SetInstanceAcceleratorOperationsClient { get; }

The long-running operations client for SetInstanceAccelerator.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.SetInstanceAcceleratorOperationsClient

SetInstanceLabelsOperationsClient

public override OperationsClient SetInstanceLabelsOperationsClient { get; }

The long-running operations client for SetInstanceLabels.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.SetInstanceLabelsOperationsClient

SetInstanceMachineTypeOperationsClient

public override OperationsClient SetInstanceMachineTypeOperationsClient { get; }

The long-running operations client for SetInstanceMachineType.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.SetInstanceMachineTypeOperationsClient

StartInstanceOperationsClient

public override OperationsClient StartInstanceOperationsClient { get; }

The long-running operations client for StartInstance.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.StartInstanceOperationsClient

StopInstanceOperationsClient

public override OperationsClient StopInstanceOperationsClient { get; }

The long-running operations client for StopInstance.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.StopInstanceOperationsClient

TriggerScheduleOperationsClient

public override OperationsClient TriggerScheduleOperationsClient { get; }

The long-running operations client for TriggerSchedule.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.TriggerScheduleOperationsClient

UpdateInstanceConfigOperationsClient

public override OperationsClient UpdateInstanceConfigOperationsClient { get; }

The long-running operations client for UpdateInstanceConfig.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.UpdateInstanceConfigOperationsClient

UpdateShieldedInstanceConfigOperationsClient

public override OperationsClient UpdateShieldedInstanceConfigOperationsClient { get; }

The long-running operations client for UpdateShieldedInstanceConfig.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.UpdateShieldedInstanceConfigOperationsClient

UpgradeInstanceInternalOperationsClient

public override OperationsClient UpgradeInstanceInternalOperationsClient { get; }

The long-running operations client for UpgradeInstanceInternal.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.UpgradeInstanceInternalOperationsClient

UpgradeInstanceOperationsClient

public override OperationsClient UpgradeInstanceOperationsClient { get; }

The long-running operations client for UpgradeInstance.

Property Value

Type	Description
OperationsClient

Overrides

NotebookServiceClient.UpgradeInstanceOperationsClient

Methods

CreateEnvironment(CreateEnvironmentRequest, CallSettings)

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

Creates a new Environment.

Parameters

Name	Description
request	CreateEnvironmentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Environment, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.CreateEnvironment(CreateEnvironmentRequest, CallSettings)

CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

public override async 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
Task<Operation<Environment, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

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
Operation<Execution, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.CreateExecution(CreateExecutionRequest, CallSettings)

CreateExecutionAsync(CreateExecutionRequest, CallSettings)

public override async 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
Task<Operation<Execution, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.CreateExecutionAsync(CreateExecutionRequest, CallSettings)

CreateInstance(CreateInstanceRequest, CallSettings)

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

Creates a new Instance in a given project and location.

Parameters

Name	Description
request	CreateInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Instance, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.CreateInstance(CreateInstanceRequest, CallSettings)

CreateInstanceAsync(CreateInstanceRequest, CallSettings)

public override async 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
Task<Operation<Instance, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.CreateInstanceAsync(CreateInstanceRequest, CallSettings)

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
Operation<Schedule, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.CreateSchedule(CreateScheduleRequest, CallSettings)

CreateScheduleAsync(CreateScheduleRequest, CallSettings)

public override async 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
Task<Operation<Schedule, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.CreateScheduleAsync(CreateScheduleRequest, CallSettings)

DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

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

Deletes a single Environment.

Parameters

Name	Description
request	DeleteEnvironmentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Empty, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

public override async 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
Task<Operation<Empty, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

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
Operation<Empty, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.DeleteExecution(DeleteExecutionRequest, CallSettings)

DeleteExecutionAsync(DeleteExecutionRequest, CallSettings)

public override async 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
Task<Operation<Empty, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.DeleteExecutionAsync(DeleteExecutionRequest, CallSettings)

DeleteInstance(DeleteInstanceRequest, CallSettings)

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

Deletes a single Instance.

Parameters

Name	Description
request	DeleteInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Empty, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.DeleteInstance(DeleteInstanceRequest, CallSettings)

DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

public override async 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
Task<Operation<Empty, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

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
Operation<Empty, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.DeleteSchedule(DeleteScheduleRequest, CallSettings)

DeleteScheduleAsync(DeleteScheduleRequest, CallSettings)

public override async 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
Task<Operation<Empty, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.DeleteScheduleAsync(DeleteScheduleRequest, CallSettings)

GetEnvironment(GetEnvironmentRequest, CallSettings)

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

Gets details of a single Environment.

Parameters

Name	Description
request	GetEnvironmentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
Environment	The RPC response.

Overrides

NotebookServiceClient.GetEnvironment(GetEnvironmentRequest, CallSettings)

GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

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

Gets details of a single Environment.

Parameters

Name	Description
request	GetEnvironmentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Environment>	A Task containing the RPC response.

Overrides

NotebookServiceClient.GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

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

NotebookServiceClient.GetExecution(GetExecutionRequest, CallSettings)

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
Task<Execution>	A Task containing the RPC response.

Overrides

NotebookServiceClient.GetExecutionAsync(GetExecutionRequest, CallSettings)

GetInstance(GetInstanceRequest, CallSettings)

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

Gets details of a single Instance.

Parameters

Name	Description
request	GetInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
Instance	The RPC response.

Overrides

NotebookServiceClient.GetInstance(GetInstanceRequest, CallSettings)

GetInstanceAsync(GetInstanceRequest, CallSettings)

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

Gets details of a single Instance.

Parameters

Name	Description
request	GetInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Instance>	A Task containing the RPC response.

Overrides

NotebookServiceClient.GetInstanceAsync(GetInstanceRequest, CallSettings)

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

NotebookServiceClient.GetInstanceHealth(GetInstanceHealthRequest, CallSettings)

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
Task<GetInstanceHealthResponse>	A Task containing the RPC response.

Overrides

NotebookServiceClient.GetInstanceHealthAsync(GetInstanceHealthRequest, CallSettings)

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

NotebookServiceClient.GetSchedule(GetScheduleRequest, CallSettings)

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
Task<Schedule>	A Task containing the RPC response.

Overrides

NotebookServiceClient.GetScheduleAsync(GetScheduleRequest, CallSettings)

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

NotebookServiceClient.IsInstanceUpgradeable(IsInstanceUpgradeableRequest, CallSettings)

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
Task<IsInstanceUpgradeableResponse>	A Task containing the RPC response.

Overrides

NotebookServiceClient.IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, CallSettings)

ListEnvironments(ListEnvironmentsRequest, CallSettings)

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

Lists environments in a project.

Parameters

Name	Description
request	ListEnvironmentsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
PagedEnumerable<ListEnvironmentsResponse, Environment>	A pageable sequence of Environment resources.

Overrides

NotebookServiceClient.ListEnvironments(ListEnvironmentsRequest, CallSettings)

ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

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

Lists environments in a project.

Parameters

Name	Description
request	ListEnvironmentsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
PagedAsyncEnumerable<ListEnvironmentsResponse, Environment>	A pageable asynchronous sequence of Environment resources.

Overrides

NotebookServiceClient.ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

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
PagedEnumerable<ListExecutionsResponse, Execution>	A pageable sequence of Execution resources.

Overrides

NotebookServiceClient.ListExecutions(ListExecutionsRequest, CallSettings)

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
PagedAsyncEnumerable<ListExecutionsResponse, Execution>	A pageable asynchronous sequence of Execution resources.

Overrides

NotebookServiceClient.ListExecutionsAsync(ListExecutionsRequest, CallSettings)

ListInstances(ListInstancesRequest, CallSettings)

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

Lists instances in a given project and location.

Parameters

Name	Description
request	ListInstancesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
PagedEnumerable<ListInstancesResponse, Instance>	A pageable sequence of Instance resources.

Overrides

NotebookServiceClient.ListInstances(ListInstancesRequest, CallSettings)

ListInstancesAsync(ListInstancesRequest, CallSettings)

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

Lists instances in a given project and location.

Parameters

Name	Description
request	ListInstancesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
PagedAsyncEnumerable<ListInstancesResponse, Instance>	A pageable asynchronous sequence of Instance resources.

Overrides

NotebookServiceClient.ListInstancesAsync(ListInstancesRequest, CallSettings)

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
PagedEnumerable<ListSchedulesResponse, Schedule>	A pageable sequence of Schedule resources.

Overrides

NotebookServiceClient.ListSchedules(ListSchedulesRequest, CallSettings)

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
PagedAsyncEnumerable<ListSchedulesResponse, Schedule>	A pageable asynchronous sequence of Schedule resources.

Overrides

NotebookServiceClient.ListSchedulesAsync(ListSchedulesRequest, CallSettings)

RegisterInstance(RegisterInstanceRequest, CallSettings)

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

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

Parameters

Name	Description
request	RegisterInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Instance, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.RegisterInstance(RegisterInstanceRequest, CallSettings)

RegisterInstanceAsync(RegisterInstanceRequest, CallSettings)

public override async 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
Task<Operation<Instance, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.RegisterInstanceAsync(RegisterInstanceRequest, CallSettings)

ReportInstanceInfo(ReportInstanceInfoRequest, CallSettings)

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

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

Parameters

Name	Description
request	ReportInstanceInfoRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Instance, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.ReportInstanceInfo(ReportInstanceInfoRequest, CallSettings)

ReportInstanceInfoAsync(ReportInstanceInfoRequest, CallSettings)

public override async 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
Task<Operation<Instance, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.ReportInstanceInfoAsync(ReportInstanceInfoRequest, CallSettings)

ResetInstance(ResetInstanceRequest, CallSettings)

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

Resets a notebook instance.

Parameters

Name	Description
request	ResetInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Instance, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.ResetInstance(ResetInstanceRequest, CallSettings)

ResetInstanceAsync(ResetInstanceRequest, CallSettings)

public override async 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
Task<Operation<Instance, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.ResetInstanceAsync(ResetInstanceRequest, CallSettings)

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
Operation<Instance, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.RollbackInstance(RollbackInstanceRequest, CallSettings)

RollbackInstanceAsync(RollbackInstanceRequest, CallSettings)

public override async 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
Task<Operation<Instance, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.RollbackInstanceAsync(RollbackInstanceRequest, CallSettings)

SetInstanceAccelerator(SetInstanceAcceleratorRequest, CallSettings)

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

Updates the guest accelerators of a single Instance.

Parameters

Name	Description
request	SetInstanceAcceleratorRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Instance, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.SetInstanceAccelerator(SetInstanceAcceleratorRequest, CallSettings)

SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, CallSettings)

public override async 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
Task<Operation<Instance, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, CallSettings)

SetInstanceLabels(SetInstanceLabelsRequest, CallSettings)

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

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
Operation<Instance, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.SetInstanceLabels(SetInstanceLabelsRequest, CallSettings)

SetInstanceLabelsAsync(SetInstanceLabelsRequest, CallSettings)

public override async 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
Task<Operation<Instance, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.SetInstanceLabelsAsync(SetInstanceLabelsRequest, CallSettings)

SetInstanceMachineType(SetInstanceMachineTypeRequest, CallSettings)

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

Updates the machine type of a single Instance.

Parameters

Name	Description
request	SetInstanceMachineTypeRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Instance, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.SetInstanceMachineType(SetInstanceMachineTypeRequest, CallSettings)

SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, CallSettings)

public override async 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
Task<Operation<Instance, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, CallSettings)

StartInstance(StartInstanceRequest, CallSettings)

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

Starts a notebook instance.

Parameters

Name	Description
request	StartInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Instance, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.StartInstance(StartInstanceRequest, CallSettings)

StartInstanceAsync(StartInstanceRequest, CallSettings)

public override async 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
Task<Operation<Instance, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.StartInstanceAsync(StartInstanceRequest, CallSettings)

StopInstance(StopInstanceRequest, CallSettings)

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

Stops a notebook instance.

Parameters

Name	Description
request	StopInstanceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<Instance, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.StopInstance(StopInstanceRequest, CallSettings)

StopInstanceAsync(StopInstanceRequest, CallSettings)

public override async 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
Task<Operation<Instance, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.StopInstanceAsync(StopInstanceRequest, CallSettings)

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
Operation<Schedule, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.TriggerSchedule(TriggerScheduleRequest, CallSettings)

TriggerScheduleAsync(TriggerScheduleRequest, CallSettings)

public override async 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
Task<Operation<Schedule, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.TriggerScheduleAsync(TriggerScheduleRequest, CallSettings)

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
Operation<Instance, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.UpdateInstanceConfig(UpdateInstanceConfigRequest, CallSettings)

UpdateInstanceConfigAsync(UpdateInstanceConfigRequest, CallSettings)

public override async 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
Task<Operation<Instance, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.UpdateInstanceConfigAsync(UpdateInstanceConfigRequest, CallSettings)

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

NotebookServiceClient.UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest, CallSettings)

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
Task<UpdateInstanceMetadataItemsResponse>	A Task containing the RPC response.

Overrides

NotebookServiceClient.UpdateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest, CallSettings)

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
Operation<Instance, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest, CallSettings)

UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigRequest, CallSettings)

public override async 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
Task<Operation<Instance, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigRequest, CallSettings)

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
Operation<Instance, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.UpgradeInstance(UpgradeInstanceRequest, CallSettings)

UpgradeInstanceAsync(UpgradeInstanceRequest, CallSettings)

public override async 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
Task<Operation<Instance, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.UpgradeInstanceAsync(UpgradeInstanceRequest, CallSettings)

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
Operation<Instance, OperationMetadata>	The RPC response.

Overrides

NotebookServiceClient.UpgradeInstanceInternal(UpgradeInstanceInternalRequest, CallSettings)

UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest, CallSettings)

public override async 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
Task<Operation<Instance, OperationMetadata>>	A Task containing the RPC response.

Overrides

NotebookServiceClient.UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest, CallSettings)