public class NotebookServiceClient : ClientBase<NotebookService.NotebookServiceClient>
Reference documentation and code samples for the AI Platform Notebooks v1 API class NotebookService.NotebookServiceClient.
Client for NotebookService
Inheritance
Object > ClientBase > ClientBase<NotebookService.NotebookServiceClient> > NotebookService.NotebookServiceClientNamespace
Google.Cloud.Notebooks.V1Assembly
Google.Cloud.Notebooks.V1.dll
Constructors
NotebookServiceClient()
protected NotebookServiceClient()
Protected parameterless constructor to allow creation of test doubles.
NotebookServiceClient(CallInvoker)
public NotebookServiceClient(CallInvoker callInvoker)
Creates a new client for NotebookService that uses a custom CallInvoker
.
Parameter | |
---|---|
Name | Description |
callInvoker | CallInvoker The callInvoker to use to make remote calls. |
NotebookServiceClient(ChannelBase)
public NotebookServiceClient(ChannelBase channel)
Creates a new client for NotebookService
Parameter | |
---|---|
Name | Description |
channel | ChannelBase The channel to use to make remote calls. |
NotebookServiceClient(ClientBase.ClientBaseConfiguration)
protected NotebookServiceClient(ClientBase.ClientBaseConfiguration configuration)
Protected constructor to allow creation of configured clients.
Parameter | |
---|---|
Name | Description |
configuration | ClientBase.ClientBaseConfiguration The client configuration. |
Methods
CreateEnvironment(CreateEnvironmentRequest, CallOptions)
public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, CallOptions options)
Creates a new Environment.
Parameters | |
---|---|
Name | Description |
request | CreateEnvironmentRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
CreateEnvironment(CreateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Creates a new Environment.
Parameters | |
---|---|
Name | Description |
request | CreateEnvironmentRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
CreateEnvironmentAsync(CreateEnvironmentRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallOptions options)
Creates a new Environment.
Parameters | |
---|---|
Name | Description |
request | CreateEnvironmentRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
CreateEnvironmentAsync(CreateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateEnvironmentAsync(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Creates a new Environment.
Parameters | |
---|---|
Name | Description |
request | CreateEnvironmentRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
CreateExecution(CreateExecutionRequest, CallOptions)
public virtual Operation CreateExecution(CreateExecutionRequest request, CallOptions options)
Creates a new Execution in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateExecutionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
CreateExecution(CreateExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation CreateExecution(CreateExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Creates a new Execution in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateExecutionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
CreateExecutionAsync(CreateExecutionRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateExecutionAsync(CreateExecutionRequest request, CallOptions options)
Creates a new Execution in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateExecutionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
CreateExecutionAsync(CreateExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateExecutionAsync(CreateExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Creates a new Execution in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateExecutionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | 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 |
IAMPolicy.IAMPolicyClient | 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 | CreateInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
CreateInstance(CreateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation CreateInstance(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Creates a new Instance in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateInstanceRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
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 | CreateInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
CreateInstanceAsync(CreateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Creates a new Instance in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateInstanceRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | 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 |
Locations.LocationsClient | 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 |
Operations.OperationsClient | A new Operations client for the same target as this client. |
CreateSchedule(CreateScheduleRequest, CallOptions)
public virtual Operation CreateSchedule(CreateScheduleRequest request, CallOptions options)
Creates a new Scheduled Notebook in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateScheduleRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
CreateSchedule(CreateScheduleRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation CreateSchedule(CreateScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Creates a new Scheduled Notebook in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateScheduleRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
CreateScheduleAsync(CreateScheduleRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateScheduleAsync(CreateScheduleRequest request, CallOptions options)
Creates a new Scheduled Notebook in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateScheduleRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
CreateScheduleAsync(CreateScheduleRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateScheduleAsync(CreateScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Creates a new Scheduled Notebook in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateScheduleRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
DeleteEnvironment(DeleteEnvironmentRequest, CallOptions)
public virtual Operation DeleteEnvironment(DeleteEnvironmentRequest request, CallOptions options)
Deletes a single Environment.
Parameters | |
---|---|
Name | Description |
request | DeleteEnvironmentRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
DeleteEnvironment(DeleteEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation DeleteEnvironment(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Deletes a single Environment.
Parameters | |
---|---|
Name | Description |
request | DeleteEnvironmentRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CallOptions options)
Deletes a single Environment.
Parameters | |
---|---|
Name | Description |
request | DeleteEnvironmentRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
DeleteEnvironmentAsync(DeleteEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Deletes a single Environment.
Parameters | |
---|---|
Name | Description |
request | DeleteEnvironmentRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
DeleteExecution(DeleteExecutionRequest, CallOptions)
public virtual Operation DeleteExecution(DeleteExecutionRequest request, CallOptions options)
Deletes execution
Parameters | |
---|---|
Name | Description |
request | DeleteExecutionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
DeleteExecution(DeleteExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation DeleteExecution(DeleteExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Deletes execution
Parameters | |
---|---|
Name | Description |
request | DeleteExecutionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
DeleteExecutionAsync(DeleteExecutionRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteExecutionAsync(DeleteExecutionRequest request, CallOptions options)
Deletes execution
Parameters | |
---|---|
Name | Description |
request | DeleteExecutionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
DeleteExecutionAsync(DeleteExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteExecutionAsync(DeleteExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Deletes execution
Parameters | |
---|---|
Name | Description |
request | DeleteExecutionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
DeleteInstance(DeleteInstanceRequest, CallOptions)
public virtual Operation DeleteInstance(DeleteInstanceRequest request, CallOptions options)
Deletes a single Instance.
Parameters | |
---|---|
Name | Description |
request | DeleteInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
DeleteInstance(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation DeleteInstance(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Deletes a single Instance.
Parameters | |
---|---|
Name | Description |
request | DeleteInstanceRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
DeleteInstanceAsync(DeleteInstanceRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, CallOptions options)
Deletes a single Instance.
Parameters | |
---|---|
Name | Description |
request | DeleteInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
DeleteInstanceAsync(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Deletes a single Instance.
Parameters | |
---|---|
Name | Description |
request | DeleteInstanceRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
DeleteSchedule(DeleteScheduleRequest, CallOptions)
public virtual Operation DeleteSchedule(DeleteScheduleRequest request, CallOptions options)
Deletes schedule and all underlying jobs
Parameters | |
---|---|
Name | Description |
request | DeleteScheduleRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
DeleteSchedule(DeleteScheduleRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation DeleteSchedule(DeleteScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Deletes schedule and all underlying jobs
Parameters | |
---|---|
Name | Description |
request | DeleteScheduleRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
DeleteScheduleAsync(DeleteScheduleRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteScheduleAsync(DeleteScheduleRequest request, CallOptions options)
Deletes schedule and all underlying jobs
Parameters | |
---|---|
Name | Description |
request | DeleteScheduleRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
DeleteScheduleAsync(DeleteScheduleRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteScheduleAsync(DeleteScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Deletes schedule and all underlying jobs
Parameters | |
---|---|
Name | Description |
request | DeleteScheduleRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | 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 | DiagnoseInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
DiagnoseInstance(DiagnoseInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation DiagnoseInstance(DiagnoseInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
Parameters | |
---|---|
Name | Description |
request | DiagnoseInstanceRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
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 | DiagnoseInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
DiagnoseInstanceAsync(DiagnoseInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> DiagnoseInstanceAsync(DiagnoseInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
Parameters | |
---|---|
Name | Description |
request | DiagnoseInstanceRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
GetEnvironment(GetEnvironmentRequest, CallOptions)
public virtual Environment GetEnvironment(GetEnvironmentRequest request, CallOptions options)
Gets details of a single Environment.
Parameters | |
---|---|
Name | Description |
request | GetEnvironmentRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Environment | The response received from the server. |
GetEnvironment(GetEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Environment GetEnvironment(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Gets details of a single Environment.
Parameters | |
---|---|
Name | Description |
request | GetEnvironmentRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Environment | The response received from the server. |
GetEnvironmentAsync(GetEnvironmentRequest, CallOptions)
public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CallOptions options)
Gets details of a single Environment.
Parameters | |
---|---|
Name | Description |
request | GetEnvironmentRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Environment> | The call object. |
GetEnvironmentAsync(GetEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Gets details of a single Environment.
Parameters | |
---|---|
Name | Description |
request | GetEnvironmentRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Environment> | The call object. |
GetExecution(GetExecutionRequest, CallOptions)
public virtual Execution GetExecution(GetExecutionRequest request, CallOptions options)
Gets details of executions
Parameters | |
---|---|
Name | Description |
request | GetExecutionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Execution | The response received from the server. |
GetExecution(GetExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Execution GetExecution(GetExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Gets details of executions
Parameters | |
---|---|
Name | Description |
request | GetExecutionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Execution | The response received from the server. |
GetExecutionAsync(GetExecutionRequest, CallOptions)
public virtual AsyncUnaryCall<Execution> GetExecutionAsync(GetExecutionRequest request, CallOptions options)
Gets details of executions
Parameters | |
---|---|
Name | Description |
request | GetExecutionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Execution> | The call object. |
GetExecutionAsync(GetExecutionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Execution> GetExecutionAsync(GetExecutionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Gets details of executions
Parameters | |
---|---|
Name | Description |
request | GetExecutionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Execution> | The call object. |
GetInstance(GetInstanceRequest, CallOptions)
public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)
Gets details of a single Instance.
Parameters | |
---|---|
Name | Description |
request | GetInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Instance | The response received from the server. |
GetInstance(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Instance GetInstance(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Gets details of a single Instance.
Parameters | |
---|---|
Name | Description |
request | GetInstanceRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
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 | GetInstanceRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Instance> | The call object. |
GetInstanceAsync(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Gets details of a single Instance.
Parameters | |
---|---|
Name | Description |
request | GetInstanceRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Instance> | The call object. |
GetInstanceHealth(GetInstanceHealthRequest, CallOptions)
public virtual GetInstanceHealthResponse GetInstanceHealth(GetInstanceHealthRequest request, CallOptions options)
Check if a notebook instance is healthy.
Parameters | |
---|---|
Name | Description |
request | GetInstanceHealthRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
GetInstanceHealthResponse | The response received from the server. |
GetInstanceHealth(GetInstanceHealthRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual GetInstanceHealthResponse GetInstanceHealth(GetInstanceHealthRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Check if a notebook instance is healthy.
Parameters | |
---|---|
Name | Description |
request | GetInstanceHealthRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
GetInstanceHealthResponse | The response received from the server. |
GetInstanceHealthAsync(GetInstanceHealthRequest, CallOptions)
public virtual AsyncUnaryCall<GetInstanceHealthResponse> GetInstanceHealthAsync(GetInstanceHealthRequest request, CallOptions options)
Check if a notebook instance is healthy.
Parameters | |
---|---|
Name | Description |
request |
|