AI Platform Notebooks v1beta1 API - Class NotebookServiceClient (2.0.0-beta04)

public abstract class NotebookServiceClient

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

NotebookService client wrapper, for convenient use.

Inheritance

object > NotebookServiceClient

Namespace

Google.Cloud.Notebooks.V1Beta1

Assembly

Google.Cloud.Notebooks.V1Beta1.dll

Remarks

API v1beta1 service for Cloud AI Platform Notebooks.

Properties

CreateEnvironmentOperationsClient

public virtual OperationsClient CreateEnvironmentOperationsClient { get; }

The long-running operations client for CreateEnvironment.

Property Value
TypeDescription
OperationsClient

CreateInstanceOperationsClient

public virtual OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
TypeDescription
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
TypeDescription
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default NotebookService scopes.

Property Value
TypeDescription
IReadOnlyListstring
Remarks

The default NotebookService scopes are:

DeleteEnvironmentOperationsClient

public virtual OperationsClient DeleteEnvironmentOperationsClient { get; }

The long-running operations client for DeleteEnvironment.

Property Value
TypeDescription
OperationsClient

DeleteInstanceOperationsClient

public virtual OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value
TypeDescription
OperationsClient

GrpcClient

public virtual NotebookService.NotebookServiceClient GrpcClient { get; }

The underlying gRPC NotebookService client

Property Value
TypeDescription
NotebookServiceNotebookServiceClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
TypeDescription
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient

RegisterInstanceOperationsClient

public virtual OperationsClient RegisterInstanceOperationsClient { get; }

The long-running operations client for RegisterInstance.

Property Value
TypeDescription
OperationsClient

ReportInstanceInfoOperationsClient

public virtual OperationsClient ReportInstanceInfoOperationsClient { get; }

The long-running operations client for ReportInstanceInfo.

Property Value
TypeDescription
OperationsClient

ResetInstanceOperationsClient

public virtual OperationsClient ResetInstanceOperationsClient { get; }

The long-running operations client for ResetInstance.

Property Value
TypeDescription
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

SetInstanceAcceleratorOperationsClient

public virtual OperationsClient SetInstanceAcceleratorOperationsClient { get; }

The long-running operations client for SetInstanceAccelerator.

Property Value
TypeDescription
OperationsClient

SetInstanceLabelsOperationsClient

public virtual OperationsClient SetInstanceLabelsOperationsClient { get; }

The long-running operations client for SetInstanceLabels.

Property Value
TypeDescription
OperationsClient

SetInstanceMachineTypeOperationsClient

public virtual OperationsClient SetInstanceMachineTypeOperationsClient { get; }

The long-running operations client for SetInstanceMachineType.

Property Value
TypeDescription
OperationsClient

StartInstanceOperationsClient

public virtual OperationsClient StartInstanceOperationsClient { get; }

The long-running operations client for StartInstance.

Property Value
TypeDescription
OperationsClient

StopInstanceOperationsClient

public virtual OperationsClient StopInstanceOperationsClient { get; }

The long-running operations client for StopInstance.

Property Value
TypeDescription
OperationsClient

UpgradeInstanceInternalOperationsClient

public virtual OperationsClient UpgradeInstanceInternalOperationsClient { get; }

The long-running operations client for UpgradeInstanceInternal.

Property Value
TypeDescription
OperationsClient

UpgradeInstanceOperationsClient

public virtual OperationsClient UpgradeInstanceOperationsClient { get; }

The long-running operations client for UpgradeInstance.

Property Value
TypeDescription
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
TypeDescription
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
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
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
NameDescription
requestCreateEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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;
}

CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

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

Creates a new Environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestCreateEnvironmentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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;
}

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
NameDescription
requestCreateInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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;
}

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
NameDescription
requestCreateInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestCreateInstanceRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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;
}

DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

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

Deletes a single Environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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;
}

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

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

Deletes a single Environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestDeleteEnvironmentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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;
}

DeleteInstance(DeleteInstanceRequest, CallSettings)

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

Deletes a single Instance.

Parameters
NameDescription
requestDeleteInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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;
}

DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

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

Deletes a single Instance.

