Cloud Data Fusion v1 API - Class DataFusionClient (2.4.0)

public abstract class DataFusionClient

Reference documentation and code samples for the Cloud Data Fusion v1 API class DataFusionClient.

DataFusion client wrapper, for convenient use.

Inheritance

object > DataFusionClient

Derived Types

Namespace

Google.Cloud.DataFusion.V1

Assembly

Google.Cloud.DataFusion.V1.dll

Remarks

Service for creating and managing Data Fusion instances. Data Fusion enables ETL developers to build code-free, data integration pipelines via a point-and-click UI.

Properties

CreateInstanceOperationsClient

public virtual OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default DataFusion scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default DataFusion scopes are:

DeleteInstanceOperationsClient

public virtual OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual DataFusion.DataFusionClient GrpcClient { get; }

The underlying gRPC DataFusion client

Property Value
Type Description
DataFusionDataFusionClient

RestartInstanceOperationsClient

public virtual OperationsClient RestartInstanceOperationsClient { get; }

The long-running operations client for RestartInstance.

Property Value
Type Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

UpdateInstanceOperationsClient

public virtual OperationsClient UpdateInstanceOperationsClient { get; }

The long-running operations client for UpdateInstance.

Property Value
Type Description
OperationsClient

Methods

Create()

public static DataFusionClient Create()

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

Returns
Type Description
DataFusionClient

The created DataFusionClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskDataFusionClient

The task representing the created DataFusionClient.

CreateInstance(LocationName, Instance, string, CallSettings)

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

Creates a new Data Fusion instance in the specified project and location.

Parameters
Name Description
parent LocationName

Required. The instance's project and location in the format projects/{project}/locations/{location}.

instance Instance

An instance resource.

instanceId string

Required. The name of the instance to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = gcdv::DataFusionClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcdv::Instance instance = new gcdv::Instance();
string instanceId = "";
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = dataFusionClient.CreateInstance(parent, instance, instanceId);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = dataFusionClient.PollOnceCreateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

CreateInstance(CreateInstanceRequest, CallSettings)

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

Creates a new Data Fusion instance in the specified project and location.

Parameters
Name Description
request CreateInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = gcdv::DataFusionClient.Create();
// Initialize request argument(s)
gcdv::CreateInstanceRequest request = new gcdv::CreateInstanceRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    InstanceId = "",
    Instance = new gcdv::Instance(),
};
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = dataFusionClient.CreateInstance(request);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = dataFusionClient.PollOnceCreateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

CreateInstance(string, Instance, string, CallSettings)

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

Creates a new Data Fusion instance in the specified project and location.

Parameters
Name Description
parent string

Required. The instance's project and location in the format projects/{project}/locations/{location}.

instance Instance

An instance resource.

instanceId string

Required. The name of the instance to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = gcdv::DataFusionClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcdv::Instance instance = new gcdv::Instance();
string instanceId = "";
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = dataFusionClient.CreateInstance(parent, instance, instanceId);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = dataFusionClient.PollOnceCreateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(LocationName, Instance, string, CallSettings)

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

Creates a new Data Fusion instance in the specified project and location.

Parameters
Name Description
parent LocationName

Required. The instance's project and location in the format projects/{project}/locations/{location}.

instance Instance

An instance resource.

instanceId string

Required. The name of the instance to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcdv::Instance instance = new gcdv::Instance();
string instanceId = "";
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = await dataFusionClient.CreateInstanceAsync(parent, instance, instanceId);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(LocationName, Instance, string, CancellationToken)

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

Creates a new Data Fusion instance in the specified project and location.

Parameters
Name Description
parent LocationName

Required. The instance's project and location in the format projects/{project}/locations/{location}.

instance Instance

An instance resource.

instanceId string

Required. The name of the instance to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcdv::Instance instance = new gcdv::Instance();
string instanceId = "";
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = await dataFusionClient.CreateInstanceAsync(parent, instance, instanceId);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(CreateInstanceRequest, CallSettings)

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

Creates a new Data Fusion instance in the specified project and location.

Parameters
Name Description
request CreateInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::CreateInstanceRequest request = new gcdv::CreateInstanceRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    InstanceId = "",
    Instance = new gcdv::Instance(),
};
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = await dataFusionClient.CreateInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(CreateInstanceRequest, CancellationToken)

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

