public sealed class NotebookServiceClientImpl : NotebookServiceClient
NotebookService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Notebooks.V1Assembly
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.
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
.
Type | Description |
OperationsClient |
CreateExecutionOperationsClient
public override OperationsClient CreateExecutionOperationsClient { get; }
The long-running operations client for CreateExecution
.
Type | Description |
OperationsClient |
CreateInstanceOperationsClient
public override OperationsClient CreateInstanceOperationsClient { get; }
The long-running operations client for CreateInstance
.
Type | Description |
OperationsClient |
CreateScheduleOperationsClient
public override OperationsClient CreateScheduleOperationsClient { get; }
The long-running operations client for CreateSchedule
.
Type | Description |
OperationsClient |
DeleteEnvironmentOperationsClient
public override OperationsClient DeleteEnvironmentOperationsClient { get; }
The long-running operations client for DeleteEnvironment
.
Type | Description |
OperationsClient |
DeleteExecutionOperationsClient
public override OperationsClient DeleteExecutionOperationsClient { get; }
The long-running operations client for DeleteExecution
.
Type | Description |
OperationsClient |
DeleteInstanceOperationsClient
public override OperationsClient DeleteInstanceOperationsClient { get; }
The long-running operations client for DeleteInstance
.
Type | Description |
OperationsClient |
DeleteScheduleOperationsClient
public override OperationsClient DeleteScheduleOperationsClient { get; }
The long-running operations client for DeleteSchedule
.
Type | Description |
OperationsClient |
GrpcClient
public override NotebookService.NotebookServiceClient GrpcClient { get; }
The underlying gRPC NotebookService client
Type | Description |
NotebookService.NotebookServiceClient |
RegisterInstanceOperationsClient
public override OperationsClient RegisterInstanceOperationsClient { get; }
The long-running operations client for RegisterInstance
.
Type | Description |
OperationsClient |
ReportInstanceInfoOperationsClient
public override OperationsClient ReportInstanceInfoOperationsClient { get; }
The long-running operations client for ReportInstanceInfo
.
Type | Description |
OperationsClient |
ResetInstanceOperationsClient
public override OperationsClient ResetInstanceOperationsClient { get; }
The long-running operations client for ResetInstance
.
Type | Description |
OperationsClient |
RollbackInstanceOperationsClient
public override OperationsClient RollbackInstanceOperationsClient { get; }
The long-running operations client for RollbackInstance
.
Type | Description |
OperationsClient |
SetInstanceAcceleratorOperationsClient
public override OperationsClient SetInstanceAcceleratorOperationsClient { get; }
The long-running operations client for SetInstanceAccelerator
.
Type | Description |
OperationsClient |
SetInstanceLabelsOperationsClient
public override OperationsClient SetInstanceLabelsOperationsClient { get; }
The long-running operations client for SetInstanceLabels
.
Type | Description |
OperationsClient |
SetInstanceMachineTypeOperationsClient
public override OperationsClient SetInstanceMachineTypeOperationsClient { get; }
The long-running operations client for SetInstanceMachineType
.
Type | Description |
OperationsClient |
StartInstanceOperationsClient
public override OperationsClient StartInstanceOperationsClient { get; }
The long-running operations client for StartInstance
.
Type | Description |
OperationsClient |
StopInstanceOperationsClient
public override OperationsClient StopInstanceOperationsClient { get; }
The long-running operations client for StopInstance
.
Type | Description |
OperationsClient |
TriggerScheduleOperationsClient
public override OperationsClient TriggerScheduleOperationsClient { get; }
The long-running operations client for TriggerSchedule
.
Type | Description |
OperationsClient |
UpdateInstanceConfigOperationsClient
public override OperationsClient UpdateInstanceConfigOperationsClient { get; }
The long-running operations client for UpdateInstanceConfig
.
Type | Description |
OperationsClient |
UpdateShieldedInstanceConfigOperationsClient
public override OperationsClient UpdateShieldedInstanceConfigOperationsClient { get; }
The long-running operations client for UpdateShieldedInstanceConfig
.
Type | Description |
OperationsClient |
UpgradeInstanceInternalOperationsClient
public override OperationsClient UpgradeInstanceInternalOperationsClient { get; }
The long-running operations client for UpgradeInstanceInternal
.
Type | Description |
OperationsClient |
UpgradeInstanceOperationsClient
public override OperationsClient UpgradeInstanceOperationsClient { get; }
The long-running operations client for UpgradeInstance
.
Type | Description |
OperationsClient |
Methods
CreateEnvironment(CreateEnvironmentRequest, CallSettings)
public override Operation<Environment, OperationMetadata> CreateEnvironment(CreateEnvironmentRequest request, CallSettings callSettings = null)
Creates a new Environment.
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. |
Type | Description |
Operation<Environment, OperationMetadata> | The RPC response. |
CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)
public override async Task<Operation<Environment, OperationMetadata>> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallSettings callSettings = null)
Creates a new Environment.
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. |
Type | Description |
Task<Operation<Environment, OperationMetadata>> | A Task containing the RPC response. |
CreateExecution(CreateExecutionRequest, CallSettings)
public override Operation<Execution, OperationMetadata> CreateExecution(CreateExecutionRequest request, CallSettings callSettings = null)
Creates a new Execution in a given project and location.
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. |
Type | Description |
Operation<Execution, OperationMetadata> | The RPC response. |
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.
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. |
Type | Description |
Task<Operation<Execution, OperationMetadata>> | A Task containing the RPC response. |
CreateInstance(CreateInstanceRequest, CallSettings)
public override Operation<Instance, OperationMetadata> CreateInstance(CreateInstanceRequest request, CallSettings callSettings = null)
Creates a new Instance in a given project and location.
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. |
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
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.
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. |
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |
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.
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. |
Type | Description |
Operation<Schedule, OperationMetadata> | The RPC response. |
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.
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. |
Type | Description |
Task<Operation<Schedule, OperationMetadata>> | A Task containing the RPC response. |
DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteEnvironment(DeleteEnvironmentRequest request, CallSettings callSettings = null)
Deletes a single Environment.
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. |
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)
public override async Task<Operation<Empty, OperationMetadata>> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CallSettings callSettings = null)
Deletes a single Environment.
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. |
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
DeleteExecution(DeleteExecutionRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteExecution(DeleteExecutionRequest request, CallSettings callSettings = null)
Deletes execution
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. |
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
DeleteExecutionAsync(DeleteExecutionRequest, CallSettings)
public override async Task<Operation<Empty, OperationMetadata>> DeleteExecutionAsync(DeleteExecutionRequest request, CallSettings callSettings = null)
Deletes execution
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. |
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
DeleteInstance(DeleteInstanceRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteInstance(DeleteInstanceRequest request, CallSettings callSettings = null)
Deletes a single Instance.
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. |
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)
public override async Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(DeleteInstanceRequest request, CallSettings callSettings = null)
Deletes a single Instance.
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. |
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
DeleteSchedule(DeleteScheduleRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteSchedule(DeleteScheduleRequest request, CallSettings callSettings = null)
Deletes schedule and all underlying jobs
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. |
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
DeleteScheduleAsync(DeleteScheduleRequest, CallSettings)
public override async Task<Operation<Empty, OperationMetadata>> DeleteScheduleAsync(DeleteScheduleRequest request, CallSettings callSettings = null)
Deletes schedule and all underlying jobs
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. |
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
GetEnvironment(GetEnvironmentRequest, CallSettings)
public override Environment GetEnvironment(GetEnvironmentRequest request, CallSettings callSettings = null)
Gets details of a single Environment.
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. |
Type | Description |
Environment | The RPC response. |
GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)
public override Task<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CallSettings callSettings = null)
Gets details of a single Environment.
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. |
Type | Description |
Task<Environment> | A Task containing the RPC response. |
GetExecution(GetExecutionRequest, CallSettings)
public override Execution GetExecution(GetExecutionRequest request, CallSettings callSettings = null)
Gets details of executions
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. |
Type | Description |
Execution | The RPC response. |
GetExecutionAsync(GetExecutionRequest, CallSettings)
public override Task<Execution> GetExecutionAsync(GetExecutionRequest request, CallSettings callSettings = null)
Gets details of executions
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. |
Type | Description |
Task<Execution> | A Task containing the RPC response. |
GetInstance(GetInstanceRequest, CallSettings)
public override Instance GetInstance(GetInstanceRequest request, CallSettings callSettings = null)
Gets details of a single Instance.
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. |
Type | Description |
Instance | The RPC response. |
GetInstanceAsync(GetInstanceRequest, CallSettings)
public override Task<Instance> GetInstanceAsync(GetInstanceRequest request, CallSettings callSettings = null)
Gets details of a single Instance.
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. |
Type | Description |
Task<Instance> | A Task containing the RPC response. |
GetInstanceHealth(GetInstanceHealthRequest, CallSettings)
public override GetInstanceHealthResponse GetInstanceHealth(GetInstanceHealthRequest request, CallSettings callSettings = null)
Check if a notebook instance is healthy.
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. |
Type | Description |
GetInstanceHealthResponse | The RPC response. |
GetInstanceHealthAsync(GetInstanceHealthRequest, CallSettings)
public override Task<GetInstanceHealthResponse> GetInstanceHealthAsync(GetInstanceHealthRequest request, CallSettings callSettings = null)
Check if a notebook instance is healthy.
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. |
Type | Description |
Task<GetInstanceHealthResponse> | A Task containing the RPC response. |
GetSchedule(GetScheduleRequest, CallSettings)
public override Schedule GetSchedule(GetScheduleRequest request, CallSettings callSettings = null)
Gets details of schedule
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. |
Type | Description |
Schedule | The RPC response. |
GetScheduleAsync(GetScheduleRequest, CallSettings)
public override Task<Schedule> GetScheduleAsync(GetScheduleRequest request, CallSettings callSettings = null)
Gets details of schedule
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. |
Type | Description |
Task<Schedule> | A Task containing the RPC response. |
IsInstanceUpgradeable(IsInstanceUpgradeableRequest, CallSettings)
public override IsInstanceUpgradeableResponse IsInstanceUpgradeable(IsInstanceUpgradeableRequest request, CallSettings callSettings = null)
Check if a notebook instance is upgradable.
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. |
Type | Description |
IsInstanceUpgradeableResponse | The RPC response. |
IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, CallSettings)
public override Task<IsInstanceUpgradeableResponse> IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest request, CallSettings callSettings = null)
Check if a notebook instance is upgradable.
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. |
Type | Description |
Task<IsInstanceUpgradeableResponse> | A Task containing the RPC response. |
ListEnvironments(ListEnvironmentsRequest, CallSettings)
public override PagedEnumerable<ListEnvironmentsResponse, Environment> ListEnvironments(ListEnvironmentsRequest request, CallSettings callSettings = null)
Lists environments in a project.
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. |
Type | Description |
PagedEnumerable<ListEnvironmentsResponse, Environment> | A pageable sequence of Environment resources. |
ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)
public override PagedAsyncEnumerable<ListEnvironmentsResponse, Environment> ListEnvironmentsAsync(ListEnvironmentsRequest request, CallSettings callSettings = null)
Lists environments in a project.
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. |
Type | Description |
PagedAsyncEnumerable<ListEnvironmentsResponse, Environment> | A pageable asynchronous sequence of Environment resources. |
ListExecutions(ListExecutionsRequest, CallSettings)
public override PagedEnumerable<ListExecutionsResponse, Execution> ListExecutions(ListExecutionsRequest request, CallSettings callSettings = null)
Lists executions in a given project and location
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. |
Type | Description |
PagedEnumerable<ListExecutionsResponse, Execution> | A pageable sequence of Execution resources. |
ListExecutionsAsync(ListExecutionsRequest, CallSettings)
public override PagedAsyncEnumerable<ListExecutionsResponse, Execution> ListExecutionsAsync(ListExecutionsRequest request, CallSettings callSettings = null)
Lists executions in a given project and location
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. |
Type | Description |
PagedAsyncEnumerable<ListExecutionsResponse, Execution> | A pageable asynchronous sequence of Execution resources. |
ListInstances(ListInstancesRequest, CallSettings)
public override PagedEnumerable<ListInstancesResponse, Instance> ListInstances(ListInstancesRequest request, CallSettings callSettings = null)
Lists instances in a given project and location.
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. |
Type | Description |
PagedEnumerable<ListInstancesResponse, Instance> | A pageable sequence of Instance resources. |
ListInstancesAsync(ListInstancesRequest, CallSettings)
public override PagedAsyncEnumerable<ListInstancesResponse, Instance> ListInstancesAsync(ListInstancesRequest request, CallSettings callSettings = null)
Lists instances in a given project and location.
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. |
Type | Description |
PagedAsyncEnumerable<ListInstancesResponse, Instance> | A pageable asynchronous sequence of Instance resources. |
ListSchedules(ListSchedulesRequest, CallSettings)
public override PagedEnumerable<ListSchedulesResponse, Schedule> ListSchedules(ListSchedulesRequest request, CallSettings callSettings = null)
Lists schedules in a given project and location.
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. |
Type | Description |
PagedEnumerable<ListSchedulesResponse, Schedule> | A pageable sequence of Schedule resources. |
ListSchedulesAsync(ListSchedulesRequest, CallSettings)
public override PagedAsyncEnumerable<ListSchedulesResponse, Schedule> ListSchedulesAsync(ListSchedulesRequest request, CallSettings callSettings = null)
Lists schedules in a given project and location.
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. |
Type | Description |
PagedAsyncEnumerable<ListSchedulesResponse, Schedule> | A pageable asynchronous sequence of Schedule resources. |
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.
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. |
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
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.
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. |
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |
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.
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. |
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
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.
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. |
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |
ResetInstance(ResetInstanceRequest, CallSettings)
public override Operation<Instance, OperationMetadata> ResetInstance(ResetInstanceRequest request, CallSettings callSettings = null)
Resets a notebook instance.
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. |
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
ResetInstanceAsync(ResetInstanceRequest, CallSettings)
public override async Task<Operation<Instance, OperationMetadata>> ResetInstanceAsync(ResetInstanceRequest request, CallSettings callSettings = null)
Resets a notebook instance.
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. |
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |
RollbackInstance(RollbackInstanceRequest, CallSettings)
public override Operation<Instance, OperationMetadata> RollbackInstance(RollbackInstanceRequest request, CallSettings callSettings = null)
Rollbacks a notebook instance to the previous version.
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. |
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
RollbackInstanceAsync(RollbackInstanceRequest, CallSettings)
public override async Task<Operation<Instance, OperationMetadata>> RollbackInstanceAsync(RollbackInstanceRequest request, CallSettings callSettings = null)
Rollbacks a notebook instance to the previous version.
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. |
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |
SetInstanceAccelerator(SetInstanceAcceleratorRequest, CallSettings)
public override Operation<Instance, OperationMetadata> SetInstanceAccelerator(SetInstanceAcceleratorRequest request, CallSettings callSettings = null)
Updates the guest accelerators of a single Instance.
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. |
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, CallSettings)
public override async Task<Operation<Instance, OperationMetadata>> SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest request, CallSettings callSettings = null)
Updates the guest accelerators of a single Instance.
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. |
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |
SetInstanceLabels(SetInstanceLabelsRequest, CallSettings)
public override Operation<Instance, OperationMetadata> SetInstanceLabels(SetInstanceLabelsRequest request, CallSettings callSettings = null)
Replaces all the labels of an Instance.
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. |
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
SetInstanceLabelsAsync(SetInstanceLabelsRequest, CallSettings)
public override async Task<Operation<Instance, OperationMetadata>> SetInstanceLabelsAsync(SetInstanceLabelsRequest request, CallSettings callSettings = null)
Replaces all the labels of an Instance.
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. |
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |
SetInstanceMachineType(SetInstanceMachineTypeRequest, CallSettings)
public override Operation<Instance, OperationMetadata> SetInstanceMachineType(SetInstanceMachineTypeRequest request, CallSettings callSettings = null)
Updates the machine type of a single Instance.
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. |
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, CallSettings)
public override async Task<Operation<Instance, OperationMetadata>> SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest request, CallSettings callSettings = null)
Updates the machine type of a single Instance.
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. |
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |
StartInstance(StartInstanceRequest, CallSettings)
public override Operation<Instance, OperationMetadata> StartInstance(StartInstanceRequest request, CallSettings callSettings = null)
Starts a notebook instance.
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. |
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
StartInstanceAsync(StartInstanceRequest, CallSettings)
public override async Task<Operation<Instance, OperationMetadata>> StartInstanceAsync(StartInstanceRequest request, CallSettings callSettings = null)
Starts a notebook instance.
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. |
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |
StopInstance(StopInstanceRequest, CallSettings)
public override Operation<Instance, OperationMetadata> StopInstance(StopInstanceRequest request, CallSettings callSettings = null)
Stops a notebook instance.
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. |
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
StopInstanceAsync(StopInstanceRequest, CallSettings)
public override async Task<Operation<Instance, OperationMetadata>> StopInstanceAsync(StopInstanceRequest request, CallSettings callSettings = null)
Stops a notebook instance.
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. |
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |
TriggerSchedule(TriggerScheduleRequest, CallSettings)
public override Operation<Schedule, OperationMetadata> TriggerSchedule(TriggerScheduleRequest request, CallSettings callSettings = null)
Triggers execution of an existing schedule.
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. |
Type | Description |
Operation<Schedule, OperationMetadata> | The RPC response. |
TriggerScheduleAsync(TriggerScheduleRequest, CallSettings)
public override async Task<Operation<Schedule, OperationMetadata>> TriggerScheduleAsync(TriggerScheduleRequest request, CallSettings callSettings = null)
Triggers execution of an existing schedule.
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. |
Type | Description |
Task<Operation<Schedule, OperationMetadata>> | A Task containing the RPC response. |
UpdateInstanceConfig(UpdateInstanceConfigRequest, CallSettings)
public override Operation<Instance, OperationMetadata> UpdateInstanceConfig(UpdateInstanceConfigRequest request, CallSettings callSettings = null)
Update Notebook Instance configurations.
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. |
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
UpdateInstanceConfigAsync(UpdateInstanceConfigRequest, CallSettings)
public override async Task<Operation<Instance, OperationMetadata>> UpdateInstanceConfigAsync(UpdateInstanceConfigRequest request, CallSettings callSettings = null)
Update Notebook Instance configurations.
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. |
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |
UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest, CallSettings)
public override UpdateInstanceMetadataItemsResponse UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest request, CallSettings callSettings = null)
Add/update metadata items for an instance.
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. |
Type | Description |
UpdateInstanceMetadataItemsResponse | The RPC response. |
UpdateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest, CallSettings)
public override Task<UpdateInstanceMetadataItemsResponse> UpdateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest request, CallSettings callSettings = null)
Add/update metadata items for an instance.
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. |
Type | Description |
Task<UpdateInstanceMetadataItemsResponse> | A Task containing the RPC response. |
UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest, CallSettings)
public override Operation<Instance, OperationMetadata> UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest request, CallSettings callSettings = null)
Updates the Shielded instance configuration of a single Instance.
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. |
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
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.
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. |
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |
UpgradeInstance(UpgradeInstanceRequest, CallSettings)
public override Operation<Instance, OperationMetadata> UpgradeInstance(UpgradeInstanceRequest request, CallSettings callSettings = null)
Upgrades a notebook instance to the latest version.
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. |
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
UpgradeInstanceAsync(UpgradeInstanceRequest, CallSettings)
public override async Task<Operation<Instance, OperationMetadata>> UpgradeInstanceAsync(UpgradeInstanceRequest request, CallSettings callSettings = null)
Upgrades a notebook instance to the latest version.
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. |
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |
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.
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. |
Type | Description |
Operation<Instance, OperationMetadata> | The RPC response. |
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.
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. |
Type | Description |
Task<Operation<Instance, OperationMetadata>> | A Task containing the RPC response. |