Data Analytics API with Gemini v1beta API - Class DataAgentServiceClient (1.0.0-beta01)

public abstract class DataAgentServiceClient

Reference documentation and code samples for the Data Analytics API with Gemini v1beta API class DataAgentServiceClient.

DataAgentService client wrapper, for convenient use.

Inheritance

object > DataAgentServiceClient

Namespace

Google.Cloud.GeminiDataAnalytics.V1Beta

Assembly

Google.Cloud.GeminiDataAnalytics.V1Beta.dll

Remarks

Service describing handlers for resources.

Properties

CreateDataAgentOperationsClient

public virtual OperationsClient CreateDataAgentOperationsClient { get; }

The long-running operations client for CreateDataAgent.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default DataAgentService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default DataAgentService scopes are:

DeleteDataAgentOperationsClient

public virtual OperationsClient DeleteDataAgentOperationsClient { get; }

The long-running operations client for DeleteDataAgent.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual DataAgentService.DataAgentServiceClient GrpcClient { get; }

The underlying gRPC DataAgentService client

Property Value
Type Description
DataAgentServiceDataAgentServiceClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

UpdateDataAgentOperationsClient

public virtual OperationsClient UpdateDataAgentOperationsClient { get; }

The long-running operations client for UpdateDataAgent.

Property Value
Type Description
OperationsClient

Methods

Create()

public static DataAgentServiceClient Create()

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

Returns
Type Description
DataAgentServiceClient

The created DataAgentServiceClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskDataAgentServiceClient

The task representing the created DataAgentServiceClient.

CreateDataAgent(LocationName, DataAgent, string, CallSettings)

public virtual Operation<DataAgent, OperationMetadata> CreateDataAgent(LocationName parent, DataAgent dataAgent, string dataAgentId, CallSettings callSettings = null)

Creates a new DataAgent in a given project and location.

Parameters
Name Description
parent LocationName

Required. Value for parent.

dataAgent DataAgent

Required. The resource being created.

dataAgentId string

Optional. Id of the requesting object. Must be unique within the parent. The allowed format is: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDataAgentOperationMetadata

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
DataAgent dataAgent = new DataAgent();
string dataAgentId = "";
// Make the request
Operation<DataAgent, OperationMetadata> response = dataAgentServiceClient.CreateDataAgent(parent, dataAgent, dataAgentId);

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

CreateDataAgent(CreateDataAgentRequest, CallSettings)

public virtual Operation<DataAgent, OperationMetadata> CreateDataAgent(CreateDataAgentRequest request, CallSettings callSettings = null)

Creates a new DataAgent in a given project and location.

Parameters
Name Description
request CreateDataAgentRequest

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
OperationDataAgentOperationMetadata

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
CreateDataAgentRequest request = new CreateDataAgentRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    DataAgentId = "",
    DataAgent = new DataAgent(),
    RequestId = "",
};
// Make the request
Operation<DataAgent, OperationMetadata> response = dataAgentServiceClient.CreateDataAgent(request);

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

CreateDataAgent(string, DataAgent, string, CallSettings)

public virtual Operation<DataAgent, OperationMetadata> CreateDataAgent(string parent, DataAgent dataAgent, string dataAgentId, CallSettings callSettings = null)

Creates a new DataAgent in a given project and location.

Parameters
Name Description
parent string

Required. Value for parent.

dataAgent DataAgent

Required. The resource being created.

dataAgentId string

Optional. Id of the requesting object. Must be unique within the parent. The allowed format is: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDataAgentOperationMetadata

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
DataAgent dataAgent = new DataAgent();
string dataAgentId = "";
// Make the request
Operation<DataAgent, OperationMetadata> response = dataAgentServiceClient.CreateDataAgent(parent, dataAgent, dataAgentId);

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

CreateDataAgentAsync(LocationName, DataAgent, string, CallSettings)

public virtual Task<Operation<DataAgent, OperationMetadata>> CreateDataAgentAsync(LocationName parent, DataAgent dataAgent, string dataAgentId, CallSettings callSettings = null)

Creates a new DataAgent in a given project and location.

Parameters
Name Description
parent LocationName

Required. Value for parent.

dataAgent DataAgent

Required. The resource being created.

dataAgentId string

Optional. Id of the requesting object. Must be unique within the parent. The allowed format is: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDataAgentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
DataAgent dataAgent = new DataAgent();
string dataAgentId = "";
// Make the request
Operation<DataAgent, OperationMetadata> response = await dataAgentServiceClient.CreateDataAgentAsync(parent, dataAgent, dataAgentId);

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