Creates a new Data Fusion instance in the specified project and location.

Parameters
Name Description
request CreateInstanceRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::CreateInstanceRequest request = new gcdv::CreateInstanceRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    InstanceId = "",
    Instance = new gcdv::Instance(),
};
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = await dataFusionClient.CreateInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(string, Instance, string, CallSettings)

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

Creates a new Data Fusion instance in the specified project and location.

Parameters
Name Description
parent string

Required. The instance's project and location in the format projects/{project}/locations/{location}.

instance Instance

An instance resource.

instanceId string

Required. The name of the instance to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcdv::Instance instance = new gcdv::Instance();
string instanceId = "";
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = await dataFusionClient.CreateInstanceAsync(parent, instance, instanceId);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

CreateInstanceAsync(string, Instance, string, CancellationToken)

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

Creates a new Data Fusion instance in the specified project and location.

Parameters
Name Description
parent string

Required. The instance's project and location in the format projects/{project}/locations/{location}.

instance Instance

An instance resource.

instanceId string

Required. The name of the instance to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcdv::Instance instance = new gcdv::Instance();
string instanceId = "";
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = await dataFusionClient.CreateInstanceAsync(parent, instance, instanceId);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.PollOnceCreateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

DeleteInstance(DeleteInstanceRequest, CallSettings)

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

Deletes a single Date Fusion instance.

Parameters
Name Description
request DeleteInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = gcdv::DataFusionClient.Create();
// Initialize request argument(s)
gcdv::DeleteInstanceRequest request = new gcdv::DeleteInstanceRequest
{
    InstanceName = gcdv::InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
};
// Make the request
Operation<Empty, gcdv::OperationMetadata> response = dataFusionClient.DeleteInstance(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcdv::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, gcdv::OperationMetadata> retrievedResponse = dataFusionClient.PollOnceDeleteInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInstance(InstanceName, CallSettings)

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

Deletes a single Date Fusion instance.

Parameters
Name Description
name InstanceName

Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = gcdv::DataFusionClient.Create();
// Initialize request argument(s)
gcdv::InstanceName name = gcdv::InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
Operation<Empty, gcdv::OperationMetadata> response = dataFusionClient.DeleteInstance(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcdv::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, gcdv::OperationMetadata> retrievedResponse = dataFusionClient.PollOnceDeleteInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInstance(string, CallSettings)

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

Deletes a single Date Fusion instance.

Parameters
Name Description
name string

Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = gcdv::DataFusionClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
Operation<Empty, gcdv::OperationMetadata> response = dataFusionClient.DeleteInstance(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcdv::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, gcdv::OperationMetadata> retrievedResponse = dataFusionClient.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 Date Fusion instance.

Parameters
Name Description
request DeleteInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::DeleteInstanceRequest request = new gcdv::DeleteInstanceRequest
{
    InstanceName = gcdv::InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
};
// Make the request
Operation<Empty, gcdv::OperationMetadata> response = await dataFusionClient.DeleteInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcdv::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, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.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 Date Fusion instance.

Parameters
Name Description
request DeleteInstanceRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::DeleteInstanceRequest request = new gcdv::DeleteInstanceRequest
{
    InstanceName = gcdv::InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
};
// Make the request
Operation<Empty, gcdv::OperationMetadata> response = await dataFusionClient.DeleteInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcdv::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, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.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(InstanceName, CallSettings)

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

Deletes a single Date Fusion instance.

Parameters
Name Description
name InstanceName

Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::InstanceName name = gcdv::InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
Operation<Empty, gcdv::OperationMetadata> response = await dataFusionClient.DeleteInstanceAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcdv::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, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.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(InstanceName, CancellationToken)

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

Deletes a single Date Fusion instance.

Parameters
Name Description
name InstanceName

Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::InstanceName name = gcdv::InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
Operation<Empty, gcdv::OperationMetadata> response = await dataFusionClient.DeleteInstanceAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcdv::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, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.PollOnceDeleteInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInstanceAsync(string, CallSettings)

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

Deletes a single Date Fusion instance.

Parameters
Name Description
name string

Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
Operation<Empty, gcdv::OperationMetadata> response = await dataFusionClient.DeleteInstanceAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcdv::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, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.PollOnceDeleteInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteInstanceAsync(string, CancellationToken)

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

Deletes a single Date Fusion instance.

Parameters
Name Description
name string

Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
Operation<Empty, gcdv::OperationMetadata> response = await dataFusionClient.DeleteInstanceAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcdv::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, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.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;
}

GetInstance(GetInstanceRequest, CallSettings)

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

Gets details of a single Data Fusion instance.

Parameters
Name Description
request GetInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Instance

The RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = gcdv::DataFusionClient.Create();
// Initialize request argument(s)
gcdv::GetInstanceRequest request = new gcdv::GetInstanceRequest
{
    InstanceName = gcdv::InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
};
// Make the request
gcdv::Instance response = dataFusionClient.GetInstance(request);

GetInstanceAsync(GetInstanceRequest, CallSettings)

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

Gets details of a single Data Fusion instance.

Parameters
Name Description
request GetInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskInstance

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::GetInstanceRequest request = new gcdv::GetInstanceRequest
{
    InstanceName = gcdv::InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
};
// Make the request
gcdv::Instance response = await dataFusionClient.GetInstanceAsync(request);

GetInstanceAsync(GetInstanceRequest, CancellationToken)

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

Gets details of a single Data Fusion instance.

Parameters
Name Description
request GetInstanceRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInstance

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::GetInstanceRequest request = new gcdv::GetInstanceRequest
{
    InstanceName = gcdv::InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
};
// Make the request
gcdv::Instance response = await dataFusionClient.GetInstanceAsync(request);

ListAvailableVersions(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListAvailableVersionsResponse, Version> ListAvailableVersions(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists possible versions for Data Fusion instances in the specified project and location.

Parameters
Name Description
parent LocationName

Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}.

pageToken string

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

pageSize int

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListAvailableVersionsResponseVersion

A pageable sequence of Version resources.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = gcdv::DataFusionClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<gcdv::ListAvailableVersionsResponse, gcdv::Version> response = dataFusionClient.ListAvailableVersions(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcdv::Version 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 (gcdv::ListAvailableVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdv::Version 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<gcdv::Version> 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 (gcdv::Version 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;

ListAvailableVersions(ListAvailableVersionsRequest, CallSettings)

public virtual PagedEnumerable<ListAvailableVersionsResponse, Version> ListAvailableVersions(ListAvailableVersionsRequest request, CallSettings callSettings = null)

Lists possible versions for Data Fusion instances in the specified project and location.

Parameters
Name Description
request ListAvailableVersionsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListAvailableVersionsResponseVersion

A pageable sequence of Version resources.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = gcdv::DataFusionClient.Create();
// Initialize request argument(s)
gcdv::ListAvailableVersionsRequest request = new gcdv::ListAvailableVersionsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    LatestPatchOnly = false,
};
// Make the request
PagedEnumerable<gcdv::ListAvailableVersionsResponse, gcdv::Version> response = dataFusionClient.ListAvailableVersions(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcdv::Version 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 (gcdv::ListAvailableVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdv::Version 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<gcdv::Version> 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 (gcdv::Version 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;

ListAvailableVersions(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListAvailableVersionsResponse, Version> ListAvailableVersions(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists possible versions for Data Fusion instances in the specified project and location.

Parameters
Name Description
parent string

Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}.

pageToken string

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

pageSize int

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListAvailableVersionsResponseVersion

A pageable sequence of Version resources.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = gcdv::DataFusionClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<gcdv::ListAvailableVersionsResponse, gcdv::Version> response = dataFusionClient.ListAvailableVersions(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcdv::Version 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 (gcdv::ListAvailableVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdv::Version 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<gcdv::Version> 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 (gcdv::Version 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;

ListAvailableVersionsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAvailableVersionsResponse, Version> ListAvailableVersionsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists possible versions for Data Fusion instances in the specified project and location.

Parameters
Name Description
parent LocationName

Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}.

pageToken string

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

pageSize int

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListAvailableVersionsResponseVersion

A pageable asynchronous sequence of Version resources.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<gcdv::ListAvailableVersionsResponse, gcdv::Version> response = dataFusionClient.ListAvailableVersionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcdv::Version 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((gcdv::ListAvailableVersionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdv::Version 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<gcdv::Version> 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 (gcdv::Version 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;

ListAvailableVersionsAsync(ListAvailableVersionsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListAvailableVersionsResponse, Version> ListAvailableVersionsAsync(ListAvailableVersionsRequest request, CallSettings callSettings = null)

Lists possible versions for Data Fusion instances in the specified project and location.

Parameters
Name Description
request ListAvailableVersionsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListAvailableVersionsResponseVersion

A pageable asynchronous sequence of Version resources.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::ListAvailableVersionsRequest request = new gcdv::ListAvailableVersionsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    LatestPatchOnly = false,
};
// Make the request
PagedAsyncEnumerable<gcdv::ListAvailableVersionsResponse, gcdv::Version> response = dataFusionClient.ListAvailableVersionsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcdv::Version 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((gcdv::ListAvailableVersionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdv::Version 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<gcdv::Version> 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 (gcdv::Version 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;

ListAvailableVersionsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAvailableVersionsResponse, Version> ListAvailableVersionsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists possible versions for Data Fusion instances in the specified project and location.

Parameters
Name Description
parent string

Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}.

pageToken string

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

pageSize int

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListAvailableVersionsResponseVersion

A pageable asynchronous sequence of Version resources.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<gcdv::ListAvailableVersionsResponse, gcdv::Version> response = dataFusionClient.ListAvailableVersionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcdv::Version 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((gcdv::ListAvailableVersionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdv::Version 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<gcdv::Version> 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 (gcdv::Version 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 Data Fusion instances in the specified project and location.

Parameters
Name Description
request ListInstancesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListInstancesResponseInstance

A pageable sequence of Instance resources.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = gcdv::DataFusionClient.Create();
// Initialize request argument(s)
gcdv::ListInstancesRequest request = new gcdv::ListInstancesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<gcdv::ListInstancesResponse, gcdv::Instance> response = dataFusionClient.ListInstances(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcdv::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 (gcdv::ListInstancesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdv::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<gcdv::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 (gcdv::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 Data Fusion instances in the specified project and location.

Parameters
Name Description
request ListInstancesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListInstancesResponseInstance

A pageable asynchronous sequence of Instance resources.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::ListInstancesRequest request = new gcdv::ListInstancesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<gcdv::ListInstancesResponse, gcdv::Instance> response = dataFusionClient.ListInstancesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcdv::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((gcdv::ListInstancesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcdv::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<gcdv::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 (gcdv::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;

PollOnceCreateInstance(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceCreateInstanceAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteInstance(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteInstanceAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A task representing the result of polling the operation.

PollOnceRestartInstance(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceRestartInstanceAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateInstance(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The result of polling the operation.

PollOnceUpdateInstanceAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A task representing the result of polling the operation.

RestartInstance(RestartInstanceRequest, CallSettings)

public virtual Operation<Instance, OperationMetadata> RestartInstance(RestartInstanceRequest request, CallSettings callSettings = null)

Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.

Parameters
Name Description
request RestartInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = gcdv::DataFusionClient.Create();
// Initialize request argument(s)
gcdv::RestartInstanceRequest request = new gcdv::RestartInstanceRequest
{
    InstanceName = gcdv::InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
};
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = dataFusionClient.RestartInstance(request);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = dataFusionClient.PollOnceRestartInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

RestartInstanceAsync(RestartInstanceRequest, CallSettings)

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

Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.

Parameters
Name Description
request RestartInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::RestartInstanceRequest request = new gcdv::RestartInstanceRequest
{
    InstanceName = gcdv::InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
};
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = await dataFusionClient.RestartInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.PollOnceRestartInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

RestartInstanceAsync(RestartInstanceRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> RestartInstanceAsync(RestartInstanceRequest request, CancellationToken cancellationToken)

Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.

Parameters
Name Description
request RestartInstanceRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::RestartInstanceRequest request = new gcdv::RestartInstanceRequest
{
    InstanceName = gcdv::InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
};
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = await dataFusionClient.RestartInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.PollOnceRestartInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateInstance(Instance, FieldMask, CallSettings)

public virtual Operation<Instance, OperationMetadata> UpdateInstance(Instance instance, FieldMask updateMask, CallSettings callSettings = null)

Updates a single Data Fusion instance.

Parameters
Name Description
instance Instance

Required. The instance resource that replaces the resource on the server. Currently, Data Fusion only allows replacing labels, options, and stack driver settings. All other fields will be ignored.

updateMask FieldMask

Field mask is used to specify the fields that the update will overwrite in an instance resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, all the supported fields (labels, options, and version currently) will be overwritten.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = gcdv::DataFusionClient.Create();
// Initialize request argument(s)
gcdv::Instance instance = new gcdv::Instance();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = dataFusionClient.UpdateInstance(instance, updateMask);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = dataFusionClient.PollOnceUpdateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

UpdateInstance(UpdateInstanceRequest, CallSettings)

public virtual Operation<Instance, OperationMetadata> UpdateInstance(UpdateInstanceRequest request, CallSettings callSettings = null)

Updates a single Data Fusion instance.

Parameters
Name Description
request UpdateInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = gcdv::DataFusionClient.Create();
// Initialize request argument(s)
gcdv::UpdateInstanceRequest request = new gcdv::UpdateInstanceRequest
{
    Instance = new gcdv::Instance(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = dataFusionClient.UpdateInstance(request);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = dataFusionClient.PollOnceUpdateInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

UpdateInstanceAsync(Instance, FieldMask, CallSettings)

public virtual Task<Operation<Instance, OperationMetadata>> UpdateInstanceAsync(Instance instance, FieldMask updateMask, CallSettings callSettings = null)

Updates a single Data Fusion instance.

Parameters
Name Description
instance Instance

Required. The instance resource that replaces the resource on the server. Currently, Data Fusion only allows replacing labels, options, and stack driver settings. All other fields will be ignored.

updateMask FieldMask

Field mask is used to specify the fields that the update will overwrite in an instance resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, all the supported fields (labels, options, and version currently) will be overwritten.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::Instance instance = new gcdv::Instance();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = await dataFusionClient.UpdateInstanceAsync(instance, updateMask);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.PollOnceUpdateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

UpdateInstanceAsync(Instance, FieldMask, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> UpdateInstanceAsync(Instance instance, FieldMask updateMask, CancellationToken cancellationToken)

Updates a single Data Fusion instance.

Parameters
Name Description
instance Instance

Required. The instance resource that replaces the resource on the server. Currently, Data Fusion only allows replacing labels, options, and stack driver settings. All other fields will be ignored.

updateMask FieldMask

Field mask is used to specify the fields that the update will overwrite in an instance resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, all the supported fields (labels, options, and version currently) will be overwritten.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::Instance instance = new gcdv::Instance();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = await dataFusionClient.UpdateInstanceAsync(instance, updateMask);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.PollOnceUpdateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)

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

Updates a single Data Fusion instance.

Parameters
Name Description
request UpdateInstanceRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::UpdateInstanceRequest request = new gcdv::UpdateInstanceRequest
{
    Instance = new gcdv::Instance(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = await dataFusionClient.UpdateInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.PollOnceUpdateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}

UpdateInstanceAsync(UpdateInstanceRequest, CancellationToken)

public virtual Task<Operation<Instance, OperationMetadata>> UpdateInstanceAsync(UpdateInstanceRequest request, CancellationToken cancellationToken)

Updates a single Data Fusion instance.

Parameters
Name Description
request UpdateInstanceRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.

Example
// Create client
gcdv::DataFusionClient dataFusionClient = await gcdv::DataFusionClient.CreateAsync();
// Initialize request argument(s)
gcdv::UpdateInstanceRequest request = new gcdv::UpdateInstanceRequest
{
    Instance = new gcdv::Instance(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<gcdv::Instance, gcdv::OperationMetadata> response = await dataFusionClient.UpdateInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcdv::Instance, gcdv::OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcdv::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<gcdv::Instance, gcdv::OperationMetadata> retrievedResponse = await dataFusionClient.PollOnceUpdateInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcdv::Instance retrievedResult = retrievedResponse.Result;
}