Parameters
NameDescription
requestDeleteInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestDeleteInstanceRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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;
}

GetEnvironment(GetEnvironmentRequest, CallSettings)

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

Gets details of a single Environment.

Parameters
NameDescription
requestGetEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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);

GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

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

Gets details of a single Environment.

Parameters
NameDescription
requestGetEnvironmentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetEnvironmentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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);

GetInstance(GetInstanceRequest, CallSettings)

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

Gets details of a single Instance.

Parameters
NameDescription
requestGetInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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);

GetInstanceAsync(GetInstanceRequest, CallSettings)

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

Gets details of a single Instance.

Parameters
NameDescription
requestGetInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetInstanceRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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);

IsInstanceUpgradeable(IsInstanceUpgradeableRequest, CallSettings)

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

Check if a notebook instance is upgradable. Deprecated. Please consider using v1.

Parameters
NameDescription
requestIsInstanceUpgradeableRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
IsInstanceUpgradeableResponse

The RPC response.

Example
            // Create client
            gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
            // Initialize request argument(s)
            gcnv::IsInstanceUpgradeableRequest request = new gcnv::IsInstanceUpgradeableRequest
            {
                NotebookInstance = "",
            };
            // Make the request
#pragma warning disable CS0612
            gcnv::IsInstanceUpgradeableResponse response = notebookServiceClient.IsInstanceUpgradeable(request);
#pragma warning restore CS0612

IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, CallSettings)

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

Check if a notebook instance is upgradable. Deprecated. Please consider using v1.

Parameters
NameDescription
requestIsInstanceUpgradeableRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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 = "",
            };
            // Make the request
#pragma warning disable CS0612
            gcnv::IsInstanceUpgradeableResponse response = await notebookServiceClient.IsInstanceUpgradeableAsync(request);
#pragma warning restore CS0612

IsInstanceUpgradeableAsync(IsInstanceUpgradeableRequest, CancellationToken)

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

Check if a notebook instance is upgradable. Deprecated. Please consider using v1.

Parameters
NameDescription
requestIsInstanceUpgradeableRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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 = "",
            };
            // Make the request
#pragma warning disable CS0612
            gcnv::IsInstanceUpgradeableResponse response = await notebookServiceClient.IsInstanceUpgradeableAsync(request);
#pragma warning restore CS0612

ListEnvironments(ListEnvironmentsRequest, CallSettings)

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

Lists environments in a project.

Parameters
NameDescription
requestListEnvironmentsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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;

ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

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

Lists environments in a project.

Parameters
NameDescription
requestListEnvironmentsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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;

ListInstances(ListInstancesRequest, CallSettings)

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

Lists instances in a given project and location.

Parameters
NameDescription
requestListInstancesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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;

ListInstancesAsync(ListInstancesRequest, CallSettings)

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

Lists instances in a given project and location.

Parameters
NameDescription
requestListInstancesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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;

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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEnvironmentOperationMetadata

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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationInstanceOperationMetadata

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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceUpgradeInstance(string, CallSettings)

[Obsolete]
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceUpgradeInstanceAsync(string, CallSettings)

[Obsolete]
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceUpgradeInstanceInternal(string, CallSettings)

[Obsolete]
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceUpgradeInstanceInternalAsync(string, CallSettings)

[Obsolete]
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
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestRegisterInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestRegisterInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestRegisterInstanceRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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
NameDescription
requestReportInstanceInfoRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestReportInstanceInfoRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestReportInstanceInfoRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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
NameDescription
requestResetInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestResetInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestResetInstanceRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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;
}

SetInstanceAccelerator(SetInstanceAcceleratorRequest, CallSettings)

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

Updates the guest accelerators of a single Instance.

Parameters
NameDescription
requestSetInstanceAcceleratorRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestSetInstanceAcceleratorRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestSetInstanceAcceleratorRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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)

Updates the labels of an Instance.

Parameters
NameDescription
requestSetInstanceLabelsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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)

Updates the labels of an Instance.

Parameters
NameDescription
requestSetInstanceLabelsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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)

Updates the labels of an Instance.

Parameters
NameDescription
requestSetInstanceLabelsRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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
NameDescription
requestSetInstanceMachineTypeRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestSetInstanceMachineTypeRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestSetInstanceMachineTypeRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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
TypeDescription
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
NameDescription
requestStartInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestStartInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestStartInstanceRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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
NameDescription
requestStopInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestStopInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestStopInstanceRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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;
}

UpgradeInstance(UpgradeInstanceRequest, CallSettings)

[Obsolete]
public virtual Operation<Instance, OperationMetadata> UpgradeInstance(UpgradeInstanceRequest request, CallSettings callSettings = null)

Upgrades a notebook instance to the latest version. Deprecated. Please consider using v1.

Parameters
NameDescription
requestUpgradeInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationInstanceOperationMetadata

The RPC response.

Example
            // Create client
            gcnv::NotebookServiceClient notebookServiceClient = gcnv::NotebookServiceClient.Create();
            // Initialize request argument(s)
            gcnv::UpgradeInstanceRequest request = new gcnv::UpgradeInstanceRequest { Name = "", };
            // Make the request
#pragma warning disable CS0612
            Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.UpgradeInstance(request);
#pragma warning restore CS0612

            // 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
#pragma warning disable CS0612
            Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceUpgradeInstance(operationName);
#pragma warning restore CS0612
            // 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)

[Obsolete]
public virtual Task<Operation<Instance, OperationMetadata>> UpgradeInstanceAsync(UpgradeInstanceRequest request, CallSettings callSettings = null)

Upgrades a notebook instance to the latest version. Deprecated. Please consider using v1.

Parameters
NameDescription
requestUpgradeInstanceRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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 = "", };
            // Make the request
#pragma warning disable CS0612
            Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.UpgradeInstanceAsync(request);
#pragma warning restore CS0612

            // 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
#pragma warning disable CS0612
            Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceUpgradeInstanceAsync(operationName);
#pragma warning restore CS0612
            // 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)

[Obsolete]
public virtual Task<Operation<Instance, OperationMetadata>> UpgradeInstanceAsync(UpgradeInstanceRequest request, CancellationToken cancellationToken)

Upgrades a notebook instance to the latest version. Deprecated. Please consider using v1.

Parameters
NameDescription
requestUpgradeInstanceRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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 = "", };
            // Make the request
#pragma warning disable CS0612
            Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.UpgradeInstanceAsync(request);
#pragma warning restore CS0612

            // 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
#pragma warning disable CS0612
            Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceUpgradeInstanceAsync(operationName);
#pragma warning restore CS0612
            // 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)

[Obsolete]
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. Deprecated. Please consider using v1.

Parameters
NameDescription
requestUpgradeInstanceInternalRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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 = "", };
            // Make the request
#pragma warning disable CS0612
            Operation<gcnv::Instance, gcnv::OperationMetadata> response = notebookServiceClient.UpgradeInstanceInternal(request);
#pragma warning restore CS0612

            // 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
#pragma warning disable CS0612
            Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = notebookServiceClient.PollOnceUpgradeInstanceInternal(operationName);
#pragma warning restore CS0612
            // 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)

[Obsolete]
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. Deprecated. Please consider using v1.

Parameters
NameDescription
requestUpgradeInstanceInternalRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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 = "", };
            // Make the request
#pragma warning disable CS0612
            Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.UpgradeInstanceInternalAsync(request);
#pragma warning restore CS0612

            // 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
#pragma warning disable CS0612
            Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceUpgradeInstanceInternalAsync(operationName);
#pragma warning restore CS0612
            // 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)

[Obsolete]
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. Deprecated. Please consider using v1.

Parameters
NameDescription
requestUpgradeInstanceInternalRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
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 = "", };
            // Make the request
#pragma warning disable CS0612
            Operation<gcnv::Instance, gcnv::OperationMetadata> response = await notebookServiceClient.UpgradeInstanceInternalAsync(request);
#pragma warning restore CS0612

            // 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
#pragma warning disable CS0612
            Operation<gcnv::Instance, gcnv::OperationMetadata> retrievedResponse = await notebookServiceClient.PollOnceUpgradeInstanceInternalAsync(operationName);
#pragma warning restore CS0612
            // 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;
            }