CreateDataAgentAsync(LocationName, DataAgent, string, CancellationToken)

public virtual Task<Operation<DataAgent, OperationMetadata>> CreateDataAgentAsync(LocationName parent, DataAgent dataAgent, string dataAgentId, CancellationToken cancellationToken)

Creates a new DataAgent in a given project and location.

Parameters
Name Description
parent LocationName

Required. Value for parent.

dataAgent DataAgent

Required. The resource being created.

dataAgentId string

Optional. Id of the requesting object. Must be unique within the parent. The allowed format is: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDataAgentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
DataAgent dataAgent = new DataAgent();
string dataAgentId = "";
// Make the request
Operation<DataAgent, OperationMetadata> response = await dataAgentServiceClient.CreateDataAgentAsync(parent, dataAgent, dataAgentId);

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

CreateDataAgentAsync(CreateDataAgentRequest, CallSettings)

public virtual Task<Operation<DataAgent, OperationMetadata>> CreateDataAgentAsync(CreateDataAgentRequest request, CallSettings callSettings = null)

Creates a new DataAgent in a given project and location.

Parameters
Name Description
request CreateDataAgentRequest

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
TaskOperationDataAgentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDataAgentRequest request = new CreateDataAgentRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    DataAgentId = "",
    DataAgent = new DataAgent(),
    RequestId = "",
};
// Make the request
Operation<DataAgent, OperationMetadata> response = await dataAgentServiceClient.CreateDataAgentAsync(request);

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

CreateDataAgentAsync(CreateDataAgentRequest, CancellationToken)

public virtual Task<Operation<DataAgent, OperationMetadata>> CreateDataAgentAsync(CreateDataAgentRequest request, CancellationToken cancellationToken)

Creates a new DataAgent in a given project and location.

Parameters
Name Description
request CreateDataAgentRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDataAgentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDataAgentRequest request = new CreateDataAgentRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    DataAgentId = "",
    DataAgent = new DataAgent(),
    RequestId = "",
};
// Make the request
Operation<DataAgent, OperationMetadata> response = await dataAgentServiceClient.CreateDataAgentAsync(request);

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

CreateDataAgentAsync(string, DataAgent, string, CallSettings)

public virtual Task<Operation<DataAgent, OperationMetadata>> CreateDataAgentAsync(string parent, DataAgent dataAgent, string dataAgentId, CallSettings callSettings = null)

Creates a new DataAgent in a given project and location.

Parameters
Name Description
parent string

Required. Value for parent.

dataAgent DataAgent

Required. The resource being created.

dataAgentId string

Optional. Id of the requesting object. Must be unique within the parent. The allowed format is: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDataAgentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
DataAgent dataAgent = new DataAgent();
string dataAgentId = "";
// Make the request
Operation<DataAgent, OperationMetadata> response = await dataAgentServiceClient.CreateDataAgentAsync(parent, dataAgent, dataAgentId);

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

CreateDataAgentAsync(string, DataAgent, string, CancellationToken)

public virtual Task<Operation<DataAgent, OperationMetadata>> CreateDataAgentAsync(string parent, DataAgent dataAgent, string dataAgentId, CancellationToken cancellationToken)

Creates a new DataAgent in a given project and location.

Parameters
Name Description
parent string

Required. Value for parent.

dataAgent DataAgent

Required. The resource being created.

dataAgentId string

Optional. Id of the requesting object. Must be unique within the parent. The allowed format is: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDataAgentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
DataAgent dataAgent = new DataAgent();
string dataAgentId = "";
// Make the request
Operation<DataAgent, OperationMetadata> response = await dataAgentServiceClient.CreateDataAgentAsync(parent, dataAgent, dataAgentId);

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

