public class NotebookService.NotebookServiceClient : ClientBase<NotebookService.NotebookServiceClient>Reference documentation and code samples for the Notebooks v2 API class NotebookService.NotebookServiceClient.
Client for NotebookService
Inheritance
object > ClientBase > ClientBaseNotebookServiceNotebookServiceClient > NotebookService.NotebookServiceClientNamespace
Google.Cloud.Notebooks.V2Assembly
Google.Cloud.Notebooks.V2.dll
Constructors
NotebookServiceClient()
protected NotebookServiceClient()Protected parameterless constructor to allow creation of test doubles.
NotebookServiceClient(CallInvoker)
public NotebookServiceClient(CallInvoker callInvoker)Creates a new client for NotebookService that uses a custom CallInvoker.
| Parameter | |
|---|---|
| Name | Description |
callInvoker |
CallInvokerThe callInvoker to use to make remote calls. |
NotebookServiceClient(ChannelBase)
public NotebookServiceClient(ChannelBase channel)Creates a new client for NotebookService
| Parameter | |
|---|---|
| Name | Description |
channel |
ChannelBaseThe channel to use to make remote calls. |
NotebookServiceClient(ClientBaseConfiguration)
protected NotebookServiceClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfigurationThe client configuration. |
Methods
CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest, CallOptions)
public virtual CheckInstanceUpgradabilityResponse CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest request, CallOptions options)Checks whether a notebook instance is upgradable.
| Parameters | |
|---|---|
| Name | Description |
request |
CheckInstanceUpgradabilityRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
CheckInstanceUpgradabilityResponse |
The response received from the server. |
CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest, Metadata, DateTime?, CancellationToken)
public virtual CheckInstanceUpgradabilityResponse CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Checks whether a notebook instance is upgradable.
| Parameters | |
|---|---|
| Name | Description |
request |
CheckInstanceUpgradabilityRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
CheckInstanceUpgradabilityResponse |
The response received from the server. |
CheckInstanceUpgradabilityAsync(CheckInstanceUpgradabilityRequest, CallOptions)
public virtual AsyncUnaryCall<CheckInstanceUpgradabilityResponse> CheckInstanceUpgradabilityAsync(CheckInstanceUpgradabilityRequest request, CallOptions options)Checks whether a notebook instance is upgradable.
| Parameters | |
|---|---|
| Name | Description |
request |
CheckInstanceUpgradabilityRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallCheckInstanceUpgradabilityResponse |
The call object. |
CheckInstanceUpgradabilityAsync(CheckInstanceUpgradabilityRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<CheckInstanceUpgradabilityResponse> CheckInstanceUpgradabilityAsync(CheckInstanceUpgradabilityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Checks whether a notebook instance is upgradable.
| Parameters | |
|---|---|
| Name | Description |
request |
CheckInstanceUpgradabilityRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallCheckInstanceUpgradabilityResponse |
The call object. |
CreateIAMPolicyClient()
public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.
| Returns | |
|---|---|
| Type | Description |
IAMPolicyIAMPolicyClient |
A new IAMPolicy.IAMPolicyClient for the same target as this client. |
CreateInstance(CreateInstanceRequest, CallOptions)
public virtual Operation CreateInstance(CreateInstanceRequest request, CallOptions options)Creates a new Instance in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateInstance(CreateInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation CreateInstance(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new Instance in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateInstanceAsync(CreateInstanceRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, CallOptions options)Creates a new Instance in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateInstanceAsync(CreateInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new Instance in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateLocationsClient()
public virtual Locations.LocationsClient CreateLocationsClient()Creates a new instance of Locations.LocationsClient using the same call invoker as this client.
| Returns | |
|---|---|
| Type | Description |
LocationsLocationsClient |
A new Locations.LocationsClient for the same target as this client. |
CreateOperationsClient()
public virtual Operations.OperationsClient CreateOperationsClient()Creates a new instance of Operations.OperationsClient using the same call invoker as this client.
| Returns | |
|---|---|
| Type | Description |
OperationsOperationsClient |
A new Operations client for the same target as this client. |
DeleteInstance(DeleteInstanceRequest, CallOptions)
public virtual Operation DeleteInstance(DeleteInstanceRequest request, CallOptions options)Deletes a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteInstance(DeleteInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteInstance(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteInstanceAsync(DeleteInstanceRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, CallOptions options)Deletes a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteInstanceAsync(DeleteInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DiagnoseInstance(DiagnoseInstanceRequest, CallOptions)
public virtual Operation DiagnoseInstance(DiagnoseInstanceRequest request, CallOptions options)Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DiagnoseInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DiagnoseInstance(DiagnoseInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DiagnoseInstance(DiagnoseInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DiagnoseInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DiagnoseInstanceAsync(DiagnoseInstanceRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DiagnoseInstanceAsync(DiagnoseInstanceRequest request, CallOptions options)Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DiagnoseInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DiagnoseInstanceAsync(DiagnoseInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DiagnoseInstanceAsync(DiagnoseInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DiagnoseInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
GetInstance(GetInstanceRequest, CallOptions)
public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)Gets details of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Instance |
The response received from the server. |
GetInstance(GetInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual Instance GetInstance(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets details of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Instance |
The response received from the server. |
GetInstanceAsync(GetInstanceRequest, CallOptions)
public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, CallOptions options)Gets details of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallInstance |
The call object. |
GetInstanceAsync(GetInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets details of a single Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
GetInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallInstance |
The call object. |
ListInstances(ListInstancesRequest, CallOptions)
public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, CallOptions options)Lists instances in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListInstancesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListInstancesResponse |
The response received from the server. |
ListInstances(ListInstancesRequest, Metadata, DateTime?, CancellationToken)
public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists instances in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListInstancesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListInstancesResponse |
The response received from the server. |
ListInstancesAsync(ListInstancesRequest, CallOptions)
public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, CallOptions options)Lists instances in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListInstancesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListInstancesResponse |
The call object. |
ListInstancesAsync(ListInstancesRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists instances in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListInstancesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListInstancesResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override NotebookService.NotebookServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
NotebookServiceNotebookServiceClient |
|
ResetInstance(ResetInstanceRequest, CallOptions)
public virtual Operation ResetInstance(ResetInstanceRequest request, CallOptions options)Resets a notebook instance.
| Parameters | |
|---|---|
| Name | Description |
request |
ResetInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
ResetInstance(ResetInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation ResetInstance(ResetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Resets a notebook instance.
| Parameters | |
|---|---|
| Name | Description |
request |
ResetInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
ResetInstanceAsync(ResetInstanceRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> ResetInstanceAsync(ResetInstanceRequest request, CallOptions options)Resets a notebook instance.
| Parameters | |
|---|---|
| Name | Description |
request |
ResetInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
ResetInstanceAsync(ResetInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> ResetInstanceAsync(ResetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Resets a notebook instance.
| Parameters | |
|---|---|
| Name | Description |
request |
ResetInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
RollbackInstance(RollbackInstanceRequest, CallOptions)
public virtual Operation RollbackInstance(RollbackInstanceRequest request, CallOptions options)Rollbacks a notebook instance to the previous version.
| Parameters | |
|---|---|
| Name | Description |
request |
RollbackInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
RollbackInstance(RollbackInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation RollbackInstance(RollbackInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Rollbacks a notebook instance to the previous version.
| Parameters | |
|---|---|
| Name | Description |
request |
RollbackInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
RollbackInstanceAsync(RollbackInstanceRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> RollbackInstanceAsync(RollbackInstanceRequest request, CallOptions options)Rollbacks a notebook instance to the previous version.
| Parameters | |
|---|---|
| Name | Description |
request |
RollbackInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
RollbackInstanceAsync(RollbackInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> RollbackInstanceAsync(RollbackInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Rollbacks a notebook instance to the previous version.
| Parameters | |
|---|---|
| Name | Description |
request |
RollbackInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
StartInstance(StartInstanceRequest, CallOptions)
public virtual Operation StartInstance(StartInstanceRequest request, CallOptions options)Starts a notebook instance.
| Parameters | |
|---|---|
| Name | Description |
request |
StartInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
StartInstance(StartInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation StartInstance(StartInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Starts a notebook instance.
| Parameters | |
|---|---|
| Name | Description |
request |
StartInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
StartInstanceAsync(StartInstanceRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> StartInstanceAsync(StartInstanceRequest request, CallOptions options)Starts a notebook instance.
| Parameters | |
|---|---|
| Name | Description |
request |
StartInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
StartInstanceAsync(StartInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> StartInstanceAsync(StartInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Starts a notebook instance.
| Parameters | |
|---|---|
| Name | Description |
request |
StartInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
StopInstance(StopInstanceRequest, CallOptions)
public virtual Operation StopInstance(StopInstanceRequest request, CallOptions options)Stops a notebook instance.
| Parameters | |
|---|---|
| Name | Description |
request |
StopInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
StopInstance(StopInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation StopInstance(StopInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Stops a notebook instance.
| Parameters | |
|---|---|
| Name | Description |
request |
StopInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
StopInstanceAsync(StopInstanceRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> StopInstanceAsync(StopInstanceRequest request, CallOptions options)Stops a notebook instance.
| Parameters | |
|---|---|
| Name | Description |
request |
StopInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
StopInstanceAsync(StopInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> StopInstanceAsync(StopInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Stops a notebook instance.
| Parameters | |
|---|---|
| Name | Description |
request |
StopInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateInstance(UpdateInstanceRequest, CallOptions)
public virtual Operation UpdateInstance(UpdateInstanceRequest request, CallOptions options)UpdateInstance updates an Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateInstance(UpdateInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation UpdateInstance(UpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)UpdateInstance updates an Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateInstanceAsync(UpdateInstanceRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateInstanceAsync(UpdateInstanceRequest request, CallOptions options)UpdateInstance updates an Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateInstanceAsync(UpdateInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateInstanceAsync(UpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)UpdateInstance updates an Instance.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpgradeInstance(UpgradeInstanceRequest, CallOptions)
public virtual Operation UpgradeInstance(UpgradeInstanceRequest request, CallOptions options)Upgrades a notebook instance to the latest version.
| Parameters | |
|---|---|
| Name | Description |
request |
UpgradeInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpgradeInstance(UpgradeInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation UpgradeInstance(UpgradeInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Upgrades a notebook instance to the latest version.
| Parameters | |
|---|---|
| Name | Description |
request |
UpgradeInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpgradeInstanceAsync(UpgradeInstanceRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpgradeInstanceAsync(UpgradeInstanceRequest request, CallOptions options)Upgrades a notebook instance to the latest version.
| Parameters | |
|---|---|
| Name | Description |
request |
UpgradeInstanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpgradeInstanceAsync(UpgradeInstanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpgradeInstanceAsync(UpgradeInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Upgrades a notebook instance to the latest version.
| Parameters | |
|---|---|
| Name | Description |
request |
UpgradeInstanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |