AI Platform Notebooks v1 API - Class NotebookServiceClient (2.5.0)

public abstract class NotebookServiceClient

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

NotebookService client wrapper, for convenient use.

Inheritance

object > NotebookServiceClient

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Remarks

API v1 service for Cloud AI Platform Notebooks.

Properties

CreateEnvironmentOperationsClient

public virtual OperationsClient CreateEnvironmentOperationsClient { get; }

The long-running operations client for CreateEnvironment.

Property Value
Type Description
OperationsClient

CreateExecutionOperationsClient

public virtual OperationsClient CreateExecutionOperationsClient { get; }

The long-running operations client for CreateExecution.

Property Value
Type Description
OperationsClient

CreateInstanceOperationsClient

public virtual OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
Type Description
OperationsClient

CreateScheduleOperationsClient

public virtual OperationsClient CreateScheduleOperationsClient { get; }

The long-running operations client for CreateSchedule.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the NotebookService service, which is a host of "notebooks.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default NotebookService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default NotebookService scopes are:

DeleteEnvironmentOperationsClient

public virtual OperationsClient DeleteEnvironmentOperationsClient { get; }

The long-running operations client for DeleteEnvironment.

Property Value
Type Description
OperationsClient

DeleteExecutionOperationsClient

public virtual OperationsClient DeleteExecutionOperationsClient { get; }

The long-running operations client for DeleteExecution.

Property Value
Type Description
OperationsClient

DeleteInstanceOperationsClient

public virtual OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value
Type Description
OperationsClient

DeleteScheduleOperationsClient

public virtual OperationsClient DeleteScheduleOperationsClient { get; }

The long-running operations client for DeleteSchedule.

Property Value
Type Description
OperationsClient

DiagnoseInstanceOperationsClient

public virtual OperationsClient DiagnoseInstanceOperationsClient { get; }

The long-running operations client for DiagnoseInstance.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual NotebookService.NotebookServiceClient GrpcClient { get; }

The underlying gRPC NotebookService client

Property Value
Type Description
NotebookServiceNotebookServiceClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

RegisterInstanceOperationsClient

public virtual OperationsClient RegisterInstanceOperationsClient { get; }

The long-running operations client for RegisterInstance.

Property Value
Type Description
OperationsClient

ReportInstanceInfoOperationsClient

public virtual OperationsClient ReportInstanceInfoOperationsClient { get; }

The long-running operations client for ReportInstanceInfo.

Property Value
Type Description
OperationsClient

ResetInstanceOperationsClient

public virtual OperationsClient ResetInstanceOperationsClient { get; }

The long-running operations client for ResetInstance.

Property Value
Type Description
OperationsClient

RollbackInstanceOperationsClient

public virtual OperationsClient RollbackInstanceOperationsClient { get; }

The long-running operations client for RollbackInstance.

Property Value
Type Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

SetInstanceAcceleratorOperationsClient

public virtual OperationsClient SetInstanceAcceleratorOperationsClient { get; }

The long-running operations client for SetInstanceAccelerator.

Property Value
Type Description
OperationsClient

SetInstanceLabelsOperationsClient

public virtual OperationsClient SetInstanceLabelsOperationsClient { get; }

The long-running operations client for SetInstanceLabels.

Property Value
Type Description
OperationsClient

SetInstanceMachineTypeOperationsClient

public virtual OperationsClient SetInstanceMachineTypeOperationsClient { get; }

The long-running operations client for SetInstanceMachineType.

Property Value
Type Description
OperationsClient

StartInstanceOperationsClient

public virtual OperationsClient StartInstanceOperationsClient { get; }

The long-running operations client for StartInstance.

Property Value
Type Description
OperationsClient

StopInstanceOperationsClient

public virtual OperationsClient StopInstanceOperationsClient { get; }

The long-running operations client for StopInstance.

Property Value
Type Description
OperationsClient

TriggerScheduleOperationsClient

public virtual OperationsClient TriggerScheduleOperationsClient { get; }

The long-running operations client for TriggerSchedule.

Property Value
Type Description
OperationsClient

UpdateInstanceConfigOperationsClient

public virtual OperationsClient UpdateInstanceConfigOperationsClient { get; }

The long-running operations client for UpdateInstanceConfig.

Property Value
Type Description
OperationsClient

UpdateShieldedInstanceConfigOperationsClient

public virtual OperationsClient UpdateShieldedInstanceConfigOperationsClient { get; }

The long-running operations client for UpdateShieldedInstanceConfig.

Property Value
Type Description
OperationsClient

UpgradeInstanceInternalOperationsClient

public virtual OperationsClient UpgradeInstanceInternalOperationsClient { get; }

The long-running operations client for UpgradeInstanceInternal.

Property Value
Type Description
OperationsClient

UpgradeInstanceOperationsClient

public virtual OperationsClient UpgradeInstanceOperationsClient { get; }

The long-running operations client for UpgradeInstance.

Property Value
Type Description
OperationsClient

Methods

Create()

public static NotebookServiceClient Create()

Synchronously creates a NotebookServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use NotebookServiceClientBuilder.

Returns
Type Description
NotebookServiceClient

The created NotebookServiceClient.

CreateAsync(CancellationToken)

public static Task<NotebookServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a NotebookServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use NotebookServiceClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskNotebookServiceClient

The task representing the created NotebookServiceClient.

CreateEnvironment(CreateEnvironmentRequest, CallSettings)

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

Creates a new Environment.

Parameters
Name Description
request CreateEnvironmentRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEnvironmentOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::CreateEnvironmentRequest request = new gcnv::CreateEnvironmentRequest
{
    Parent = "",
    EnvironmentId = "",
    Environment = new gcnv::Environment(),
};
// Make the request
Operation<gcnv::Environment, gcnv::OperationMetadata> response = notebookServiceClient.CreateEnvironment(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Environment, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Environment result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Environment, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceCreateEnvironment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Environment retrievedResult = retrievedResponse.Result;
}

CreateEnvironment(string, Environment, string, CallSettings)

public virtual Operation<Environment, OperationMetadata> CreateEnvironment(string parent, Environment environment, string environmentId, CallSettings callSettings = null)

Creates a new Environment.

Parameters
Name Description
parent string

Required. Format: projects/{project_id}/locations/{location}

environment Environment

Required. The environment to be created.

environmentId string

Required. User-defined unique ID of this environment. The environment_id must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEnvironmentOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string parent = "";
gcnv::Environment environment = new gcnv::Environment();
string environmentId = "";
// Make the request
Operation<gcnv::Environment, gcnv::OperationMetadata> response = notebookServiceClient.CreateEnvironment(parent, environment, environmentId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Environment, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Environment result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Environment, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceCreateEnvironment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Environment retrievedResult = retrievedResponse.Result;
}

CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

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

Creates a new Environment.

Parameters
Name Description
request CreateEnvironmentRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEnvironmentOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::CreateEnvironmentRequest request = new gcnv::CreateEnvironmentRequest
{
    Parent = "",
    EnvironmentId = "",
    Environment = new gcnv::Environment(),
};
// Make the request
Operation<gcnv::Environment, gcnv::OperationMetadata> response = await notebookServiceClient.CreateEnvironmentAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Environment, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Environment result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Environment, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Environment retrievedResult = retrievedResponse.Result;
}

CreateEnvironmentAsync(CreateEnvironmentRequest, CancellationToken)

public virtual Task<Operation<Environment, OperationMetadata>> CreateEnvironmentAsync(CreateEnvironmentRequest request, CancellationToken cancellationToken)

Creates a new Environment.

Parameters
Name Description
request CreateEnvironmentRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEnvironmentOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::CreateEnvironmentRequest request = new gcnv::CreateEnvironmentRequest
{
    Parent = "",
    EnvironmentId = "",
    Environment = new gcnv::Environment(),
};
// Make the request
Operation<gcnv::Environment, gcnv::OperationMetadata> response = await notebookServiceClient.CreateEnvironmentAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Environment, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Environment result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Environment, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Environment retrievedResult = retrievedResponse.Result;
}

CreateEnvironmentAsync(string, Environment, string, CallSettings)

public virtual Task<Operation<Environment, OperationMetadata>> CreateEnvironmentAsync(string parent, Environment environment, string environmentId, CallSettings callSettings = null)

Creates a new Environment.

Parameters
Name Description
parent string

Required. Format: projects/{project_id}/locations/{location}

environment Environment

Required. The environment to be created.

environmentId string

Required. User-defined unique ID of this environment. The environment_id must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEnvironmentOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
gcnv::Environment environment = new gcnv::Environment();
string environmentId = "";
// Make the request
Operation<gcnv::Environment, gcnv::OperationMetadata> response = await notebookServiceClient.CreateEnvironmentAsync(parent, environment, environmentId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Environment, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Environment result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Environment, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Environment retrievedResult = retrievedResponse.Result;
}

CreateEnvironmentAsync(string, Environment, string, CancellationToken)

public virtual Task<Operation<Environment, OperationMetadata>> CreateEnvironmentAsync(string parent, Environment environment, string environmentId, CancellationToken cancellationToken)

Creates a new Environment.

Parameters
Name Description
parent string

Required. Format: projects/{project_id}/locations/{location}

environment Environment

Required. The environment to be created.

environmentId string

Required. User-defined unique ID of this environment. The environment_id must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEnvironmentOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
gcnv::Environment environment = new gcnv::Environment();
string environmentId = "";
// Make the request
Operation<gcnv::Environment, gcnv::OperationMetadata> response = await notebookServiceClient.CreateEnvironmentAsync(parent, environment, environmentId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Environment, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Environment result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Environment, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Environment retrievedResult = retrievedResponse.Result;
}

CreateExecution(CreateExecutionRequest, CallSettings)

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

Creates a new Execution in a given project and location.

Parameters
Name Description
request CreateExecutionRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationExecutionOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::CreateExecutionRequest request = new gcnv::CreateExecutionRequest
{
    ParentAsExecutionName = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]"),
    ExecutionId = "",
    Execution = new gcnv::Execution(),
};
// Make the request
Operation<gcnv::Execution, gcnv::OperationMetadata> response = notebookServiceClient.CreateExecution(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Execution, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Execution result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Execution, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceCreateExecution(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Execution retrievedResult = retrievedResponse.Result;
}

CreateExecution(ExecutionName, Execution, string, CallSettings)

public virtual Operation<Execution, OperationMetadata> CreateExecution(ExecutionName parent, Execution execution, string executionId, CallSettings callSettings = null)

Creates a new Execution in a given project and location.

Parameters
Name Description
parent ExecutionName

Required. Format: parent=projects/{project_id}/locations/{location}

execution Execution

Required. The execution to be created.

executionId string

Required. User-defined unique ID of this execution.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationExecutionOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::ExecutionName parent = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]");
gcnv::Execution execution = new gcnv::Execution();
string executionId = "";
// Make the request
Operation<gcnv::Execution, gcnv::OperationMetadata> response = notebookServiceClient.CreateExecution(parent, execution, executionId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Execution, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Execution result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Execution, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceCreateExecution(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Execution retrievedResult = retrievedResponse.Result;
}

CreateExecution(string, Execution, string, CallSettings)

public virtual Operation<Execution, OperationMetadata> CreateExecution(string parent, Execution execution, string executionId, CallSettings callSettings = null)

Creates a new Execution in a given project and location.

Parameters
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location}

execution Execution

Required. The execution to be created.

executionId string

Required. User-defined unique ID of this execution.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationExecutionOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/location/[LOCATION]/executions/[EXECUTION]";
gcnv::Execution execution = new gcnv::Execution();
string executionId = "";
// Make the request
Operation<gcnv::Execution, gcnv::OperationMetadata> response = notebookServiceClient.CreateExecution(parent, execution, executionId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Execution, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Execution result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Execution, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceCreateExecution(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Execution retrievedResult = retrievedResponse.Result;
}

CreateExecutionAsync(CreateExecutionRequest, CallSettings)

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

Creates a new Execution in a given project and location.

Parameters
Name Description
request CreateExecutionRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationExecutionOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::CreateExecutionRequest request = new gcnv::CreateExecutionRequest
{
    ParentAsExecutionName = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]"),
    ExecutionId = "",
    Execution = new gcnv::Execution(),
};
// Make the request
Operation<gcnv::Execution, gcnv::OperationMetadata> response = await notebookServiceClient.CreateExecutionAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Execution, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Execution result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Execution, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateExecutionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Execution retrievedResult = retrievedResponse.Result;
}

CreateExecutionAsync(CreateExecutionRequest, CancellationToken)

public virtual Task<Operation<Execution, OperationMetadata>> CreateExecutionAsync(CreateExecutionRequest request, CancellationToken cancellationToken)

Creates a new Execution in a given project and location.

Parameters
Name Description
request CreateExecutionRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationExecutionOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::CreateExecutionRequest request = new gcnv::CreateExecutionRequest
{
    ParentAsExecutionName = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]"),
    ExecutionId = "",
    Execution = new gcnv::Execution(),
};
// Make the request
Operation<gcnv::Execution, gcnv::OperationMetadata> response = await notebookServiceClient.CreateExecutionAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Execution, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Execution result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Execution, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateExecutionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Execution retrievedResult = retrievedResponse.Result;
}

CreateExecutionAsync(ExecutionName, Execution, string, CallSettings)

public virtual Task<Operation<Execution, OperationMetadata>> CreateExecutionAsync(ExecutionName parent, Execution execution, string executionId, CallSettings callSettings = null)

Creates a new Execution in a given project and location.

Parameters
Name Description
parent ExecutionName

Required. Format: parent=projects/{project_id}/locations/{location}

execution Execution

Required. The execution to be created.

executionId string

Required. User-defined unique ID of this execution.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationExecutionOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ExecutionName parent = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]");
gcnv::Execution execution = new gcnv::Execution();
string executionId = "";
// Make the request
Operation<gcnv::Execution, gcnv::OperationMetadata> response = await notebookServiceClient.CreateExecutionAsync(parent, execution, executionId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Execution, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Execution result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Execution, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateExecutionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Execution retrievedResult = retrievedResponse.Result;
}

CreateExecutionAsync(ExecutionName, Execution, string, CancellationToken)

public virtual Task<Operation<Execution, OperationMetadata>> CreateExecutionAsync(ExecutionName parent, Execution execution, string executionId, CancellationToken cancellationToken)

Creates a new Execution in a given project and location.

Parameters
Name Description
parent ExecutionName

Required. Format: parent=projects/{project_id}/locations/{location}

execution Execution

Required. The execution to be created.

executionId string

Required. User-defined unique ID of this execution.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationExecutionOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ExecutionName parent = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]");
gcnv::Execution execution = new gcnv::Execution();
string executionId = "";
// Make the request
Operation<gcnv::Execution, gcnv::OperationMetadata> response = await notebookServiceClient.CreateExecutionAsync(parent, execution, executionId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Execution, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Execution result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Execution, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateExecutionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Execution retrievedResult = retrievedResponse.Result;
}

CreateExecutionAsync(string, Execution, string, CallSettings)

public virtual Task<Operation<Execution, OperationMetadata>> CreateExecutionAsync(string parent, Execution execution, string executionId, CallSettings callSettings = null)

Creates a new Execution in a given project and location.

Parameters
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location}

execution Execution

Required. The execution to be created.

executionId string

Required. User-defined unique ID of this execution.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationExecutionOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/location/[LOCATION]/executions/[EXECUTION]";
gcnv::Execution execution = new gcnv::Execution();
string executionId = "";
// Make the request
Operation<gcnv::Execution, gcnv::OperationMetadata> response = await notebookServiceClient.CreateExecutionAsync(parent, execution, executionId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Execution, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Execution result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Execution, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateExecutionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Execution retrievedResult = retrievedResponse.Result;
}

CreateExecutionAsync(string, Execution, string, CancellationToken)

public virtual Task<Operation<Execution, OperationMetadata>> CreateExecutionAsync(string parent, Execution execution, string executionId, CancellationToken cancellationToken)

Creates a new Execution in a given project and location.

Parameters
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location}

execution Execution

Required. The execution to be created.

executionId string

Required. User-defined unique ID of this execution.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationExecutionOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/location/[LOCATION]/executions/[EXECUTION]";
gcnv::Execution execution = new gcnv::Execution();
string executionId = "";
// Make the request
Operation<gcnv::Execution, gcnv::OperationMetadata> response = await notebookServiceClient.CreateExecutionAsync(parent, execution, executionId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Execution, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Execution result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Execution, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateExecutionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Execution retrievedResult = retrievedResponse.Result;
}

CreateInstance(CreateInstanceRequest, CallSettings)

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

Creates a new Instance in a given project and location.

Parameters
Name Description
request CreateInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::CreateInstanceRequest request = new gcnv::CreateInstanceRequest
{
    Parent = "",
    InstanceId = "",
    Instance = new gcnv::Instance(),
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.CreateInstance(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceCreateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

CreateInstance(string, Instance, string, CallSettings)

public virtual Operation<Instance, OperationMetadata> CreateInstance(string parent, Instance instance, string instanceId, CallSettings callSettings = null)

Creates a new Instance in a given project and location.

Parameters
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location}

instance Instance

Required. The instance to be created.

instanceId string

Required. User-defined unique ID of this instance.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string parent = "";
gcnv::Instance instance = new gcnv::Instance();
string instanceId = "";
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.CreateInstance(parent, instance, instanceId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceCreateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(CreateInstanceRequest, CallSettings)

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

Creates a new Instance in a given project and location.

Parameters
Name Description
request CreateInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::CreateInstanceRequest request = new gcnv::CreateInstanceRequest
{
    Parent = "",
    InstanceId = "",
    Instance = new gcnv::Instance(),
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.CreateInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(CreateInstanceRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> CreateInstanceAsync(CreateInstanceRequest request, CancellationToken cancellationToken)

Creates a new Instance in a given project and location.

Parameters
Name Description
request CreateInstanceRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::CreateInstanceRequest request = new gcnv::CreateInstanceRequest
{
    Parent = "",
    InstanceId = "",
    Instance = new gcnv::Instance(),
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.CreateInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(string, Instance, string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> CreateInstanceAsync(string parent, Instance instance, string instanceId, CallSettings callSettings = null)

Creates a new Instance in a given project and location.

Parameters
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location}

instance Instance

Required. The instance to be created.

instanceId string

Required. User-defined unique ID of this instance.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
gcnv::Instance instance = new gcnv::Instance();
string instanceId = "";
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.CreateInstanceAsync(parent, instance, instanceId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(string, Instance, string, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> CreateInstanceAsync(string parent, Instance instance, string instanceId, CancellationToken cancellationToken)

Creates a new Instance in a given project and location.

Parameters
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location}

instance Instance

Required. The instance to be created.

instanceId string

Required. User-defined unique ID of this instance.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
gcnv::Instance instance = new gcnv::Instance();
string instanceId = "";
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.CreateInstanceAsync(parent, instance, instanceId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

CreateSchedule(CreateScheduleRequest, CallSettings)

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

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

Parameters
Name Description
request CreateScheduleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationScheduleOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::CreateScheduleRequest request = new gcnv::CreateScheduleRequest
{
    ParentAsScheduleName = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]"),
    ScheduleId = "",
    Schedule = new gcnv::Schedule(),
};
// Make the request
Operation<gcnv::Schedule, gcnv::OperationMetadata> response = notebookServiceClient.CreateSchedule(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Schedule, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Schedule result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Schedule, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceCreateSchedule(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Schedule retrievedResult = retrievedResponse.Result;
}

CreateSchedule(ScheduleName, Schedule, string, CallSettings)

public virtual Operation<Schedule, OperationMetadata> CreateSchedule(ScheduleName parent, Schedule schedule, string scheduleId, CallSettings callSettings = null)

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

Parameters
Name Description
parent ScheduleName

Required. Format: parent=projects/{project_id}/locations/{location}

schedule Schedule

Required. The schedule to be created.

scheduleId string

Required. User-defined unique ID of this schedule.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationScheduleOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::ScheduleName parent = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
gcnv::Schedule schedule = new gcnv::Schedule();
string scheduleId = "";
// Make the request
Operation<gcnv::Schedule, gcnv::OperationMetadata> response = notebookServiceClient.CreateSchedule(parent, schedule, scheduleId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Schedule, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Schedule result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Schedule, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceCreateSchedule(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Schedule retrievedResult = retrievedResponse.Result;
}

CreateSchedule(string, Schedule, string, CallSettings)

public virtual Operation<Schedule, OperationMetadata> CreateSchedule(string parent, Schedule schedule, string scheduleId, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location}

schedule Schedule

Required. The schedule to be created.

scheduleId string

Required. User-defined unique ID of this schedule.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationScheduleOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/location/[LOCATION]/schedules/[SCHEDULE]";
gcnv::Schedule schedule = new gcnv::Schedule();
string scheduleId = "";
// Make the request
Operation<gcnv::Schedule, gcnv::OperationMetadata> response = notebookServiceClient.CreateSchedule(parent, schedule, scheduleId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Schedule, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Schedule result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Schedule, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceCreateSchedule(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Schedule retrievedResult = retrievedResponse.Result;
}

CreateScheduleAsync(CreateScheduleRequest, CallSettings)

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

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

Parameters
Name Description
request CreateScheduleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationScheduleOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::CreateScheduleRequest request = new gcnv::CreateScheduleRequest
{
    ParentAsScheduleName = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]"),
    ScheduleId = "",
    Schedule = new gcnv::Schedule(),
};
// Make the request
Operation<gcnv::Schedule, gcnv::OperationMetadata> response = await notebookServiceClient.CreateScheduleAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Schedule, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Schedule result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Schedule, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateScheduleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Schedule retrievedResult = retrievedResponse.Result;
}

CreateScheduleAsync(CreateScheduleRequest, CancellationToken)

public virtual Task<Operation<Schedule, OperationMetadata>> CreateScheduleAsync(CreateScheduleRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request CreateScheduleRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationScheduleOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::CreateScheduleRequest request = new gcnv::CreateScheduleRequest
{
    ParentAsScheduleName = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]"),
    ScheduleId = "",
    Schedule = new gcnv::Schedule(),
};
// Make the request
Operation<gcnv::Schedule, gcnv::OperationMetadata> response = await notebookServiceClient.CreateScheduleAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Schedule, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Schedule result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Schedule, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateScheduleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Schedule retrievedResult = retrievedResponse.Result;
}

CreateScheduleAsync(ScheduleName, Schedule, string, CallSettings)

public virtual Task<Operation<Schedule, OperationMetadata>> CreateScheduleAsync(ScheduleName parent, Schedule schedule, string scheduleId, CallSettings callSettings = null)

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

Parameters
Name Description
parent ScheduleName

Required. Format: parent=projects/{project_id}/locations/{location}

schedule Schedule

Required. The schedule to be created.

scheduleId string

Required. User-defined unique ID of this schedule.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationScheduleOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ScheduleName parent = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
gcnv::Schedule schedule = new gcnv::Schedule();
string scheduleId = "";
// Make the request
Operation<gcnv::Schedule, gcnv::OperationMetadata> response = await notebookServiceClient.CreateScheduleAsync(parent, schedule, scheduleId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Schedule, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Schedule result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Schedule, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateScheduleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Schedule retrievedResult = retrievedResponse.Result;
}

CreateScheduleAsync(ScheduleName, Schedule, string, CancellationToken)

public virtual Task<Operation<Schedule, OperationMetadata>> CreateScheduleAsync(ScheduleName parent, Schedule schedule, string scheduleId, CancellationToken cancellationToken)

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

Parameters
Name Description
parent ScheduleName

Required. Format: parent=projects/{project_id}/locations/{location}

schedule Schedule

Required. The schedule to be created.

scheduleId string

Required. User-defined unique ID of this schedule.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationScheduleOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ScheduleName parent = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
gcnv::Schedule schedule = new gcnv::Schedule();
string scheduleId = "";
// Make the request
Operation<gcnv::Schedule, gcnv::OperationMetadata> response = await notebookServiceClient.CreateScheduleAsync(parent, schedule, scheduleId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Schedule, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Schedule result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Schedule, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateScheduleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Schedule retrievedResult = retrievedResponse.Result;
}

CreateScheduleAsync(string, Schedule, string, CallSettings)

public virtual Task<Operation<Schedule, OperationMetadata>> CreateScheduleAsync(string parent, Schedule schedule, string scheduleId, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location}

schedule Schedule

Required. The schedule to be created.

scheduleId string

Required. User-defined unique ID of this schedule.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationScheduleOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/location/[LOCATION]/schedules/[SCHEDULE]";
gcnv::Schedule schedule = new gcnv::Schedule();
string scheduleId = "";
// Make the request
Operation<gcnv::Schedule, gcnv::OperationMetadata> response = await notebookServiceClient.CreateScheduleAsync(parent, schedule, scheduleId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Schedule, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Schedule result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Schedule, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateScheduleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Schedule retrievedResult = retrievedResponse.Result;
}

CreateScheduleAsync(string, Schedule, string, CancellationToken)

public virtual Task<Operation<Schedule, OperationMetadata>> CreateScheduleAsync(string parent, Schedule schedule, string scheduleId, CancellationToken cancellationToken)

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

Parameters
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location}

schedule Schedule

Required. The schedule to be created.

scheduleId string

Required. User-defined unique ID of this schedule.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationScheduleOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/location/[LOCATION]/schedules/[SCHEDULE]";
gcnv::Schedule schedule = new gcnv::Schedule();
string scheduleId = "";
// Make the request
Operation<gcnv::Schedule, gcnv::OperationMetadata> response = await notebookServiceClient.CreateScheduleAsync(parent, schedule, scheduleId);

// Poll until the returned long-running operation is complete
Operation<gcnv::Schedule, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Schedule result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Schedule, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceCreateScheduleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Schedule retrievedResult = retrievedResponse.Result;
}

DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

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

Deletes a single Environment.

Parameters
Name Description
request DeleteEnvironmentRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::DeleteEnvironmentRequest request = new gcnv::DeleteEnvironmentRequest { Name = "", };
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = notebookServiceClient.DeleteEnvironment(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceDeleteEnvironment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteEnvironment(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteEnvironment(string name, CallSettings callSettings = null)

Deletes a single Environment.

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string name = "";
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = notebookServiceClient.DeleteEnvironment(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceDeleteEnvironment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

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

Deletes a single Environment.

Parameters
Name Description
request DeleteEnvironmentRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::DeleteEnvironmentRequest request = new gcnv::DeleteEnvironmentRequest { Name = "", };
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteEnvironmentAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CancellationToken cancellationToken)

Deletes a single Environment.

Parameters
Name Description
request DeleteEnvironmentRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::DeleteEnvironmentRequest request = new gcnv::DeleteEnvironmentRequest { Name = "", };
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteEnvironmentAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteEnvironmentAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteEnvironmentAsync(string name, CallSettings callSettings = null)

Deletes a single Environment.

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteEnvironmentAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteEnvironmentAsync(string, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteEnvironmentAsync(string name, CancellationToken cancellationToken)

Deletes a single Environment.

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteEnvironmentAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteEnvironmentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteExecution(DeleteExecutionRequest, CallSettings)

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

Deletes execution

Parameters
Name Description
request DeleteExecutionRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::DeleteExecutionRequest request = new gcnv::DeleteExecutionRequest
{
    ExecutionName = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]"),
};
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = notebookServiceClient.DeleteExecution(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceDeleteExecution(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteExecution(ExecutionName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteExecution(ExecutionName name, CallSettings callSettings = null)

Deletes execution

Parameters
Name Description
name ExecutionName

Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::ExecutionName name = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]");
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = notebookServiceClient.DeleteExecution(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceDeleteExecution(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteExecution(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteExecution(string name, CallSettings callSettings = null)

Deletes execution

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/location/[LOCATION]/executions/[EXECUTION]";
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = notebookServiceClient.DeleteExecution(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceDeleteExecution(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteExecutionAsync(DeleteExecutionRequest, CallSettings)

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

Deletes execution

Parameters
Name Description
request DeleteExecutionRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::DeleteExecutionRequest request = new gcnv::DeleteExecutionRequest
{
    ExecutionName = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]"),
};
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteExecutionAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteExecutionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteExecutionAsync(DeleteExecutionRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteExecutionAsync(DeleteExecutionRequest request, CancellationToken cancellationToken)

Deletes execution

Parameters
Name Description
request DeleteExecutionRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::DeleteExecutionRequest request = new gcnv::DeleteExecutionRequest
{
    ExecutionName = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]"),
};
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteExecutionAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteExecutionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteExecutionAsync(ExecutionName, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteExecutionAsync(ExecutionName name, CallSettings callSettings = null)

Deletes execution

Parameters
Name Description
name ExecutionName

Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ExecutionName name = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]");
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteExecutionAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteExecutionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteExecutionAsync(ExecutionName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteExecutionAsync(ExecutionName name, CancellationToken cancellationToken)

Deletes execution

Parameters
Name Description
name ExecutionName

Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ExecutionName name = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]");
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteExecutionAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteExecutionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteExecutionAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteExecutionAsync(string name, CallSettings callSettings = null)

Deletes execution

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/location/[LOCATION]/executions/[EXECUTION]";
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteExecutionAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteExecutionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteExecutionAsync(string, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteExecutionAsync(string name, CancellationToken cancellationToken)

Deletes execution

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/location/[LOCATION]/executions/[EXECUTION]";
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteExecutionAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteExecutionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInstance(DeleteInstanceRequest, CallSettings)

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

Deletes a single Instance.

Parameters
Name Description
request DeleteInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::DeleteInstanceRequest request = new gcnv::DeleteInstanceRequest { Name = "", };
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = notebookServiceClient.DeleteInstance(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceDeleteInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInstance(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteInstance(string name, CallSettings callSettings = null)

Deletes a single Instance.

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string name = "";
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = notebookServiceClient.DeleteInstance(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceDeleteInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

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

Deletes a single Instance.

Parameters
Name Description
request DeleteInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::DeleteInstanceRequest request = new gcnv::DeleteInstanceRequest { Name = "", };
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInstanceAsync(DeleteInstanceRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(DeleteInstanceRequest request, CancellationToken cancellationToken)

Deletes a single Instance.

Parameters
Name Description
request DeleteInstanceRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::DeleteInstanceRequest request = new gcnv::DeleteInstanceRequest { Name = "", };
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInstanceAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(string name, CallSettings callSettings = null)

Deletes a single Instance.

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteInstanceAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInstanceAsync(string, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(string name, CancellationToken cancellationToken)

Deletes a single Instance.

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteInstanceAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteSchedule(DeleteScheduleRequest, CallSettings)

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

Deletes schedule and all underlying jobs

Parameters
Name Description
request DeleteScheduleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::DeleteScheduleRequest request = new gcnv::DeleteScheduleRequest
{
    ScheduleName = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]"),
};
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = notebookServiceClient.DeleteSchedule(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceDeleteSchedule(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteSchedule(ScheduleName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteSchedule(ScheduleName name, CallSettings callSettings = null)

Deletes schedule and all underlying jobs

Parameters
Name Description
name ScheduleName

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::ScheduleName name = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = notebookServiceClient.DeleteSchedule(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceDeleteSchedule(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteSchedule(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteSchedule(string name, CallSettings callSettings = null)

Deletes schedule and all underlying jobs

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/location/[LOCATION]/schedules/[SCHEDULE]";
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = notebookServiceClient.DeleteSchedule(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceDeleteSchedule(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteScheduleAsync(DeleteScheduleRequest, CallSettings)

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

Deletes schedule and all underlying jobs

Parameters
Name Description
request DeleteScheduleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::DeleteScheduleRequest request = new gcnv::DeleteScheduleRequest
{
    ScheduleName = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]"),
};
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteScheduleAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteScheduleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteScheduleAsync(DeleteScheduleRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteScheduleAsync(DeleteScheduleRequest request, CancellationToken cancellationToken)

Deletes schedule and all underlying jobs

Parameters
Name Description
request DeleteScheduleRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::DeleteScheduleRequest request = new gcnv::DeleteScheduleRequest
{
    ScheduleName = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]"),
};
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteScheduleAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteScheduleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteScheduleAsync(ScheduleName, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteScheduleAsync(ScheduleName name, CallSettings callSettings = null)

Deletes schedule and all underlying jobs

Parameters
Name Description
name ScheduleName

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ScheduleName name = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteScheduleAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteScheduleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteScheduleAsync(ScheduleName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteScheduleAsync(ScheduleName name, CancellationToken cancellationToken)

Deletes schedule and all underlying jobs

Parameters
Name Description
name ScheduleName

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ScheduleName name = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteScheduleAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteScheduleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteScheduleAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteScheduleAsync(string name, CallSettings callSettings = null)

Deletes schedule and all underlying jobs

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/location/[LOCATION]/schedules/[SCHEDULE]";
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteScheduleAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteScheduleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteScheduleAsync(string, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteScheduleAsync(string name, CancellationToken cancellationToken)

Deletes schedule and all underlying jobs

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/location/[LOCATION]/schedules/[SCHEDULE]";
// Make the request
Operation<Empty, gcnv::OperationMetadata> response = await notebookServiceClient.DeleteScheduleAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDeleteScheduleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DiagnoseInstance(DiagnoseInstanceRequest, CallSettings)

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

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

Parameters
Name Description
request DiagnoseInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::DiagnoseInstanceRequest request = new gcnv::DiagnoseInstanceRequest
{
    InstanceName = gcnv::InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    DiagnosticConfig = new gcnv::DiagnosticConfig(),
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.DiagnoseInstance(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceDiagnoseInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

DiagnoseInstance(InstanceName, DiagnosticConfig, CallSettings)

public virtual Operation<Instance, OperationMetadata> DiagnoseInstance(InstanceName name, DiagnosticConfig diagnosticConfig, CallSettings callSettings = null)

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

Parameters
Name Description
name InstanceName

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

diagnosticConfig DiagnosticConfig

Required. Defines flags that are used to run the diagnostic tool

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::InstanceName name = gcnv::InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
gcnv::DiagnosticConfig diagnosticConfig = new gcnv::DiagnosticConfig();
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.DiagnoseInstance(name, diagnosticConfig);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceDiagnoseInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

DiagnoseInstance(string, DiagnosticConfig, CallSettings)

public virtual Operation<Instance, OperationMetadata> DiagnoseInstance(string name, DiagnosticConfig diagnosticConfig, CallSettings callSettings = null)

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

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

diagnosticConfig DiagnosticConfig

Required. Defines flags that are used to run the diagnostic tool

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
gcnv::DiagnosticConfig diagnosticConfig = new gcnv::DiagnosticConfig();
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.DiagnoseInstance(name, diagnosticConfig);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceDiagnoseInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

DiagnoseInstanceAsync(DiagnoseInstanceRequest, CallSettings)

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

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

Parameters
Name Description
request DiagnoseInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::DiagnoseInstanceRequest request = new gcnv::DiagnoseInstanceRequest
{
    InstanceName = gcnv::InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    DiagnosticConfig = new gcnv::DiagnosticConfig(),
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.DiagnoseInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDiagnoseInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

DiagnoseInstanceAsync(DiagnoseInstanceRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> DiagnoseInstanceAsync(DiagnoseInstanceRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request DiagnoseInstanceRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::DiagnoseInstanceRequest request = new gcnv::DiagnoseInstanceRequest
{
    InstanceName = gcnv::InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    DiagnosticConfig = new gcnv::DiagnosticConfig(),
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.DiagnoseInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDiagnoseInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

DiagnoseInstanceAsync(InstanceName, DiagnosticConfig, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> DiagnoseInstanceAsync(InstanceName name, DiagnosticConfig diagnosticConfig, CallSettings callSettings = null)

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

Parameters
Name Description
name InstanceName

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

diagnosticConfig DiagnosticConfig

Required. Defines flags that are used to run the diagnostic tool

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::InstanceName name = gcnv::InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
gcnv::DiagnosticConfig diagnosticConfig = new gcnv::DiagnosticConfig();
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.DiagnoseInstanceAsync(name, diagnosticConfig);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDiagnoseInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

DiagnoseInstanceAsync(InstanceName, DiagnosticConfig, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> DiagnoseInstanceAsync(InstanceName name, DiagnosticConfig diagnosticConfig, CancellationToken cancellationToken)

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

Parameters
Name Description
name InstanceName

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

diagnosticConfig DiagnosticConfig

Required. Defines flags that are used to run the diagnostic tool

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::InstanceName name = gcnv::InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
gcnv::DiagnosticConfig diagnosticConfig = new gcnv::DiagnosticConfig();
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.DiagnoseInstanceAsync(name, diagnosticConfig);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDiagnoseInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

DiagnoseInstanceAsync(string, DiagnosticConfig, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> DiagnoseInstanceAsync(string name, DiagnosticConfig diagnosticConfig, CallSettings callSettings = null)

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

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

diagnosticConfig DiagnosticConfig

Required. Defines flags that are used to run the diagnostic tool

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
gcnv::DiagnosticConfig diagnosticConfig = new gcnv::DiagnosticConfig();
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.DiagnoseInstanceAsync(name, diagnosticConfig);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDiagnoseInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

DiagnoseInstanceAsync(string, DiagnosticConfig, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> DiagnoseInstanceAsync(string name, DiagnosticConfig diagnosticConfig, CancellationToken cancellationToken)

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

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

diagnosticConfig DiagnosticConfig

Required. Defines flags that are used to run the diagnostic tool

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
gcnv::DiagnosticConfig diagnosticConfig = new gcnv::DiagnosticConfig();
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.DiagnoseInstanceAsync(name, diagnosticConfig);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceDiagnoseInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

GetEnvironment(GetEnvironmentRequest, CallSettings)

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

Gets details of a single Environment.

Parameters
Name Description
request GetEnvironmentRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Environment

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::GetEnvironmentRequest request = new gcnv::GetEnvironmentRequest { Name = "", };
// Make the request
gcnv::Environment response = notebookServiceClient.GetEnvironment(request);

GetEnvironment(string, CallSettings)

public virtual Environment GetEnvironment(string name, CallSettings callSettings = null)

Gets details of a single Environment.

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Environment

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string name = "";
// Make the request
gcnv::Environment response = notebookServiceClient.GetEnvironment(name);

GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

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

Gets details of a single Environment.

Parameters
Name Description
request GetEnvironmentRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEnvironment

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::GetEnvironmentRequest request = new gcnv::GetEnvironmentRequest { Name = "", };
// Make the request
gcnv::Environment response = await notebookServiceClient.GetEnvironmentAsync(request);

GetEnvironmentAsync(GetEnvironmentRequest, CancellationToken)

public virtual Task<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CancellationToken cancellationToken)

Gets details of a single Environment.

Parameters
Name Description
request GetEnvironmentRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEnvironment

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::GetEnvironmentRequest request = new gcnv::GetEnvironmentRequest { Name = "", };
// Make the request
gcnv::Environment response = await notebookServiceClient.GetEnvironmentAsync(request);

GetEnvironmentAsync(string, CallSettings)

public virtual Task<Environment> GetEnvironmentAsync(string name, CallSettings callSettings = null)

Gets details of a single Environment.

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEnvironment

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
gcnv::Environment response = await notebookServiceClient.GetEnvironmentAsync(name);

GetEnvironmentAsync(string, CancellationToken)

public virtual Task<Environment> GetEnvironmentAsync(string name, CancellationToken cancellationToken)

Gets details of a single Environment.

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEnvironment

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
gcnv::Environment response = await notebookServiceClient.GetEnvironmentAsync(name);

GetExecution(ExecutionName, CallSettings)

public virtual Execution GetExecution(ExecutionName name, CallSettings callSettings = null)

Gets details of executions

Parameters
Name Description
name ExecutionName

Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Execution

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::ExecutionName name = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]");
// Make the request
gcnv::Execution response = notebookServiceClient.GetExecution(name);

GetExecution(GetExecutionRequest, CallSettings)

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

Gets details of executions

Parameters
Name Description
request GetExecutionRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Execution

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::GetExecutionRequest request = new gcnv::GetExecutionRequest
{
    ExecutionName = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]"),
};
// Make the request
gcnv::Execution response = notebookServiceClient.GetExecution(request);

GetExecution(string, CallSettings)

public virtual Execution GetExecution(string name, CallSettings callSettings = null)

Gets details of executions

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Execution

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/location/[LOCATION]/executions/[EXECUTION]";
// Make the request
gcnv::Execution response = notebookServiceClient.GetExecution(name);

GetExecutionAsync(ExecutionName, CallSettings)

public virtual Task<Execution> GetExecutionAsync(ExecutionName name, CallSettings callSettings = null)

Gets details of executions

Parameters
Name Description
name ExecutionName

Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskExecution

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ExecutionName name = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]");
// Make the request
gcnv::Execution response = await notebookServiceClient.GetExecutionAsync(name);

GetExecutionAsync(ExecutionName, CancellationToken)

public virtual Task<Execution> GetExecutionAsync(ExecutionName name, CancellationToken cancellationToken)

Gets details of executions

Parameters
Name Description
name ExecutionName

Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskExecution

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ExecutionName name = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]");
// Make the request
gcnv::Execution response = await notebookServiceClient.GetExecutionAsync(name);

GetExecutionAsync(GetExecutionRequest, CallSettings)

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

Gets details of executions

Parameters
Name Description
request GetExecutionRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskExecution

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::GetExecutionRequest request = new gcnv::GetExecutionRequest
{
    ExecutionName = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]"),
};
// Make the request
gcnv::Execution response = await notebookServiceClient.GetExecutionAsync(request);

GetExecutionAsync(GetExecutionRequest, CancellationToken)

public virtual Task<Execution> GetExecutionAsync(GetExecutionRequest request, CancellationToken cancellationToken)

Gets details of executions

Parameters
Name Description
request GetExecutionRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskExecution

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::GetExecutionRequest request = new gcnv::GetExecutionRequest
{
    ExecutionName = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]"),
};
// Make the request
gcnv::Execution response = await notebookServiceClient.GetExecutionAsync(request);

GetExecutionAsync(string, CallSettings)

public virtual Task<Execution> GetExecutionAsync(string name, CallSettings callSettings = null)

Gets details of executions

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskExecution

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/location/[LOCATION]/executions/[EXECUTION]";
// Make the request
gcnv::Execution response = await notebookServiceClient.GetExecutionAsync(name);

GetExecutionAsync(string, CancellationToken)

public virtual Task<Execution> GetExecutionAsync(string name, CancellationToken cancellationToken)

Gets details of executions

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskExecution

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/location/[LOCATION]/executions/[EXECUTION]";
// Make the request
gcnv::Execution response = await notebookServiceClient.GetExecutionAsync(name);

GetInstance(GetInstanceRequest, CallSettings)

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

Gets details of a single Instance.

Parameters
Name Description
request GetInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Instance

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::GetInstanceRequest request = new gcnv::GetInstanceRequest { Name = "", };
// Make the request
gcnv::Instance response = notebookServiceClient.GetInstance(request);

GetInstance(string, CallSettings)

public virtual Instance GetInstance(string name, CallSettings callSettings = null)

Gets details of a single Instance.

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Instance

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string name = "";
// Make the request
gcnv::Instance response = notebookServiceClient.GetInstance(name);

GetInstanceAsync(GetInstanceRequest, CallSettings)

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

Gets details of a single Instance.

Parameters
Name Description
request GetInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskInstance

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::GetInstanceRequest request = new gcnv::GetInstanceRequest { Name = "", };
// Make the request
gcnv::Instance response = await notebookServiceClient.GetInstanceAsync(request);

GetInstanceAsync(GetInstanceRequest, CancellationToken)

public virtual Task<Instance> GetInstanceAsync(GetInstanceRequest request, CancellationToken cancellationToken)

Gets details of a single Instance.

Parameters
Name Description
request GetInstanceRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInstance

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::GetInstanceRequest request = new gcnv::GetInstanceRequest { Name = "", };
// Make the request
gcnv::Instance response = await notebookServiceClient.GetInstanceAsync(request);

GetInstanceAsync(string, CallSettings)

public virtual Task<Instance> GetInstanceAsync(string name, CallSettings callSettings = null)

Gets details of a single Instance.

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskInstance

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
gcnv::Instance response = await notebookServiceClient.GetInstanceAsync(name);

GetInstanceAsync(string, CancellationToken)

public virtual Task<Instance> GetInstanceAsync(string name, CancellationToken cancellationToken)

Gets details of a single Instance.

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInstance

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
gcnv::Instance response = await notebookServiceClient.GetInstanceAsync(name);

GetInstanceHealth(GetInstanceHealthRequest, CallSettings)

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

Check if a notebook instance is healthy.

Parameters
Name Description
request GetInstanceHealthRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
GetInstanceHealthResponse

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::GetInstanceHealthRequest request = new gcnv::GetInstanceHealthRequest
{
    InstanceName = gcnv::InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
};
// Make the request
gcnv::GetInstanceHealthResponse response = notebookServiceClient.GetInstanceHealth(request);

GetInstanceHealth(InstanceName, CallSettings)

public virtual GetInstanceHealthResponse GetInstanceHealth(InstanceName name, CallSettings callSettings = null)

Check if a notebook instance is healthy.

Parameters
Name Description
name InstanceName

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
GetInstanceHealthResponse

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::InstanceName name = gcnv::InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
gcnv::GetInstanceHealthResponse response = notebookServiceClient.GetInstanceHealth(name);

GetInstanceHealth(string, CallSettings)

public virtual GetInstanceHealthResponse GetInstanceHealth(string name, CallSettings callSettings = null)

Check if a notebook instance is healthy.

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
GetInstanceHealthResponse

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
gcnv::GetInstanceHealthResponse response = notebookServiceClient.GetInstanceHealth(name);

GetInstanceHealthAsync(GetInstanceHealthRequest, CallSettings)

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

Check if a notebook instance is healthy.

Parameters
Name Description
request GetInstanceHealthRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskGetInstanceHealthResponse

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::GetInstanceHealthRequest request = new gcnv::GetInstanceHealthRequest
{
    InstanceName = gcnv::InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
};
// Make the request
gcnv::GetInstanceHealthResponse response = await notebookServiceClient.GetInstanceHealthAsync(request);

GetInstanceHealthAsync(GetInstanceHealthRequest, CancellationToken)

public virtual Task<GetInstanceHealthResponse> GetInstanceHealthAsync(GetInstanceHealthRequest request, CancellationToken cancellationToken)

Check if a notebook instance is healthy.

Parameters
Name Description
request GetInstanceHealthRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskGetInstanceHealthResponse

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::GetInstanceHealthRequest request = new gcnv::GetInstanceHealthRequest
{
    InstanceName = gcnv::InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
};
// Make the request
gcnv::GetInstanceHealthResponse response = await notebookServiceClient.GetInstanceHealthAsync(request);

GetInstanceHealthAsync(InstanceName, CallSettings)

public virtual Task<GetInstanceHealthResponse> GetInstanceHealthAsync(InstanceName name, CallSettings callSettings = null)

Check if a notebook instance is healthy.

Parameters
Name Description
name InstanceName

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskGetInstanceHealthResponse

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::InstanceName name = gcnv::InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
gcnv::GetInstanceHealthResponse response = await notebookServiceClient.GetInstanceHealthAsync(name);

GetInstanceHealthAsync(InstanceName, CancellationToken)

public virtual Task<GetInstanceHealthResponse> GetInstanceHealthAsync(InstanceName name, CancellationToken cancellationToken)

Check if a notebook instance is healthy.

Parameters
Name Description
name InstanceName

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskGetInstanceHealthResponse

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::InstanceName name = gcnv::InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
gcnv::GetInstanceHealthResponse response = await notebookServiceClient.GetInstanceHealthAsync(name);

GetInstanceHealthAsync(string, CallSettings)

public virtual Task<GetInstanceHealthResponse> GetInstanceHealthAsync(string name, CallSettings callSettings = null)

Check if a notebook instance is healthy.

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskGetInstanceHealthResponse

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
gcnv::GetInstanceHealthResponse response = await notebookServiceClient.GetInstanceHealthAsync(name);

GetInstanceHealthAsync(string, CancellationToken)

public virtual Task<GetInstanceHealthResponse> GetInstanceHealthAsync(string name, CancellationToken cancellationToken)

Check if a notebook instance is healthy.

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskGetInstanceHealthResponse

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
gcnv::GetInstanceHealthResponse response = await notebookServiceClient.GetInstanceHealthAsync(name);

GetSchedule(GetScheduleRequest, CallSettings)

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

Gets details of schedule

Parameters
Name Description
request GetScheduleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Schedule

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::GetScheduleRequest request = new gcnv::GetScheduleRequest
{
    ScheduleName = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]"),
};
// Make the request
gcnv::Schedule response = notebookServiceClient.GetSchedule(request);

GetSchedule(ScheduleName, CallSettings)

public virtual Schedule GetSchedule(ScheduleName name, CallSettings callSettings = null)

Gets details of schedule

Parameters
Name Description
name ScheduleName

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Schedule

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::ScheduleName name = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
// Make the request
gcnv::Schedule response = notebookServiceClient.GetSchedule(name);

GetSchedule(string, CallSettings)

public virtual Schedule GetSchedule(string name, CallSettings callSettings = null)

Gets details of schedule

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Schedule

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/location/[LOCATION]/schedules/[SCHEDULE]";
// Make the request
gcnv::Schedule response = notebookServiceClient.GetSchedule(name);

GetScheduleAsync(GetScheduleRequest, CallSettings)

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

Gets details of schedule

Parameters
Name Description
request GetScheduleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSchedule

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::GetScheduleRequest request = new gcnv::GetScheduleRequest
{
    ScheduleName = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]"),
};
// Make the request
gcnv::Schedule response = await notebookServiceClient.GetScheduleAsync(request);

GetScheduleAsync(GetScheduleRequest, CancellationToken)

public virtual Task<Schedule> GetScheduleAsync(GetScheduleRequest request, CancellationToken cancellationToken)

Gets details of schedule

Parameters
Name Description
request GetScheduleRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSchedule

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::GetScheduleRequest request = new gcnv::GetScheduleRequest
{
    ScheduleName = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]"),
};
// Make the request
gcnv::Schedule response = await notebookServiceClient.GetScheduleAsync(request);

GetScheduleAsync(ScheduleName, CallSettings)

public virtual Task<Schedule> GetScheduleAsync(ScheduleName name, CallSettings callSettings = null)

Gets details of schedule

Parameters
Name Description
name ScheduleName

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSchedule

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ScheduleName name = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
// Make the request
gcnv::Schedule response = await notebookServiceClient.GetScheduleAsync(name);

GetScheduleAsync(ScheduleName, CancellationToken)

public virtual Task<Schedule> GetScheduleAsync(ScheduleName name, CancellationToken cancellationToken)

Gets details of schedule

Parameters
Name Description
name ScheduleName

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSchedule

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ScheduleName name = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
// Make the request
gcnv::Schedule response = await notebookServiceClient.GetScheduleAsync(name);

GetScheduleAsync(string, CallSettings)

public virtual Task<Schedule> GetScheduleAsync(string name, CallSettings callSettings = null)

Gets details of schedule

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSchedule

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/location/[LOCATION]/schedules/[SCHEDULE]";
// Make the request
gcnv::Schedule response = await notebookServiceClient.GetScheduleAsync(name);

GetScheduleAsync(string, CancellationToken)

public virtual Task<Schedule> GetScheduleAsync(string name, CancellationToken cancellationToken)

Gets details of schedule

Parameters
Name Description
name string

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSchedule

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/location/[LOCATION]/schedules/[SCHEDULE]";
// Make the request
gcnv::Schedule response = await notebookServiceClient.GetScheduleAsync(name);

IsInstanceUpgradeable(IsInstanceUpgradeableRequest, CallSettings)

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

Check if a notebook instance is upgradable.

Parameters
Name Description
request IsInstanceUpgradeableRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
IsInstanceUpgradeableResponse

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::IsInstanceUpgradeableRequest request = new gcnv::IsInstanceUpgradeableRequest
{
    NotebookInstance = "",
    Type = gcnv::UpgradeType.Unspecified,
};
// Make the request
gcnv::IsInstanceUpgradeableResponse response = notebookServiceClient.IsInstanceUpgradeable(request);

IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, CallSettings)

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

Check if a notebook instance is upgradable.

Parameters
Name Description
request IsInstanceUpgradeableRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskIsInstanceUpgradeableResponse

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::IsInstanceUpgradeableRequest request = new gcnv::IsInstanceUpgradeableRequest
{
    NotebookInstance = "",
    Type = gcnv::UpgradeType.Unspecified,
};
// Make the request
gcnv::IsInstanceUpgradeableResponse response = await notebookServiceClient.IsInstanceUpgradeableAsync(request);

IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, CancellationToken)

public virtual Task<IsInstanceUpgradeableResponse> IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest request, CancellationToken cancellationToken)

Check if a notebook instance is upgradable.

Parameters
Name Description
request IsInstanceUpgradeableRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskIsInstanceUpgradeableResponse

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::IsInstanceUpgradeableRequest request = new gcnv::IsInstanceUpgradeableRequest
{
    NotebookInstance = "",
    Type = gcnv::UpgradeType.Unspecified,
};
// Make the request
gcnv::IsInstanceUpgradeableResponse response = await notebookServiceClient.IsInstanceUpgradeableAsync(request);

ListEnvironments(ListEnvironmentsRequest, CallSettings)

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

Lists environments in a project.

Parameters
Name Description
request ListEnvironmentsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListEnvironmentsResponseEnvironment

A pageable sequence of Environment resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::ListEnvironmentsRequest request = new gcnv::ListEnvironmentsRequest { Parent = "", };
// Make the request
PagedEnumerable<gcnv::ListEnvironmentsResponse, gcnv::Environment> response = notebookServiceClient.ListEnvironments(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcnv::Environment item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcnv::ListEnvironmentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Environment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Environment> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Environment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEnvironments(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListEnvironmentsResponse, Environment> ListEnvironments(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists environments in a project.

Parameters
Name Description
parent string

Required. Format: projects/{project_id}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListEnvironmentsResponseEnvironment

A pageable sequence of Environment resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string parent = "";
// Make the request
PagedEnumerable<gcnv::ListEnvironmentsResponse, gcnv::Environment> response = notebookServiceClient.ListEnvironments(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcnv::Environment item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcnv::ListEnvironmentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Environment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Environment> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Environment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

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

Lists environments in a project.

Parameters
Name Description
request ListEnvironmentsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListEnvironmentsResponseEnvironment

A pageable asynchronous sequence of Environment resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ListEnvironmentsRequest request = new gcnv::ListEnvironmentsRequest { Parent = "", };
// Make the request
PagedAsyncEnumerable<gcnv::ListEnvironmentsResponse, gcnv::Environment> response = notebookServiceClient.ListEnvironmentsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcnv::Environment item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcnv::ListEnvironmentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Environment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Environment> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Environment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEnvironmentsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListEnvironmentsResponse, Environment> ListEnvironmentsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists environments in a project.

Parameters
Name Description
parent string

Required. Format: projects/{project_id}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListEnvironmentsResponseEnvironment

A pageable asynchronous sequence of Environment resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
// Make the request
PagedAsyncEnumerable<gcnv::ListEnvironmentsResponse, gcnv::Environment> response = notebookServiceClient.ListEnvironmentsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcnv::Environment item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcnv::ListEnvironmentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Environment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Environment> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Environment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListExecutions(ExecutionName, string, int?, CallSettings)

public virtual PagedEnumerable<ListExecutionsResponse, Execution> ListExecutions(ExecutionName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists executions in a given project and location

Parameters
Name Description
parent ExecutionName

Required. Format: parent=projects/{project_id}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListExecutionsResponseExecution

A pageable sequence of Execution resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::ExecutionName parent = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]");
// Make the request
PagedEnumerable<gcnv::ListExecutionsResponse, gcnv::Execution> response = notebookServiceClient.ListExecutions(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcnv::Execution item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcnv::ListExecutionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Execution item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Execution> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Execution item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListExecutions(ListExecutionsRequest, CallSettings)

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

Lists executions in a given project and location

Parameters
Name Description
request ListExecutionsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListExecutionsResponseExecution

A pageable sequence of Execution resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::ListExecutionsRequest request = new gcnv::ListExecutionsRequest
{
    ParentAsExecutionName = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<gcnv::ListExecutionsResponse, gcnv::Execution> response = notebookServiceClient.ListExecutions(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcnv::Execution item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcnv::ListExecutionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Execution item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Execution> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Execution item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListExecutions(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListExecutionsResponse, Execution> ListExecutions(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists executions in a given project and location

Parameters
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListExecutionsResponseExecution

A pageable sequence of Execution resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/location/[LOCATION]/executions/[EXECUTION]";
// Make the request
PagedEnumerable<gcnv::ListExecutionsResponse, gcnv::Execution> response = notebookServiceClient.ListExecutions(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcnv::Execution item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcnv::ListExecutionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Execution item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Execution> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Execution item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListExecutionsAsync(ExecutionName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListExecutionsResponse, Execution> ListExecutionsAsync(ExecutionName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists executions in a given project and location

Parameters
Name Description
parent ExecutionName

Required. Format: parent=projects/{project_id}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListExecutionsResponseExecution

A pageable asynchronous sequence of Execution resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ExecutionName parent = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]");
// Make the request
PagedAsyncEnumerable<gcnv::ListExecutionsResponse, gcnv::Execution> response = notebookServiceClient.ListExecutionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcnv::Execution item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcnv::ListExecutionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Execution item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Execution> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Execution item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListExecutionsAsync(ListExecutionsRequest, CallSettings)

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

Lists executions in a given project and location

Parameters
Name Description
request ListExecutionsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListExecutionsResponseExecution

A pageable asynchronous sequence of Execution resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ListExecutionsRequest request = new gcnv::ListExecutionsRequest
{
    ParentAsExecutionName = gcnv::ExecutionName.FromProjectLocationExecution("[PROJECT]", "[LOCATION]", "[EXECUTION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<gcnv::ListExecutionsResponse, gcnv::Execution> response = notebookServiceClient.ListExecutionsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcnv::Execution item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcnv::ListExecutionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Execution item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Execution> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Execution item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListExecutionsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListExecutionsResponse, Execution> ListExecutionsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists executions in a given project and location

Parameters
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListExecutionsResponseExecution

A pageable asynchronous sequence of Execution resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/location/[LOCATION]/executions/[EXECUTION]";
// Make the request
PagedAsyncEnumerable<gcnv::ListExecutionsResponse, gcnv::Execution> response = notebookServiceClient.ListExecutionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcnv::Execution item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcnv::ListExecutionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Execution item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Execution> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Execution item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListInstances(ListInstancesRequest, CallSettings)

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

Lists instances in a given project and location.

Parameters
Name Description
request ListInstancesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListInstancesResponseInstance

A pageable sequence of Instance resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::ListInstancesRequest request = new gcnv::ListInstancesRequest { Parent = "", };
// Make the request
PagedEnumerable<gcnv::ListInstancesResponse, gcnv::Instance> response = notebookServiceClient.ListInstances(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcnv::Instance item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcnv::ListInstancesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Instance item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Instance> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Instance item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListInstances(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListInstancesResponse, Instance> ListInstances(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists instances in a given project and location.

Parameters
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListInstancesResponseInstance

A pageable sequence of Instance resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string parent = "";
// Make the request
PagedEnumerable<gcnv::ListInstancesResponse, gcnv::Instance> response = notebookServiceClient.ListInstances(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcnv::Instance item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcnv::ListInstancesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Instance item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Instance> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Instance item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListInstancesAsync(ListInstancesRequest, CallSettings)

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

Lists instances in a given project and location.

Parameters
Name Description
request ListInstancesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListInstancesResponseInstance

A pageable asynchronous sequence of Instance resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ListInstancesRequest request = new gcnv::ListInstancesRequest { Parent = "", };
// Make the request
PagedAsyncEnumerable<gcnv::ListInstancesResponse, gcnv::Instance> response = notebookServiceClient.ListInstancesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcnv::Instance item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcnv::ListInstancesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Instance item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Instance> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Instance item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListInstancesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListInstancesResponse, Instance> ListInstancesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists instances in a given project and location.

Parameters
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListInstancesResponseInstance

A pageable asynchronous sequence of Instance resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
// Make the request
PagedAsyncEnumerable<gcnv::ListInstancesResponse, gcnv::Instance> response = notebookServiceClient.ListInstancesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcnv::Instance item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcnv::ListInstancesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Instance item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Instance> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Instance item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSchedules(ListSchedulesRequest, CallSettings)

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

Lists schedules in a given project and location.

Parameters
Name Description
request ListSchedulesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListSchedulesResponseSchedule

A pageable sequence of Schedule resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::ListSchedulesRequest request = new gcnv::ListSchedulesRequest
{
    ParentAsScheduleName = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<gcnv::ListSchedulesResponse, gcnv::Schedule> response = notebookServiceClient.ListSchedules(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcnv::Schedule item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcnv::ListSchedulesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Schedule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Schedule> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Schedule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSchedules(ScheduleName, string, int?, CallSettings)

public virtual PagedEnumerable<ListSchedulesResponse, Schedule> ListSchedules(ScheduleName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists schedules in a given project and location.

Parameters
Name Description
parent ScheduleName

Required. Format: parent=projects/{project_id}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListSchedulesResponseSchedule

A pageable sequence of Schedule resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::ScheduleName parent = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
// Make the request
PagedEnumerable<gcnv::ListSchedulesResponse, gcnv::Schedule> response = notebookServiceClient.ListSchedules(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcnv::Schedule item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcnv::ListSchedulesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Schedule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Schedule> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Schedule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSchedules(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListSchedulesResponse, Schedule> ListSchedules(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists schedules in a given project and location.

Parameters
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListSchedulesResponseSchedule

A pageable sequence of Schedule resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/location/[LOCATION]/schedules/[SCHEDULE]";
// Make the request
PagedEnumerable<gcnv::ListSchedulesResponse, gcnv::Schedule> response = notebookServiceClient.ListSchedules(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcnv::Schedule item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcnv::ListSchedulesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Schedule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Schedule> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Schedule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSchedulesAsync(ListSchedulesRequest, CallSettings)

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

Lists schedules in a given project and location.

Parameters
Name Description
request ListSchedulesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListSchedulesResponseSchedule

A pageable asynchronous sequence of Schedule resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ListSchedulesRequest request = new gcnv::ListSchedulesRequest
{
    ParentAsScheduleName = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<gcnv::ListSchedulesResponse, gcnv::Schedule> response = notebookServiceClient.ListSchedulesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcnv::Schedule item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcnv::ListSchedulesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Schedule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Schedule> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Schedule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSchedulesAsync(ScheduleName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListSchedulesResponse, Schedule> ListSchedulesAsync(ScheduleName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists schedules in a given project and location.

Parameters
Name Description
parent ScheduleName

Required. Format: parent=projects/{project_id}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListSchedulesResponseSchedule

A pageable asynchronous sequence of Schedule resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ScheduleName parent = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
// Make the request
PagedAsyncEnumerable<gcnv::ListSchedulesResponse, gcnv::Schedule> response = notebookServiceClient.ListSchedulesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcnv::Schedule item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcnv::ListSchedulesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Schedule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Schedule> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Schedule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSchedulesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListSchedulesResponse, Schedule> ListSchedulesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists schedules in a given project and location.

Parameters
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListSchedulesResponseSchedule

A pageable asynchronous sequence of Schedule resources.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/location/[LOCATION]/schedules/[SCHEDULE]";
// Make the request
PagedAsyncEnumerable<gcnv::ListSchedulesResponse, gcnv::Schedule> response = notebookServiceClient.ListSchedulesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcnv::Schedule item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcnv::ListSchedulesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcnv::Schedule item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcnv::Schedule> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcnv::Schedule item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceCreateEnvironment(string, CallSettings)

public virtual Operation<Environment, OperationMetadata> PollOnceCreateEnvironment(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateEnvironment .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEnvironmentOperationMetadata

The result of polling the operation.

PollOnceCreateEnvironmentAsync(string, CallSettings)

public virtual Task<Operation<Environment, OperationMetadata>> PollOnceCreateEnvironmentAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateEnvironment.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEnvironmentOperationMetadata

A task representing the result of polling the operation.

PollOnceCreateExecution(string, CallSettings)

public virtual Operation<Execution, OperationMetadata> PollOnceCreateExecution(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateExecution.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationExecutionOperationMetadata

The result of polling the operation.

PollOnceCreateExecutionAsync(string, CallSettings)

public virtual Task<Operation<Execution, OperationMetadata>> PollOnceCreateExecutionAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateExecution.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationExecutionOperationMetadata

A task representing the result of polling the operation.

PollOnceCreateInstance(string, CallSettings)

public virtual Operation<Instance, OperationMetadata> PollOnceCreateInstance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceCreateInstanceAsync(string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> PollOnceCreateInstanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceCreateSchedule(string, CallSettings)

public virtual Operation<Schedule, OperationMetadata> PollOnceCreateSchedule(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateSchedule.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationScheduleOperationMetadata

The result of polling the operation.

PollOnceCreateScheduleAsync(string, CallSettings)

public virtual Task<Operation<Schedule, OperationMetadata>> PollOnceCreateScheduleAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateSchedule.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationScheduleOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteEnvironment(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteEnvironment(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteEnvironment .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteEnvironmentAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteEnvironmentAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteEnvironment.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteExecution(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteExecution(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteExecution.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteExecutionAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteExecutionAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteExecution.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteInstance(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteInstance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteInstanceAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteInstanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteSchedule(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteSchedule(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteSchedule.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteScheduleAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteScheduleAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteSchedule.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A task representing the result of polling the operation.

PollOnceDiagnoseInstance(string, CallSettings)

public virtual Operation<Instance, OperationMetadata> PollOnceDiagnoseInstance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DiagnoseInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceDiagnoseInstanceAsync(string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> PollOnceDiagnoseInstanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DiagnoseInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceRegisterInstance(string, CallSettings)

public virtual Operation<Instance, OperationMetadata> PollOnceRegisterInstance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of RegisterInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceRegisterInstanceAsync(string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> PollOnceRegisterInstanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of RegisterInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceReportInstanceInfo(string, CallSettings)

public virtual Operation<Instance, OperationMetadata> PollOnceReportInstanceInfo(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ReportInstanceInfo .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceReportInstanceInfoAsync(string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> PollOnceReportInstanceInfoAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ReportInstanceInfo.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceResetInstance(string, CallSettings)

public virtual Operation<Instance, OperationMetadata> PollOnceResetInstance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ResetInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceResetInstanceAsync(string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> PollOnceResetInstanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ResetInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceRollbackInstance(string, CallSettings)

public virtual Operation<Instance, OperationMetadata> PollOnceRollbackInstance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of RollbackInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceRollbackInstanceAsync(string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> PollOnceRollbackInstanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of RollbackInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceSetInstanceAccelerator(string, CallSettings)

public virtual Operation<Instance, OperationMetadata> PollOnceSetInstanceAccelerator(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of SetInstanceAccelerator.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceSetInstanceAcceleratorAsync(string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> PollOnceSetInstanceAcceleratorAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of SetInstanceAccelerator.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceSetInstanceLabels(string, CallSettings)

public virtual Operation<Instance, OperationMetadata> PollOnceSetInstanceLabels(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of SetInstanceLabels .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceSetInstanceLabelsAsync(string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> PollOnceSetInstanceLabelsAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of SetInstanceLabels.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceSetInstanceMachineType(string, CallSettings)

public virtual Operation<Instance, OperationMetadata> PollOnceSetInstanceMachineType(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of SetInstanceMachineType.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceSetInstanceMachineTypeAsync(string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> PollOnceSetInstanceMachineTypeAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of SetInstanceMachineType.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceStartInstance(string, CallSettings)

public virtual Operation<Instance, OperationMetadata> PollOnceStartInstance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of StartInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceStartInstanceAsync(string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> PollOnceStartInstanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of StartInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceStopInstance(string, CallSettings)

public virtual Operation<Instance, OperationMetadata> PollOnceStopInstance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of StopInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceStopInstanceAsync(string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> PollOnceStopInstanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of StopInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceTriggerSchedule(string, CallSettings)

public virtual Operation<Schedule, OperationMetadata> PollOnceTriggerSchedule(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of TriggerSchedule.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationScheduleOperationMetadata

The result of polling the operation.

PollOnceTriggerScheduleAsync(string, CallSettings)

public virtual Task<Operation<Schedule, OperationMetadata>> PollOnceTriggerScheduleAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of TriggerSchedule.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationScheduleOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateInstanceConfig(string, CallSettings)

public virtual Operation<Instance, OperationMetadata> PollOnceUpdateInstanceConfig(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateInstanceConfig .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceUpdateInstanceConfigAsync(string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> PollOnceUpdateInstanceConfigAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateInstanceConfig.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateShieldedInstanceConfig(string, CallSettings)

public virtual Operation<Instance, OperationMetadata> PollOnceUpdateShieldedInstanceConfig(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateShieldedInstanceConfig.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceUpdateShieldedInstanceConfigAsync(string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> PollOnceUpdateShieldedInstanceConfigAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateShieldedInstanceConfig.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceUpgradeInstance(string, CallSettings)

public virtual Operation<Instance, OperationMetadata> PollOnceUpgradeInstance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpgradeInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceUpgradeInstanceAsync(string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> PollOnceUpgradeInstanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpgradeInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceUpgradeInstanceInternal(string, CallSettings)

public virtual Operation<Instance, OperationMetadata> PollOnceUpgradeInstanceInternal(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpgradeInstanceInternal.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceUpgradeInstanceInternalAsync(string, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> PollOnceUpgradeInstanceInternalAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpgradeInstanceInternal.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

RegisterInstance(RegisterInstanceRequest, CallSettings)

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

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

Parameters
Name Description
request RegisterInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::RegisterInstanceRequest request = new gcnv::RegisterInstanceRequest
{
    Parent = "",
    InstanceId = "",
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.RegisterInstance(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceRegisterInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

RegisterInstanceAsync(RegisterInstanceRequest, CallSettings)

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

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

Parameters
Name Description
request RegisterInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::RegisterInstanceRequest request = new gcnv::RegisterInstanceRequest
{
    Parent = "",
    InstanceId = "",
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.RegisterInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceRegisterInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

RegisterInstanceAsync(RegisterInstanceRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> RegisterInstanceAsync(RegisterInstanceRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request RegisterInstanceRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::RegisterInstanceRequest request = new gcnv::RegisterInstanceRequest
{
    Parent = "",
    InstanceId = "",
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.RegisterInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceRegisterInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

ReportInstanceInfo(ReportInstanceInfoRequest, CallSettings)

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

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

Parameters
Name Description
request ReportInstanceInfoRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::ReportInstanceInfoRequest request = new gcnv::ReportInstanceInfoRequest
{
    Name = "",
    VmId = "",
    Metadata = { { "", "" }, },
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.ReportInstanceInfo(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceReportInstanceInfo(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

ReportInstanceInfoAsync(ReportInstanceInfoRequest, CallSettings)

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

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

Parameters
Name Description
request ReportInstanceInfoRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ReportInstanceInfoRequest request = new gcnv::ReportInstanceInfoRequest
{
    Name = "",
    VmId = "",
    Metadata = { { "", "" }, },
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.ReportInstanceInfoAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceReportInstanceInfoAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

ReportInstanceInfoAsync(ReportInstanceInfoRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> ReportInstanceInfoAsync(ReportInstanceInfoRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request ReportInstanceInfoRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ReportInstanceInfoRequest request = new gcnv::ReportInstanceInfoRequest
{
    Name = "",
    VmId = "",
    Metadata = { { "", "" }, },
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.ReportInstanceInfoAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceReportInstanceInfoAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

ResetInstance(ResetInstanceRequest, CallSettings)

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

Resets a notebook instance.

Parameters
Name Description
request ResetInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::ResetInstanceRequest request = new gcnv::ResetInstanceRequest { Name = "", };
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.ResetInstance(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceResetInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

ResetInstanceAsync(ResetInstanceRequest, CallSettings)

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

Resets a notebook instance.

Parameters
Name Description
request ResetInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ResetInstanceRequest request = new gcnv::ResetInstanceRequest { Name = "", };
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.ResetInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceResetInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

ResetInstanceAsync(ResetInstanceRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> ResetInstanceAsync(ResetInstanceRequest request, CancellationToken cancellationToken)

Resets a notebook instance.

Parameters
Name Description
request ResetInstanceRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::ResetInstanceRequest request = new gcnv::ResetInstanceRequest { Name = "", };
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.ResetInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceResetInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

RollbackInstance(RollbackInstanceRequest, CallSettings)

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

Rollbacks a notebook instance to the previous version.

Parameters
Name Description
request RollbackInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::RollbackInstanceRequest request = new gcnv::RollbackInstanceRequest
{
    Name = "",
    TargetSnapshot = "",
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.RollbackInstance(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceRollbackInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

RollbackInstanceAsync(RollbackInstanceRequest, CallSettings)

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

Rollbacks a notebook instance to the previous version.

Parameters
Name Description
request RollbackInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::RollbackInstanceRequest request = new gcnv::RollbackInstanceRequest
{
    Name = "",
    TargetSnapshot = "",
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.RollbackInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceRollbackInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

RollbackInstanceAsync(RollbackInstanceRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> RollbackInstanceAsync(RollbackInstanceRequest request, CancellationToken cancellationToken)

Rollbacks a notebook instance to the previous version.

Parameters
Name Description
request RollbackInstanceRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::RollbackInstanceRequest request = new gcnv::RollbackInstanceRequest
{
    Name = "",
    TargetSnapshot = "",
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.RollbackInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceRollbackInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

SetInstanceAccelerator(SetInstanceAcceleratorRequest, CallSettings)

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

Updates the guest accelerators of a single Instance.

Parameters
Name Description
request SetInstanceAcceleratorRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::SetInstanceAcceleratorRequest request = new gcnv::SetInstanceAcceleratorRequest
{
    Name = "",
    Type = gcnv::Instance.Types.AcceleratorType.Unspecified,
    CoreCount = 0L,
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.SetInstanceAccelerator(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceSetInstanceAccelerator(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, CallSettings)

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

Updates the guest accelerators of a single Instance.

Parameters
Name Description
request SetInstanceAcceleratorRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::SetInstanceAcceleratorRequest request = new gcnv::SetInstanceAcceleratorRequest
{
    Name = "",
    Type = gcnv::Instance.Types.AcceleratorType.Unspecified,
    CoreCount = 0L,
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.SetInstanceAcceleratorAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceSetInstanceAcceleratorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> SetInstanceAcceleratorAsync(SetInstanceAcceleratorRequest request, CancellationToken cancellationToken)

Updates the guest accelerators of a single Instance.

Parameters
Name Description
request SetInstanceAcceleratorRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::SetInstanceAcceleratorRequest request = new gcnv::SetInstanceAcceleratorRequest
{
    Name = "",
    Type = gcnv::Instance.Types.AcceleratorType.Unspecified,
    CoreCount = 0L,
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.SetInstanceAcceleratorAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceSetInstanceAcceleratorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

SetInstanceLabels(SetInstanceLabelsRequest, CallSettings)

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

Replaces all the labels of an Instance.

Parameters
Name Description
request SetInstanceLabelsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::SetInstanceLabelsRequest request = new gcnv::SetInstanceLabelsRequest
{
    Name = "",
    Labels = { { "", "" }, },
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.SetInstanceLabels(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceSetInstanceLabels(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

SetInstanceLabelsAsync(SetInstanceLabelsRequest, CallSettings)

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

Replaces all the labels of an Instance.

Parameters
Name Description
request SetInstanceLabelsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::SetInstanceLabelsRequest request = new gcnv::SetInstanceLabelsRequest
{
    Name = "",
    Labels = { { "", "" }, },
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.SetInstanceLabelsAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceSetInstanceLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

SetInstanceLabelsAsync(SetInstanceLabelsRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> SetInstanceLabelsAsync(SetInstanceLabelsRequest request, CancellationToken cancellationToken)

Replaces all the labels of an Instance.

Parameters
Name Description
request SetInstanceLabelsRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::SetInstanceLabelsRequest request = new gcnv::SetInstanceLabelsRequest
{
    Name = "",
    Labels = { { "", "" }, },
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.SetInstanceLabelsAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceSetInstanceLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

SetInstanceMachineType(SetInstanceMachineTypeRequest, CallSettings)

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

Updates the machine type of a single Instance.

Parameters
Name Description
request SetInstanceMachineTypeRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::SetInstanceMachineTypeRequest request = new gcnv::SetInstanceMachineTypeRequest
{
    Name = "",
    MachineType = "",
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.SetInstanceMachineType(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceSetInstanceMachineType(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, CallSettings)

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

Updates the machine type of a single Instance.

Parameters
Name Description
request SetInstanceMachineTypeRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::SetInstanceMachineTypeRequest request = new gcnv::SetInstanceMachineTypeRequest
{
    Name = "",
    MachineType = "",
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.SetInstanceMachineTypeAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceSetInstanceMachineTypeAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> SetInstanceMachineTypeAsync(SetInstanceMachineTypeRequest request, CancellationToken cancellationToken)

Updates the machine type of a single Instance.

Parameters
Name Description
request SetInstanceMachineTypeRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::SetInstanceMachineTypeRequest request = new gcnv::SetInstanceMachineTypeRequest
{
    Name = "",
    MachineType = "",
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.SetInstanceMachineTypeAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceSetInstanceMachineTypeAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

StartInstance(StartInstanceRequest, CallSettings)

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

Starts a notebook instance.

Parameters
Name Description
request StartInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::StartInstanceRequest request = new gcnv::StartInstanceRequest { Name = "", };
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.StartInstance(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceStartInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

StartInstanceAsync(StartInstanceRequest, CallSettings)

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

Starts a notebook instance.

Parameters
Name Description
request StartInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::StartInstanceRequest request = new gcnv::StartInstanceRequest { Name = "", };
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.StartInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceStartInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

StartInstanceAsync(StartInstanceRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> StartInstanceAsync(StartInstanceRequest request, CancellationToken cancellationToken)

Starts a notebook instance.

Parameters
Name Description
request StartInstanceRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::StartInstanceRequest request = new gcnv::StartInstanceRequest { Name = "", };
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.StartInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceStartInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

StopInstance(StopInstanceRequest, CallSettings)

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

Stops a notebook instance.

Parameters
Name Description
request StopInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::StopInstanceRequest request = new gcnv::StopInstanceRequest { Name = "", };
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.StopInstance(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceStopInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

StopInstanceAsync(StopInstanceRequest, CallSettings)

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

Stops a notebook instance.

Parameters
Name Description
request StopInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::StopInstanceRequest request = new gcnv::StopInstanceRequest { Name = "", };
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.StopInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceStopInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

StopInstanceAsync(StopInstanceRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> StopInstanceAsync(StopInstanceRequest request, CancellationToken cancellationToken)

Stops a notebook instance.

Parameters
Name Description
request StopInstanceRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::StopInstanceRequest request = new gcnv::StopInstanceRequest { Name = "", };
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.StopInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceStopInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

TriggerSchedule(TriggerScheduleRequest, CallSettings)

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

Triggers execution of an existing schedule.

Parameters
Name Description
request TriggerScheduleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationScheduleOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::TriggerScheduleRequest request = new gcnv::TriggerScheduleRequest
{
    ScheduleName = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]"),
};
// Make the request
Operation<gcnv::Schedule, gcnv::OperationMetadata> response = notebookServiceClient.TriggerSchedule(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Schedule, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Schedule result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Schedule, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceTriggerSchedule(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Schedule retrievedResult = retrievedResponse.Result;
}

TriggerScheduleAsync(TriggerScheduleRequest, CallSettings)

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

Triggers execution of an existing schedule.

Parameters
Name Description
request TriggerScheduleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationScheduleOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::TriggerScheduleRequest request = new gcnv::TriggerScheduleRequest
{
    ScheduleName = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]"),
};
// Make the request
Operation<gcnv::Schedule, gcnv::OperationMetadata> response = await notebookServiceClient.TriggerScheduleAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Schedule, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Schedule result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Schedule, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceTriggerScheduleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Schedule retrievedResult = retrievedResponse.Result;
}

TriggerScheduleAsync(TriggerScheduleRequest, CancellationToken)

public virtual Task<Operation<Schedule, OperationMetadata>> TriggerScheduleAsync(TriggerScheduleRequest request, CancellationToken cancellationToken)

Triggers execution of an existing schedule.

Parameters
Name Description
request TriggerScheduleRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationScheduleOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::TriggerScheduleRequest request = new gcnv::TriggerScheduleRequest
{
    ScheduleName = gcnv::ScheduleName.FromProjectLocationSchedule("[PROJECT]", "[LOCATION]", "[SCHEDULE]"),
};
// Make the request
Operation<gcnv::Schedule, gcnv::OperationMetadata> response = await notebookServiceClient.TriggerScheduleAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Schedule, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Schedule result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Schedule, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceTriggerScheduleAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Schedule retrievedResult = retrievedResponse.Result;
}

UpdateInstanceConfig(UpdateInstanceConfigRequest, CallSettings)

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

Update Notebook Instance configurations.

Parameters
Name Description
request UpdateInstanceConfigRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::UpdateInstanceConfigRequest request = new gcnv::UpdateInstanceConfigRequest
{
    Name = "",
    Config = new gcnv::InstanceConfig(),
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.UpdateInstanceConfig(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceUpdateInstanceConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

UpdateInstanceConfigAsync(UpdateInstanceConfigRequest, CallSettings)

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

Update Notebook Instance configurations.

Parameters
Name Description
request UpdateInstanceConfigRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::UpdateInstanceConfigRequest request = new gcnv::UpdateInstanceConfigRequest
{
    Name = "",
    Config = new gcnv::InstanceConfig(),
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.UpdateInstanceConfigAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceUpdateInstanceConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

UpdateInstanceConfigAsync(UpdateInstanceConfigRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> UpdateInstanceConfigAsync(UpdateInstanceConfigRequest request, CancellationToken cancellationToken)

Update Notebook Instance configurations.

Parameters
Name Description
request UpdateInstanceConfigRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::UpdateInstanceConfigRequest request = new gcnv::UpdateInstanceConfigRequest
{
    Name = "",
    Config = new gcnv::InstanceConfig(),
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.UpdateInstanceConfigAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceUpdateInstanceConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest, CallSettings)

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

Add/update metadata items for an instance.

Parameters
Name Description
request UpdateInstanceMetadataItemsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
UpdateInstanceMetadataItemsResponse

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::UpdateInstanceMetadataItemsRequest request = new gcnv::UpdateInstanceMetadataItemsRequest
{
    Name = "",
    Items = { { "", "" }, },
};
// Make the request
gcnv::UpdateInstanceMetadataItemsResponse response = notebookServiceClient.UpdateInstanceMetadataItems(request);

UpdateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest, CallSettings)

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

Add/update metadata items for an instance.

Parameters
Name Description
request UpdateInstanceMetadataItemsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskUpdateInstanceMetadataItemsResponse

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::UpdateInstanceMetadataItemsRequest request = new gcnv::UpdateInstanceMetadataItemsRequest
{
    Name = "",
    Items = { { "", "" }, },
};
// Make the request
gcnv::UpdateInstanceMetadataItemsResponse response = await notebookServiceClient.UpdateInstanceMetadataItemsAsync(request);

UpdateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest, CancellationToken)

public virtual Task<UpdateInstanceMetadataItemsResponse> UpdateInstanceMetadataItemsAsync(UpdateInstanceMetadataItemsRequest request, CancellationToken cancellationToken)

Add/update metadata items for an instance.

Parameters
Name Description
request UpdateInstanceMetadataItemsRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskUpdateInstanceMetadataItemsResponse

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::UpdateInstanceMetadataItemsRequest request = new gcnv::UpdateInstanceMetadataItemsRequest
{
    Name = "",
    Items = { { "", "" }, },
};
// Make the request
gcnv::UpdateInstanceMetadataItemsResponse response = await notebookServiceClient.UpdateInstanceMetadataItemsAsync(request);

UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest, CallSettings)

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

Updates the Shielded instance configuration of a single Instance.

Parameters
Name Description
request UpdateShieldedInstanceConfigRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::UpdateShieldedInstanceConfigRequest request = new gcnv::UpdateShieldedInstanceConfigRequest
{
    Name = "",
    ShieldedInstanceConfig = new gcnv::Instance.Types.ShieldedInstanceConfig(),
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.UpdateShieldedInstanceConfig(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceUpdateShieldedInstanceConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigRequest, CallSettings)

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

Updates the Shielded instance configuration of a single Instance.

Parameters
Name Description
request UpdateShieldedInstanceConfigRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::UpdateShieldedInstanceConfigRequest request = new gcnv::UpdateShieldedInstanceConfigRequest
{
    Name = "",
    ShieldedInstanceConfig = new gcnv::Instance.Types.ShieldedInstanceConfig(),
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.UpdateShieldedInstanceConfigAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceUpdateShieldedInstanceConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigRequest request, CancellationToken cancellationToken)

Updates the Shielded instance configuration of a single Instance.

Parameters
Name Description
request UpdateShieldedInstanceConfigRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::UpdateShieldedInstanceConfigRequest request = new gcnv::UpdateShieldedInstanceConfigRequest
{
    Name = "",
    ShieldedInstanceConfig = new gcnv::Instance.Types.ShieldedInstanceConfig(),
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.UpdateShieldedInstanceConfigAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceUpdateShieldedInstanceConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

UpgradeInstance(UpgradeInstanceRequest, CallSettings)

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

Upgrades a notebook instance to the latest version.

Parameters
Name Description
request UpgradeInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::UpgradeInstanceRequest request = new gcnv::UpgradeInstanceRequest
{
    Name = "",
    Type = gcnv::UpgradeType.Unspecified,
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.UpgradeInstance(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceUpgradeInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

UpgradeInstanceAsync(UpgradeInstanceRequest, CallSettings)

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

Upgrades a notebook instance to the latest version.

Parameters
Name Description
request UpgradeInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::UpgradeInstanceRequest request = new gcnv::UpgradeInstanceRequest
{
    Name = "",
    Type = gcnv::UpgradeType.Unspecified,
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.UpgradeInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceUpgradeInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

UpgradeInstanceAsync(UpgradeInstanceRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> UpgradeInstanceAsync(UpgradeInstanceRequest request, CancellationToken cancellationToken)

Upgrades a notebook instance to the latest version.

Parameters
Name Description
request UpgradeInstanceRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::UpgradeInstanceRequest request = new gcnv::UpgradeInstanceRequest
{
    Name = "",
    Type = gcnv::UpgradeType.Unspecified,
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.UpgradeInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceUpgradeInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

UpgradeInstanceInternal(UpgradeInstanceInternalRequest, CallSettings)

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

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

Parameters
Name Description
request UpgradeInstanceInternalRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
// Initialize request argument(s)
gcnv::UpgradeInstanceInternalRequest request = new gcnv::UpgradeInstanceInternalRequest
{
    Name = "",
    VmId = "",
    Type = gcnv::UpgradeType.Unspecified,
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.UpgradeInstanceInternal(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceUpgradeInstanceInternal(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest, CallSettings)

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

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

Parameters
Name Description
request UpgradeInstanceInternalRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::UpgradeInstanceInternalRequest request = new gcnv::UpgradeInstanceInternalRequest
{
    Name = "",
    VmId = "",
    Type = gcnv::UpgradeType.Unspecified,
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.UpgradeInstanceInternalAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceUpgradeInstanceInternalAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}

UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> UpgradeInstanceInternalAsync(UpgradeInstanceInternalRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request UpgradeInstanceInternalRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcnv::NotebookServiceClient notebookServiceClient = await gcnv::NotebookServiceClient.CreateAsync();
// Initialize request argument(s)
gcnv::UpgradeInstanceInternalRequest request = new gcnv::UpgradeInstanceInternalRequest
{
    Name = "",
    VmId = "",
    Type = gcnv::UpgradeType.Unspecified,
};
// Make the request
Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.UpgradeInstanceInternalAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcnv::Instance, gcnv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcnv::Instance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceUpgradeInstanceInternalAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcnv::Instance retrievedResult = retrievedResponse.Result;
}