DeleteDataAgent(DataAgentName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteDataAgent(DataAgentName name, CallSettings callSettings = null)

Deletes a single DataAgent.

Parameters
Name Description
name DataAgentName

Required. Name of the resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
DataAgentName name = DataAgentName.FromProjectLocationDataAgent("[PROJECT]", "[LOCATION]", "[DATA_AGENT]");
// Make the request
Operation<Empty, OperationMetadata> response = dataAgentServiceClient.DeleteDataAgent(name);

// Poll until the returned long-running operation is complete
Operation<Empty, 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, OperationMetadata> retrievedResponse = dataAgentServiceClient.PollOnceDeleteDataAgent(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;
}

DeleteDataAgent(DeleteDataAgentRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteDataAgent(DeleteDataAgentRequest request, CallSettings callSettings = null)

Deletes a single DataAgent.

Parameters
Name Description
request DeleteDataAgentRequest

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
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
DeleteDataAgentRequest request = new DeleteDataAgentRequest
{
    DataAgentName = DataAgentName.FromProjectLocationDataAgent("[PROJECT]", "[LOCATION]", "[DATA_AGENT]"),
    RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = dataAgentServiceClient.DeleteDataAgent(request);

// Poll until the returned long-running operation is complete
Operation<Empty, 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, OperationMetadata> retrievedResponse = dataAgentServiceClient.PollOnceDeleteDataAgent(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;
}

DeleteDataAgent(string, CallSettings)

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

Deletes a single DataAgent.

Parameters
Name Description
name string

Required. Name of the resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/dataAgents/[DATA_AGENT]";
// Make the request
Operation<Empty, OperationMetadata> response = dataAgentServiceClient.DeleteDataAgent(name);

// Poll until the returned long-running operation is complete
Operation<Empty, 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, OperationMetadata> retrievedResponse = dataAgentServiceClient.PollOnceDeleteDataAgent(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;
}

DeleteDataAgentAsync(DataAgentName, CallSettings)

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

Deletes a single DataAgent.

Parameters
Name Description
name DataAgentName

Required. Name of the resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
DataAgentName name = DataAgentName.FromProjectLocationDataAgent("[PROJECT]", "[LOCATION]", "[DATA_AGENT]");
// Make the request
Operation<Empty, OperationMetadata> response = await dataAgentServiceClient.DeleteDataAgentAsync(name);

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

DeleteDataAgentAsync(DataAgentName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteDataAgentAsync(DataAgentName name, CancellationToken cancellationToken)

Deletes a single DataAgent.

Parameters
Name Description
name DataAgentName

Required. Name of the resource.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
DataAgentName name = DataAgentName.FromProjectLocationDataAgent("[PROJECT]", "[LOCATION]", "[DATA_AGENT]");
// Make the request
Operation<Empty, OperationMetadata> response = await dataAgentServiceClient.DeleteDataAgentAsync(name);

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

DeleteDataAgentAsync(DeleteDataAgentRequest, CallSettings)

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

Deletes a single DataAgent.

Parameters
Name Description
request DeleteDataAgentRequest

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
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteDataAgentRequest request = new DeleteDataAgentRequest
{
    DataAgentName = DataAgentName.FromProjectLocationDataAgent("[PROJECT]", "[LOCATION]", "[DATA_AGENT]"),
    RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await dataAgentServiceClient.DeleteDataAgentAsync(request);

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

DeleteDataAgentAsync(DeleteDataAgentRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteDataAgentAsync(DeleteDataAgentRequest request, CancellationToken cancellationToken)

Deletes a single DataAgent.

Parameters
Name Description
request DeleteDataAgentRequest

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
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteDataAgentRequest request = new DeleteDataAgentRequest
{
    DataAgentName = DataAgentName.FromProjectLocationDataAgent("[PROJECT]", "[LOCATION]", "[DATA_AGENT]"),
    RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await dataAgentServiceClient.DeleteDataAgentAsync(request);

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

DeleteDataAgentAsync(string, CallSettings)

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

Deletes a single DataAgent.

Parameters
Name Description
name string

Required. Name of the resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/dataAgents/[DATA_AGENT]";
// Make the request
Operation<Empty, OperationMetadata> response = await dataAgentServiceClient.DeleteDataAgentAsync(name);

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

DeleteDataAgentAsync(string, CancellationToken)

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

Deletes a single DataAgent.

Parameters
Name Description
name string

Required. Name of the resource.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/dataAgents/[DATA_AGENT]";
// Make the request
Operation<Empty, OperationMetadata> response = await dataAgentServiceClient.DeleteDataAgentAsync(name);

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

GetDataAgent(DataAgentName, CallSettings)

public virtual DataAgent GetDataAgent(DataAgentName name, CallSettings callSettings = null)

Gets details of a single DataAgent.

Parameters
Name Description
name DataAgentName

Required. Name of the resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataAgent

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
DataAgentName name = DataAgentName.FromProjectLocationDataAgent("[PROJECT]", "[LOCATION]", "[DATA_AGENT]");
// Make the request
DataAgent response = dataAgentServiceClient.GetDataAgent(name);

GetDataAgent(GetDataAgentRequest, CallSettings)

public virtual DataAgent GetDataAgent(GetDataAgentRequest request, CallSettings callSettings = null)

Gets details of a single DataAgent.

Parameters
Name Description
request GetDataAgentRequest

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
DataAgent

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
GetDataAgentRequest request = new GetDataAgentRequest
{
    DataAgentName = DataAgentName.FromProjectLocationDataAgent("[PROJECT]", "[LOCATION]", "[DATA_AGENT]"),
};
// Make the request
DataAgent response = dataAgentServiceClient.GetDataAgent(request);

GetDataAgent(string, CallSettings)

public virtual DataAgent GetDataAgent(string name, CallSettings callSettings = null)

Gets details of a single DataAgent.

Parameters
Name Description
name string

Required. Name of the resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataAgent

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/dataAgents/[DATA_AGENT]";
// Make the request
DataAgent response = dataAgentServiceClient.GetDataAgent(name);

GetDataAgentAsync(DataAgentName, CallSettings)

public virtual Task<DataAgent> GetDataAgentAsync(DataAgentName name, CallSettings callSettings = null)

Gets details of a single DataAgent.

Parameters
Name Description
name DataAgentName

Required. Name of the resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataAgent

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
DataAgentName name = DataAgentName.FromProjectLocationDataAgent("[PROJECT]", "[LOCATION]", "[DATA_AGENT]");
// Make the request
DataAgent response = await dataAgentServiceClient.GetDataAgentAsync(name);

GetDataAgentAsync(DataAgentName, CancellationToken)

public virtual Task<DataAgent> GetDataAgentAsync(DataAgentName name, CancellationToken cancellationToken)

Gets details of a single DataAgent.

Parameters
Name Description
name DataAgentName

Required. Name of the resource.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAgent

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
DataAgentName name = DataAgentName.FromProjectLocationDataAgent("[PROJECT]", "[LOCATION]", "[DATA_AGENT]");
// Make the request
DataAgent response = await dataAgentServiceClient.GetDataAgentAsync(name);

GetDataAgentAsync(GetDataAgentRequest, CallSettings)

public virtual Task<DataAgent> GetDataAgentAsync(GetDataAgentRequest request, CallSettings callSettings = null)

Gets details of a single DataAgent.

Parameters
Name Description
request GetDataAgentRequest

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
TaskDataAgent

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
GetDataAgentRequest request = new GetDataAgentRequest
{
    DataAgentName = DataAgentName.FromProjectLocationDataAgent("[PROJECT]", "[LOCATION]", "[DATA_AGENT]"),
};
// Make the request
DataAgent response = await dataAgentServiceClient.GetDataAgentAsync(request);

GetDataAgentAsync(GetDataAgentRequest, CancellationToken)

public virtual Task<DataAgent> GetDataAgentAsync(GetDataAgentRequest request, CancellationToken cancellationToken)

Gets details of a single DataAgent.

Parameters
Name Description
request GetDataAgentRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAgent

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
GetDataAgentRequest request = new GetDataAgentRequest
{
    DataAgentName = DataAgentName.FromProjectLocationDataAgent("[PROJECT]", "[LOCATION]", "[DATA_AGENT]"),
};
// Make the request
DataAgent response = await dataAgentServiceClient.GetDataAgentAsync(request);

GetDataAgentAsync(string, CallSettings)

public virtual Task<DataAgent> GetDataAgentAsync(string name, CallSettings callSettings = null)

Gets details of a single DataAgent.

Parameters
Name Description
name string

Required. Name of the resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataAgent

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/dataAgents/[DATA_AGENT]";
// Make the request
DataAgent response = await dataAgentServiceClient.GetDataAgentAsync(name);

GetDataAgentAsync(string, CancellationToken)

public virtual Task<DataAgent> GetDataAgentAsync(string name, CancellationToken cancellationToken)

Gets details of a single DataAgent.

Parameters
Name Description
name string

Required. Name of the resource.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAgent

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/dataAgents/[DATA_AGENT]";
// Make the request
DataAgent response = await dataAgentServiceClient.GetDataAgentAsync(name);

GetIamPolicy(IResourceName, CallSettings)

public virtual Policy GetIamPolicy(IResourceName resource, CallSettings callSettings = null)

Gets the IAM policy for DataAgent

Parameters
Name Description
resource IResourceName

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Policy response = dataAgentServiceClient.GetIamPolicy(resource);

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the IAM policy for DataAgent

Parameters
Name Description
request GetIamPolicyRequest

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
Policy

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Options = new GetPolicyOptions(),
};
// Make the request
Policy response = dataAgentServiceClient.GetIamPolicy(request);

GetIamPolicy(string, CallSettings)

public virtual Policy GetIamPolicy(string resource, CallSettings callSettings = null)

Gets the IAM policy for DataAgent

Parameters
Name Description
resource string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = dataAgentServiceClient.GetIamPolicy(resource);

GetIamPolicyAsync(IResourceName, CallSettings)

public virtual Task<Policy> GetIamPolicyAsync(IResourceName resource, CallSettings callSettings = null)

Gets the IAM policy for DataAgent

Parameters
Name Description
resource IResourceName

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Policy response = await dataAgentServiceClient.GetIamPolicyAsync(resource);

GetIamPolicyAsync(IResourceName, CancellationToken)

public virtual Task<Policy> GetIamPolicyAsync(IResourceName resource, CancellationToken cancellationToken)

Gets the IAM policy for DataAgent

Parameters
Name Description
resource IResourceName

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Policy response = await dataAgentServiceClient.GetIamPolicyAsync(resource);

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public virtual Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the IAM policy for DataAgent

Parameters
Name Description
request GetIamPolicyRequest

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
TaskPolicy

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Options = new GetPolicyOptions(),
};
// Make the request
Policy response = await dataAgentServiceClient.GetIamPolicyAsync(request);

GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

public virtual Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CancellationToken cancellationToken)

Gets the IAM policy for DataAgent

Parameters
Name Description
request GetIamPolicyRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Options = new GetPolicyOptions(),
};
// Make the request
Policy response = await dataAgentServiceClient.GetIamPolicyAsync(request);

GetIamPolicyAsync(string, CallSettings)

public virtual Task<Policy> GetIamPolicyAsync(string resource, CallSettings callSettings = null)

Gets the IAM policy for DataAgent

Parameters
Name Description
resource string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = await dataAgentServiceClient.GetIamPolicyAsync(resource);

GetIamPolicyAsync(string, CancellationToken)

public virtual Task<Policy> GetIamPolicyAsync(string resource, CancellationToken cancellationToken)

Gets the IAM policy for DataAgent

Parameters
Name Description
resource string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = await dataAgentServiceClient.GetIamPolicyAsync(resource);

ListAccessibleDataAgents(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListAccessibleDataAgentsResponse, DataAgent> ListAccessibleDataAgents(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DataAgents that are accessible to the caller in a given project and location.

Parameters
Name Description
parent LocationName

Required. Parent value for ListAccessibleDataAgentsRequest.

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
PagedEnumerableListAccessibleDataAgentsResponseDataAgent

A pageable sequence of DataAgent resources.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListAccessibleDataAgentsResponse, DataAgent> response = dataAgentServiceClient.ListAccessibleDataAgents(parent);

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

ListAccessibleDataAgents(ListAccessibleDataAgentsRequest, CallSettings)

public virtual PagedEnumerable<ListAccessibleDataAgentsResponse, DataAgent> ListAccessibleDataAgents(ListAccessibleDataAgentsRequest request, CallSettings callSettings = null)

Lists DataAgents that are accessible to the caller in a given project and location.

Parameters
Name Description
request ListAccessibleDataAgentsRequest

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
PagedEnumerableListAccessibleDataAgentsResponseDataAgent

A pageable sequence of DataAgent resources.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
ListAccessibleDataAgentsRequest request = new ListAccessibleDataAgentsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
    ShowDeleted = false,
    CreatorFilter = ListAccessibleDataAgentsRequest.Types.CreatorFilter.Unspecified,
};
// Make the request
PagedEnumerable<ListAccessibleDataAgentsResponse, DataAgent> response = dataAgentServiceClient.ListAccessibleDataAgents(request);

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

ListAccessibleDataAgents(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListAccessibleDataAgentsResponse, DataAgent> ListAccessibleDataAgents(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DataAgents that are accessible to the caller in a given project and location.

Parameters
Name Description
parent string

Required. Parent value for ListAccessibleDataAgentsRequest.

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
PagedEnumerableListAccessibleDataAgentsResponseDataAgent

A pageable sequence of DataAgent resources.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListAccessibleDataAgentsResponse, DataAgent> response = dataAgentServiceClient.ListAccessibleDataAgents(parent);

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

ListAccessibleDataAgentsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAccessibleDataAgentsResponse, DataAgent> ListAccessibleDataAgentsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DataAgents that are accessible to the caller in a given project and location.

Parameters
Name Description
parent LocationName

Required. Parent value for ListAccessibleDataAgentsRequest.

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
PagedAsyncEnumerableListAccessibleDataAgentsResponseDataAgent

A pageable asynchronous sequence of DataAgent resources.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListAccessibleDataAgentsResponse, DataAgent> response = dataAgentServiceClient.ListAccessibleDataAgentsAsync(parent);

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

ListAccessibleDataAgentsAsync(ListAccessibleDataAgentsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListAccessibleDataAgentsResponse, DataAgent> ListAccessibleDataAgentsAsync(ListAccessibleDataAgentsRequest request, CallSettings callSettings = null)

Lists DataAgents that are accessible to the caller in a given project and location.

Parameters
Name Description
request ListAccessibleDataAgentsRequest

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
PagedAsyncEnumerableListAccessibleDataAgentsResponseDataAgent

A pageable asynchronous sequence of DataAgent resources.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
ListAccessibleDataAgentsRequest request = new ListAccessibleDataAgentsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
    ShowDeleted = false,
    CreatorFilter = ListAccessibleDataAgentsRequest.Types.CreatorFilter.Unspecified,
};
// Make the request
PagedAsyncEnumerable<ListAccessibleDataAgentsResponse, DataAgent> response = dataAgentServiceClient.ListAccessibleDataAgentsAsync(request);

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

ListAccessibleDataAgentsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAccessibleDataAgentsResponse, DataAgent> ListAccessibleDataAgentsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DataAgents that are accessible to the caller in a given project and location.

Parameters
Name Description
parent string

Required. Parent value for ListAccessibleDataAgentsRequest.

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
PagedAsyncEnumerableListAccessibleDataAgentsResponseDataAgent

A pageable asynchronous sequence of DataAgent resources.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListAccessibleDataAgentsResponse, DataAgent> response = dataAgentServiceClient.ListAccessibleDataAgentsAsync(parent);

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

ListDataAgents(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListDataAgentsResponse, DataAgent> ListDataAgents(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DataAgents in a given project and location.

Parameters
Name Description
parent LocationName

Required. Parent value for ListDataAgentsRequest.

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
PagedEnumerableListDataAgentsResponseDataAgent

A pageable sequence of DataAgent resources.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListDataAgentsResponse, DataAgent> response = dataAgentServiceClient.ListDataAgents(parent);

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

ListDataAgents(ListDataAgentsRequest, CallSettings)

public virtual PagedEnumerable<ListDataAgentsResponse, DataAgent> ListDataAgents(ListDataAgentsRequest request, CallSettings callSettings = null)

Lists DataAgents in a given project and location.

Parameters
Name Description
request ListDataAgentsRequest

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
PagedEnumerableListDataAgentsResponseDataAgent

A pageable sequence of DataAgent resources.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
ListDataAgentsRequest request = new ListDataAgentsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
    ShowDeleted = false,
};
// Make the request
PagedEnumerable<ListDataAgentsResponse, DataAgent> response = dataAgentServiceClient.ListDataAgents(request);

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

ListDataAgents(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListDataAgentsResponse, DataAgent> ListDataAgents(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DataAgents in a given project and location.

Parameters
Name Description
parent string

Required. Parent value for ListDataAgentsRequest.

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
PagedEnumerableListDataAgentsResponseDataAgent

A pageable sequence of DataAgent resources.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListDataAgentsResponse, DataAgent> response = dataAgentServiceClient.ListDataAgents(parent);

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

ListDataAgentsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDataAgentsResponse, DataAgent> ListDataAgentsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DataAgents in a given project and location.

Parameters
Name Description
parent LocationName

Required. Parent value for ListDataAgentsRequest.

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
PagedAsyncEnumerableListDataAgentsResponseDataAgent

A pageable asynchronous sequence of DataAgent resources.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListDataAgentsResponse, DataAgent> response = dataAgentServiceClient.ListDataAgentsAsync(parent);

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

ListDataAgentsAsync(ListDataAgentsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListDataAgentsResponse, DataAgent> ListDataAgentsAsync(ListDataAgentsRequest request, CallSettings callSettings = null)

Lists DataAgents in a given project and location.

Parameters
Name Description
request ListDataAgentsRequest

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
PagedAsyncEnumerableListDataAgentsResponseDataAgent

A pageable asynchronous sequence of DataAgent resources.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
ListDataAgentsRequest request = new ListDataAgentsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
    ShowDeleted = false,
};
// Make the request
PagedAsyncEnumerable<ListDataAgentsResponse, DataAgent> response = dataAgentServiceClient.ListDataAgentsAsync(request);

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

ListDataAgentsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDataAgentsResponse, DataAgent> ListDataAgentsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DataAgents in a given project and location.

Parameters
Name Description
parent string

Required. Parent value for ListDataAgentsRequest.

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
PagedAsyncEnumerableListDataAgentsResponseDataAgent

A pageable asynchronous sequence of DataAgent resources.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListDataAgentsResponse, DataAgent> response = dataAgentServiceClient.ListDataAgentsAsync(parent);

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

PollOnceCreateDataAgent(string, CallSettings)

public virtual Operation<DataAgent, OperationMetadata> PollOnceCreateDataAgent(string operationName, CallSettings callSettings = null)

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

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
OperationDataAgentOperationMetadata

The result of polling the operation.

PollOnceCreateDataAgentAsync(string, CallSettings)

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

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

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
TaskOperationDataAgentOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteDataAgent(string, CallSettings)

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

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

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.

PollOnceDeleteDataAgentAsync(string, CallSettings)

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

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

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.

PollOnceUpdateDataAgent(string, CallSettings)

public virtual Operation<DataAgent, OperationMetadata> PollOnceUpdateDataAgent(string operationName, CallSettings callSettings = null)

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

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
OperationDataAgentOperationMetadata

The result of polling the operation.

PollOnceUpdateDataAgentAsync(string, CallSettings)

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

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

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
TaskOperationDataAgentOperationMetadata

A task representing the result of polling the operation.

SetIamPolicy(IResourceName, CallSettings)

public virtual Policy SetIamPolicy(IResourceName resource, CallSettings callSettings = null)

Sets the IAM policy for a DataAgent.

Parameters
Name Description
resource IResourceName

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Policy response = dataAgentServiceClient.SetIamPolicy(resource);

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the IAM policy for a DataAgent.

Parameters
Name Description
request SetIamPolicyRequest

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
Policy

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Policy = new Policy(),
    UpdateMask = new FieldMask(),
};
// Make the request
Policy response = dataAgentServiceClient.SetIamPolicy(request);

SetIamPolicy(string, CallSettings)

public virtual Policy SetIamPolicy(string resource, CallSettings callSettings = null)

Sets the IAM policy for a DataAgent.

Parameters
Name Description
resource string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = dataAgentServiceClient.SetIamPolicy(resource);

SetIamPolicyAsync(IResourceName, CallSettings)

public virtual Task<Policy> SetIamPolicyAsync(IResourceName resource, CallSettings callSettings = null)

Sets the IAM policy for a DataAgent.

Parameters
Name Description
resource IResourceName

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Policy response = await dataAgentServiceClient.SetIamPolicyAsync(resource);

SetIamPolicyAsync(IResourceName, CancellationToken)

public virtual Task<Policy> SetIamPolicyAsync(IResourceName resource, CancellationToken cancellationToken)

Sets the IAM policy for a DataAgent.

Parameters
Name Description
resource IResourceName

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName resource = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Policy response = await dataAgentServiceClient.SetIamPolicyAsync(resource);

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the IAM policy for a DataAgent.

Parameters
Name Description
request SetIamPolicyRequest

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
TaskPolicy

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Policy = new Policy(),
    UpdateMask = new FieldMask(),
};
// Make the request
Policy response = await dataAgentServiceClient.SetIamPolicyAsync(request);

SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)

public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CancellationToken cancellationToken)

Sets the IAM policy for a DataAgent.

Parameters
Name Description
request SetIamPolicyRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Policy = new Policy(),
    UpdateMask = new FieldMask(),
};
// Make the request
Policy response = await dataAgentServiceClient.SetIamPolicyAsync(request);

SetIamPolicyAsync(string, CallSettings)

public virtual Task<Policy> SetIamPolicyAsync(string resource, CallSettings callSettings = null)

Sets the IAM policy for a DataAgent.

Parameters
Name Description
resource string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = await dataAgentServiceClient.SetIamPolicyAsync(resource);

SetIamPolicyAsync(string, CancellationToken)

public virtual Task<Policy> SetIamPolicyAsync(string resource, CancellationToken cancellationToken)

Sets the IAM policy for a DataAgent.

Parameters
Name Description
resource string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
string resource = "a/wildcard/resource";
// Make the request
Policy response = await dataAgentServiceClient.SetIamPolicyAsync(resource);

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.

UpdateDataAgent(DataAgent, FieldMask, CallSettings)

public virtual Operation<DataAgent, OperationMetadata> UpdateDataAgent(DataAgent dataAgent, FieldMask updateMask, CallSettings callSettings = null)

Updates the parameters of a single DataAgent.

Parameters
Name Description
dataAgent DataAgent

Required. The resource being updated.

updateMask FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the DataAgent resource by the update. 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 then all fields with non-default values present in the request will be overwritten. If a wildcard mask is provided, all fields will be overwritten.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDataAgentOperationMetadata

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
DataAgent dataAgent = new DataAgent();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<DataAgent, OperationMetadata> response = dataAgentServiceClient.UpdateDataAgent(dataAgent, updateMask);

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

UpdateDataAgent(UpdateDataAgentRequest, CallSettings)

public virtual Operation<DataAgent, OperationMetadata> UpdateDataAgent(UpdateDataAgentRequest request, CallSettings callSettings = null)

Updates the parameters of a single DataAgent.

Parameters
Name Description
request UpdateDataAgentRequest

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
OperationDataAgentOperationMetadata

The RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = DataAgentServiceClient.Create();
// Initialize request argument(s)
UpdateDataAgentRequest request = new UpdateDataAgentRequest
{
    UpdateMask = new FieldMask(),
    DataAgent = new DataAgent(),
    RequestId = "",
};
// Make the request
Operation<DataAgent, OperationMetadata> response = dataAgentServiceClient.UpdateDataAgent(request);

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

UpdateDataAgentAsync(DataAgent, FieldMask, CallSettings)

public virtual Task<Operation<DataAgent, OperationMetadata>> UpdateDataAgentAsync(DataAgent dataAgent, FieldMask updateMask, CallSettings callSettings = null)

Updates the parameters of a single DataAgent.

Parameters
Name Description
dataAgent DataAgent

Required. The resource being updated.

updateMask FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the DataAgent resource by the update. 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 then all fields with non-default values present in the request will be overwritten. If a wildcard mask is provided, all fields will be overwritten.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDataAgentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
DataAgent dataAgent = new DataAgent();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<DataAgent, OperationMetadata> response = await dataAgentServiceClient.UpdateDataAgentAsync(dataAgent, updateMask);

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

UpdateDataAgentAsync(DataAgent, FieldMask, CancellationToken)

public virtual Task<Operation<DataAgent, OperationMetadata>> UpdateDataAgentAsync(DataAgent dataAgent, FieldMask updateMask, CancellationToken cancellationToken)

Updates the parameters of a single DataAgent.

Parameters
Name Description
dataAgent DataAgent

Required. The resource being updated.

updateMask FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the DataAgent resource by the update. 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 then all fields with non-default values present in the request will be overwritten. If a wildcard mask is provided, all fields will be overwritten.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDataAgentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
DataAgent dataAgent = new DataAgent();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<DataAgent, OperationMetadata> response = await dataAgentServiceClient.UpdateDataAgentAsync(dataAgent, updateMask);

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

UpdateDataAgentAsync(UpdateDataAgentRequest, CallSettings)

public virtual Task<Operation<DataAgent, OperationMetadata>> UpdateDataAgentAsync(UpdateDataAgentRequest request, CallSettings callSettings = null)

Updates the parameters of a single DataAgent.

Parameters
Name Description
request UpdateDataAgentRequest

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
TaskOperationDataAgentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateDataAgentRequest request = new UpdateDataAgentRequest
{
    UpdateMask = new FieldMask(),
    DataAgent = new DataAgent(),
    RequestId = "",
};
// Make the request
Operation<DataAgent, OperationMetadata> response = await dataAgentServiceClient.UpdateDataAgentAsync(request);

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

UpdateDataAgentAsync(UpdateDataAgentRequest, CancellationToken)

public virtual Task<Operation<DataAgent, OperationMetadata>> UpdateDataAgentAsync(UpdateDataAgentRequest request, CancellationToken cancellationToken)

Updates the parameters of a single DataAgent.

Parameters
Name Description
request UpdateDataAgentRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDataAgentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DataAgentServiceClient dataAgentServiceClient = await DataAgentServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateDataAgentRequest request = new UpdateDataAgentRequest
{
    UpdateMask = new FieldMask(),
    DataAgent = new DataAgent(),
    RequestId = "",
};
// Make the request
Operation<DataAgent, OperationMetadata> response = await dataAgentServiceClient.UpdateDataAgentAsync(request);

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