Cloud AI Platform v1 API - Class DatasetServiceClient (3.12.0)

public abstract class DatasetServiceClient

Reference documentation and code samples for the Cloud AI Platform v1 API class DatasetServiceClient.

DatasetService client wrapper, for convenient use.

Inheritance

object > DatasetServiceClient

Derived Types

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

The service that manages Vertex AI Dataset and its child resources.

Properties

CreateDatasetOperationsClient

public virtual OperationsClient CreateDatasetOperationsClient { get; }

The long-running operations client for CreateDataset.

Property Value
Type Description
OperationsClient

CreateDatasetVersionOperationsClient

public virtual OperationsClient CreateDatasetVersionOperationsClient { get; }

The long-running operations client for CreateDatasetVersion.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default DatasetService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default DatasetService scopes are:

DeleteDatasetOperationsClient

public virtual OperationsClient DeleteDatasetOperationsClient { get; }

The long-running operations client for DeleteDataset.

Property Value
Type Description
OperationsClient

DeleteDatasetVersionOperationsClient

public virtual OperationsClient DeleteDatasetVersionOperationsClient { get; }

The long-running operations client for DeleteDatasetVersion.

Property Value
Type Description
OperationsClient

DeleteSavedQueryOperationsClient

public virtual OperationsClient DeleteSavedQueryOperationsClient { get; }

The long-running operations client for DeleteSavedQuery.

Property Value
Type Description
OperationsClient

ExportDataOperationsClient

public virtual OperationsClient ExportDataOperationsClient { get; }

The long-running operations client for ExportData.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual DatasetService.DatasetServiceClient GrpcClient { get; }

The underlying gRPC DatasetService client

Property Value
Type Description
DatasetServiceDatasetServiceClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient

ImportDataOperationsClient

public virtual OperationsClient ImportDataOperationsClient { get; }

The long-running operations client for ImportData.

Property Value
Type Description
OperationsClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

RestoreDatasetVersionOperationsClient

public virtual OperationsClient RestoreDatasetVersionOperationsClient { get; }

The long-running operations client for RestoreDatasetVersion.

Property Value
Type Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static DatasetServiceClient Create()

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

Returns
Type Description
DatasetServiceClient

The created DatasetServiceClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskDatasetServiceClient

The task representing the created DatasetServiceClient.

CreateDataset(LocationName, Dataset, CallSettings)

public virtual Operation<Dataset, CreateDatasetOperationMetadata> CreateDataset(LocationName parent, Dataset dataset, CallSettings callSettings = null)

Creates a Dataset.

Parameters
Name Description
parent LocationName

Required. The resource name of the Location to create the Dataset in. Format: projects/{project}/locations/{location}

dataset Dataset

Required. The Dataset to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatasetCreateDatasetOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Dataset dataset = new Dataset();
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = datasetServiceClient.CreateDataset(parent, dataset);

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

CreateDataset(CreateDatasetRequest, CallSettings)

public virtual Operation<Dataset, CreateDatasetOperationMetadata> CreateDataset(CreateDatasetRequest request, CallSettings callSettings = null)

Creates a Dataset.

Parameters
Name Description
request CreateDatasetRequest

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
OperationDatasetCreateDatasetOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
CreateDatasetRequest request = new CreateDatasetRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Dataset = new Dataset(),
};
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = datasetServiceClient.CreateDataset(request);

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

CreateDataset(string, Dataset, CallSettings)

public virtual Operation<Dataset, CreateDatasetOperationMetadata> CreateDataset(string parent, Dataset dataset, CallSettings callSettings = null)

Creates a Dataset.

Parameters
Name Description
parent string

Required. The resource name of the Location to create the Dataset in. Format: projects/{project}/locations/{location}

dataset Dataset

Required. The Dataset to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatasetCreateDatasetOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Dataset dataset = new Dataset();
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = datasetServiceClient.CreateDataset(parent, dataset);

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

CreateDatasetAsync(LocationName, Dataset, CallSettings)

public virtual Task<Operation<Dataset, CreateDatasetOperationMetadata>> CreateDatasetAsync(LocationName parent, Dataset dataset, CallSettings callSettings = null)

Creates a Dataset.

Parameters
Name Description
parent LocationName

Required. The resource name of the Location to create the Dataset in. Format: projects/{project}/locations/{location}

dataset Dataset

Required. The Dataset to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatasetCreateDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Dataset dataset = new Dataset();
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = await datasetServiceClient.CreateDatasetAsync(parent, dataset);

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

CreateDatasetAsync(LocationName, Dataset, CancellationToken)

public virtual Task<Operation<Dataset, CreateDatasetOperationMetadata>> CreateDatasetAsync(LocationName parent, Dataset dataset, CancellationToken cancellationToken)

Creates a Dataset.

Parameters
Name Description
parent LocationName

Required. The resource name of the Location to create the Dataset in. Format: projects/{project}/locations/{location}

dataset Dataset

Required. The Dataset to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDatasetCreateDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Dataset dataset = new Dataset();
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = await datasetServiceClient.CreateDatasetAsync(parent, dataset);

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

CreateDatasetAsync(CreateDatasetRequest, CallSettings)

public virtual Task<Operation<Dataset, CreateDatasetOperationMetadata>> CreateDatasetAsync(CreateDatasetRequest request, CallSettings callSettings = null)

Creates a Dataset.

Parameters
Name Description
request CreateDatasetRequest

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
TaskOperationDatasetCreateDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDatasetRequest request = new CreateDatasetRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Dataset = new Dataset(),
};
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = await datasetServiceClient.CreateDatasetAsync(request);

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

CreateDatasetAsync(CreateDatasetRequest, CancellationToken)

public virtual Task<Operation<Dataset, CreateDatasetOperationMetadata>> CreateDatasetAsync(CreateDatasetRequest request, CancellationToken cancellationToken)

Creates a Dataset.

Parameters
Name Description
request CreateDatasetRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDatasetCreateDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDatasetRequest request = new CreateDatasetRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Dataset = new Dataset(),
};
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = await datasetServiceClient.CreateDatasetAsync(request);

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

CreateDatasetAsync(string, Dataset, CallSettings)

public virtual Task<Operation<Dataset, CreateDatasetOperationMetadata>> CreateDatasetAsync(string parent, Dataset dataset, CallSettings callSettings = null)

Creates a Dataset.

Parameters
Name Description
parent string

Required. The resource name of the Location to create the Dataset in. Format: projects/{project}/locations/{location}

dataset Dataset

Required. The Dataset to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatasetCreateDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Dataset dataset = new Dataset();
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = await datasetServiceClient.CreateDatasetAsync(parent, dataset);

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

CreateDatasetAsync(string, Dataset, CancellationToken)

public virtual Task<Operation<Dataset, CreateDatasetOperationMetadata>> CreateDatasetAsync(string parent, Dataset dataset, CancellationToken cancellationToken)

Creates a Dataset.

Parameters
Name Description
parent string

Required. The resource name of the Location to create the Dataset in. Format: projects/{project}/locations/{location}

dataset Dataset

Required. The Dataset to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDatasetCreateDatasetOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Dataset dataset = new Dataset();
// Make the request
Operation<Dataset, CreateDatasetOperationMetadata> response = await datasetServiceClient.CreateDatasetAsync(parent, dataset);

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

CreateDatasetVersion(CreateDatasetVersionRequest, CallSettings)

public virtual Operation<DatasetVersion, CreateDatasetVersionOperationMetadata> CreateDatasetVersion(CreateDatasetVersionRequest request, CallSettings callSettings = null)

Create a version from a Dataset.

Parameters
Name Description
request CreateDatasetVersionRequest

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
OperationDatasetVersionCreateDatasetVersionOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
CreateDatasetVersionRequest request = new CreateDatasetVersionRequest
{
    ParentAsDatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    DatasetVersion = new DatasetVersion(),
};
// Make the request
Operation<DatasetVersion, CreateDatasetVersionOperationMetadata> response = datasetServiceClient.CreateDatasetVersion(request);

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

CreateDatasetVersion(DatasetName, DatasetVersion, CallSettings)

public virtual Operation<DatasetVersion, CreateDatasetVersionOperationMetadata> CreateDatasetVersion(DatasetName parent, DatasetVersion datasetVersion, CallSettings callSettings = null)

Create a version from a Dataset.

Parameters
Name Description
parent DatasetName

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

datasetVersion DatasetVersion

Required. The version to be created. The same CMEK policies with the original Dataset will be applied the dataset version. So here we don't need to specify the EncryptionSpecType here.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatasetVersionCreateDatasetVersionOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
DatasetVersion datasetVersion = new DatasetVersion();
// Make the request
Operation<DatasetVersion, CreateDatasetVersionOperationMetadata> response = datasetServiceClient.CreateDatasetVersion(parent, datasetVersion);

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

CreateDatasetVersion(string, DatasetVersion, CallSettings)

public virtual Operation<DatasetVersion, CreateDatasetVersionOperationMetadata> CreateDatasetVersion(string parent, DatasetVersion datasetVersion, CallSettings callSettings = null)

Create a version from a Dataset.

Parameters
Name Description
parent string

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

datasetVersion DatasetVersion

Required. The version to be created. The same CMEK policies with the original Dataset will be applied the dataset version. So here we don't need to specify the EncryptionSpecType here.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatasetVersionCreateDatasetVersionOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
DatasetVersion datasetVersion = new DatasetVersion();
// Make the request
Operation<DatasetVersion, CreateDatasetVersionOperationMetadata> response = datasetServiceClient.CreateDatasetVersion(parent, datasetVersion);

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

CreateDatasetVersionAsync(CreateDatasetVersionRequest, CallSettings)

public virtual Task<Operation<DatasetVersion, CreateDatasetVersionOperationMetadata>> CreateDatasetVersionAsync(CreateDatasetVersionRequest request, CallSettings callSettings = null)

Create a version from a Dataset.

Parameters
Name Description
request CreateDatasetVersionRequest

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
TaskOperationDatasetVersionCreateDatasetVersionOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDatasetVersionRequest request = new CreateDatasetVersionRequest
{
    ParentAsDatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    DatasetVersion = new DatasetVersion(),
};
// Make the request
Operation<DatasetVersion, CreateDatasetVersionOperationMetadata> response = await datasetServiceClient.CreateDatasetVersionAsync(request);

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

CreateDatasetVersionAsync(CreateDatasetVersionRequest, CancellationToken)

public virtual Task<Operation<DatasetVersion, CreateDatasetVersionOperationMetadata>> CreateDatasetVersionAsync(CreateDatasetVersionRequest request, CancellationToken cancellationToken)

Create a version from a Dataset.

Parameters
Name Description
request CreateDatasetVersionRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDatasetVersionCreateDatasetVersionOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDatasetVersionRequest request = new CreateDatasetVersionRequest
{
    ParentAsDatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    DatasetVersion = new DatasetVersion(),
};
// Make the request
Operation<DatasetVersion, CreateDatasetVersionOperationMetadata> response = await datasetServiceClient.CreateDatasetVersionAsync(request);

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

CreateDatasetVersionAsync(DatasetName, DatasetVersion, CallSettings)

public virtual Task<Operation<DatasetVersion, CreateDatasetVersionOperationMetadata>> CreateDatasetVersionAsync(DatasetName parent, DatasetVersion datasetVersion, CallSettings callSettings = null)

Create a version from a Dataset.

Parameters
Name Description
parent DatasetName

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

datasetVersion DatasetVersion

Required. The version to be created. The same CMEK policies with the original Dataset will be applied the dataset version. So here we don't need to specify the EncryptionSpecType here.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatasetVersionCreateDatasetVersionOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
DatasetVersion datasetVersion = new DatasetVersion();
// Make the request
Operation<DatasetVersion, CreateDatasetVersionOperationMetadata> response = await datasetServiceClient.CreateDatasetVersionAsync(parent, datasetVersion);

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

CreateDatasetVersionAsync(DatasetName, DatasetVersion, CancellationToken)

public virtual Task<Operation<DatasetVersion, CreateDatasetVersionOperationMetadata>> CreateDatasetVersionAsync(DatasetName parent, DatasetVersion datasetVersion, CancellationToken cancellationToken)

Create a version from a Dataset.

Parameters
Name Description
parent DatasetName

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

datasetVersion DatasetVersion

Required. The version to be created. The same CMEK policies with the original Dataset will be applied the dataset version. So here we don't need to specify the EncryptionSpecType here.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDatasetVersionCreateDatasetVersionOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
DatasetVersion datasetVersion = new DatasetVersion();
// Make the request
Operation<DatasetVersion, CreateDatasetVersionOperationMetadata> response = await datasetServiceClient.CreateDatasetVersionAsync(parent, datasetVersion);

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

CreateDatasetVersionAsync(string, DatasetVersion, CallSettings)

public virtual Task<Operation<DatasetVersion, CreateDatasetVersionOperationMetadata>> CreateDatasetVersionAsync(string parent, DatasetVersion datasetVersion, CallSettings callSettings = null)

Create a version from a Dataset.

Parameters
Name Description
parent string

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

datasetVersion DatasetVersion

Required. The version to be created. The same CMEK policies with the original Dataset will be applied the dataset version. So here we don't need to specify the EncryptionSpecType here.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatasetVersionCreateDatasetVersionOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
DatasetVersion datasetVersion = new DatasetVersion();
// Make the request
Operation<DatasetVersion, CreateDatasetVersionOperationMetadata> response = await datasetServiceClient.CreateDatasetVersionAsync(parent, datasetVersion);

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

CreateDatasetVersionAsync(string, DatasetVersion, CancellationToken)

public virtual Task<Operation<DatasetVersion, CreateDatasetVersionOperationMetadata>> CreateDatasetVersionAsync(string parent, DatasetVersion datasetVersion, CancellationToken cancellationToken)

Create a version from a Dataset.

Parameters
Name Description
parent string

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

datasetVersion DatasetVersion

Required. The version to be created. The same CMEK policies with the original Dataset will be applied the dataset version. So here we don't need to specify the EncryptionSpecType here.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDatasetVersionCreateDatasetVersionOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
DatasetVersion datasetVersion = new DatasetVersion();
// Make the request
Operation<DatasetVersion, CreateDatasetVersionOperationMetadata> response = await datasetServiceClient.CreateDatasetVersionAsync(parent, datasetVersion);

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

DeleteDataset(DatasetName, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteDataset(DatasetName name, CallSettings callSettings = null)

Deletes a Dataset.

Parameters
Name Description
name DatasetName

Required. The resource name of the Dataset to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = datasetServiceClient.DeleteDataset(name);

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

DeleteDataset(DeleteDatasetRequest, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteDataset(DeleteDatasetRequest request, CallSettings callSettings = null)

Deletes a Dataset.

Parameters
Name Description
request DeleteDatasetRequest

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
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DeleteDatasetRequest request = new DeleteDatasetRequest
{
    DatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = datasetServiceClient.DeleteDataset(request);

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

DeleteDataset(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteDataset(string name, CallSettings callSettings = null)

Deletes a Dataset.

Parameters
Name Description
name string

Required. The resource name of the Dataset to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = datasetServiceClient.DeleteDataset(name);

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

DeleteDatasetAsync(DatasetName, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteDatasetAsync(DatasetName name, CallSettings callSettings = null)

Deletes a Dataset.

Parameters
Name Description
name DatasetName

Required. The resource name of the Dataset to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteDatasetAsync(name);

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

DeleteDatasetAsync(DatasetName, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteDatasetAsync(DatasetName name, CancellationToken cancellationToken)

Deletes a Dataset.

Parameters
Name Description
name DatasetName

Required. The resource name of the Dataset to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteDatasetAsync(name);

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

DeleteDatasetAsync(DeleteDatasetRequest, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteDatasetAsync(DeleteDatasetRequest request, CallSettings callSettings = null)

Deletes a Dataset.

Parameters
Name Description
request DeleteDatasetRequest

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
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteDatasetRequest request = new DeleteDatasetRequest
{
    DatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteDatasetAsync(request);

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

DeleteDatasetAsync(DeleteDatasetRequest, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteDatasetAsync(DeleteDatasetRequest request, CancellationToken cancellationToken)

Deletes a Dataset.

Parameters
Name Description
request DeleteDatasetRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteDatasetRequest request = new DeleteDatasetRequest
{
    DatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteDatasetAsync(request);

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

DeleteDatasetAsync(string, CallSettings)

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

Deletes a Dataset.

Parameters
Name Description
name string

Required. The resource name of the Dataset to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteDatasetAsync(name);

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

DeleteDatasetAsync(string, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteDatasetAsync(string name, CancellationToken cancellationToken)

Deletes a Dataset.

Parameters
Name Description
name string

Required. The resource name of the Dataset to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteDatasetAsync(name);

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

DeleteDatasetVersion(DatasetVersionName, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteDatasetVersion(DatasetVersionName name, CallSettings callSettings = null)

Deletes a Dataset version.

Parameters
Name Description
name DatasetVersionName

Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DatasetVersionName name = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = datasetServiceClient.DeleteDatasetVersion(name);

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

DeleteDatasetVersion(DeleteDatasetVersionRequest, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteDatasetVersion(DeleteDatasetVersionRequest request, CallSettings callSettings = null)

Deletes a Dataset version.

Parameters
Name Description
request DeleteDatasetVersionRequest

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
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DeleteDatasetVersionRequest request = new DeleteDatasetVersionRequest
{
    DatasetVersionName = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = datasetServiceClient.DeleteDatasetVersion(request);

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

DeleteDatasetVersion(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteDatasetVersion(string name, CallSettings callSettings = null)

Deletes a Dataset version.

Parameters
Name Description
name string

Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/datasetVersions/[DATASET_VERSION]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = datasetServiceClient.DeleteDatasetVersion(name);

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

DeleteDatasetVersionAsync(DatasetVersionName, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteDatasetVersionAsync(DatasetVersionName name, CallSettings callSettings = null)

Deletes a Dataset version.

Parameters
Name Description
name DatasetVersionName

Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetVersionName name = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteDatasetVersionAsync(name);

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

DeleteDatasetVersionAsync(DatasetVersionName, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteDatasetVersionAsync(DatasetVersionName name, CancellationToken cancellationToken)

Deletes a Dataset version.

Parameters
Name Description
name DatasetVersionName

Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetVersionName name = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteDatasetVersionAsync(name);

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

DeleteDatasetVersionAsync(DeleteDatasetVersionRequest, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteDatasetVersionAsync(DeleteDatasetVersionRequest request, CallSettings callSettings = null)

Deletes a Dataset version.

Parameters
Name Description
request DeleteDatasetVersionRequest

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
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteDatasetVersionRequest request = new DeleteDatasetVersionRequest
{
    DatasetVersionName = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteDatasetVersionAsync(request);

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

DeleteDatasetVersionAsync(DeleteDatasetVersionRequest, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteDatasetVersionAsync(DeleteDatasetVersionRequest request, CancellationToken cancellationToken)

Deletes a Dataset version.

Parameters
Name Description
request DeleteDatasetVersionRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteDatasetVersionRequest request = new DeleteDatasetVersionRequest
{
    DatasetVersionName = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteDatasetVersionAsync(request);

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

DeleteDatasetVersionAsync(string, CallSettings)

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

Deletes a Dataset version.

Parameters
Name Description
name string

Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/datasetVersions/[DATASET_VERSION]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteDatasetVersionAsync(name);

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

DeleteDatasetVersionAsync(string, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteDatasetVersionAsync(string name, CancellationToken cancellationToken)

Deletes a Dataset version.

Parameters
Name Description
name string

Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/datasetVersions/[DATASET_VERSION]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteDatasetVersionAsync(name);

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

DeleteSavedQuery(DeleteSavedQueryRequest, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteSavedQuery(DeleteSavedQueryRequest request, CallSettings callSettings = null)

Deletes a SavedQuery.

Parameters
Name Description
request DeleteSavedQueryRequest

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
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DeleteSavedQueryRequest request = new DeleteSavedQueryRequest
{
    SavedQueryName = SavedQueryName.FromProjectLocationDatasetSavedQuery("[PROJECT]", "[LOCATION]", "[DATASET]", "[SAVED_QUERY]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = datasetServiceClient.DeleteSavedQuery(request);

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

DeleteSavedQuery(SavedQueryName, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteSavedQuery(SavedQueryName name, CallSettings callSettings = null)

Deletes a SavedQuery.

Parameters
Name Description
name SavedQueryName

Required. The resource name of the SavedQuery to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
SavedQueryName name = SavedQueryName.FromProjectLocationDatasetSavedQuery("[PROJECT]", "[LOCATION]", "[DATASET]", "[SAVED_QUERY]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = datasetServiceClient.DeleteSavedQuery(name);

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

DeleteSavedQuery(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteSavedQuery(string name, CallSettings callSettings = null)

Deletes a SavedQuery.

Parameters
Name Description
name string

Required. The resource name of the SavedQuery to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/savedQueries/[SAVED_QUERY]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = datasetServiceClient.DeleteSavedQuery(name);

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

DeleteSavedQueryAsync(DeleteSavedQueryRequest, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteSavedQueryAsync(DeleteSavedQueryRequest request, CallSettings callSettings = null)

Deletes a SavedQuery.

Parameters
Name Description
request DeleteSavedQueryRequest

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
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteSavedQueryRequest request = new DeleteSavedQueryRequest
{
    SavedQueryName = SavedQueryName.FromProjectLocationDatasetSavedQuery("[PROJECT]", "[LOCATION]", "[DATASET]", "[SAVED_QUERY]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteSavedQueryAsync(request);

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

DeleteSavedQueryAsync(DeleteSavedQueryRequest, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteSavedQueryAsync(DeleteSavedQueryRequest request, CancellationToken cancellationToken)

Deletes a SavedQuery.

Parameters
Name Description
request DeleteSavedQueryRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteSavedQueryRequest request = new DeleteSavedQueryRequest
{
    SavedQueryName = SavedQueryName.FromProjectLocationDatasetSavedQuery("[PROJECT]", "[LOCATION]", "[DATASET]", "[SAVED_QUERY]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteSavedQueryAsync(request);

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

DeleteSavedQueryAsync(SavedQueryName, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteSavedQueryAsync(SavedQueryName name, CallSettings callSettings = null)

Deletes a SavedQuery.

Parameters
Name Description
name SavedQueryName

Required. The resource name of the SavedQuery to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
SavedQueryName name = SavedQueryName.FromProjectLocationDatasetSavedQuery("[PROJECT]", "[LOCATION]", "[DATASET]", "[SAVED_QUERY]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteSavedQueryAsync(name);

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

DeleteSavedQueryAsync(SavedQueryName, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteSavedQueryAsync(SavedQueryName name, CancellationToken cancellationToken)

Deletes a SavedQuery.

Parameters
Name Description
name SavedQueryName

Required. The resource name of the SavedQuery to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
SavedQueryName name = SavedQueryName.FromProjectLocationDatasetSavedQuery("[PROJECT]", "[LOCATION]", "[DATASET]", "[SAVED_QUERY]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteSavedQueryAsync(name);

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

DeleteSavedQueryAsync(string, CallSettings)

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

Deletes a SavedQuery.

Parameters
Name Description
name string

Required. The resource name of the SavedQuery to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/savedQueries/[SAVED_QUERY]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteSavedQueryAsync(name);

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

DeleteSavedQueryAsync(string, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteSavedQueryAsync(string name, CancellationToken cancellationToken)

Deletes a SavedQuery.

Parameters
Name Description
name string

Required. The resource name of the SavedQuery to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/savedQueries/[SAVED_QUERY]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await datasetServiceClient.DeleteSavedQueryAsync(name);

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

ExportData(DatasetName, ExportDataConfig, CallSettings)

public virtual Operation<ExportDataResponse, ExportDataOperationMetadata> ExportData(DatasetName name, ExportDataConfig exportConfig, CallSettings callSettings = null)

Exports data from a Dataset.

Parameters
Name Description
name DatasetName

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

exportConfig ExportDataConfig

Required. The desired output location.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationExportDataResponseExportDataOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
ExportDataConfig exportConfig = new ExportDataConfig();
// Make the request
Operation<ExportDataResponse, ExportDataOperationMetadata> response = datasetServiceClient.ExportData(name, exportConfig);

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

ExportData(ExportDataRequest, CallSettings)

public virtual Operation<ExportDataResponse, ExportDataOperationMetadata> ExportData(ExportDataRequest request, CallSettings callSettings = null)

Exports data from a Dataset.

Parameters
Name Description
request ExportDataRequest

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
OperationExportDataResponseExportDataOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
ExportDataRequest request = new ExportDataRequest
{
    DatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    ExportConfig = new ExportDataConfig(),
};
// Make the request
Operation<ExportDataResponse, ExportDataOperationMetadata> response = datasetServiceClient.ExportData(request);

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

ExportData(string, ExportDataConfig, CallSettings)

public virtual Operation<ExportDataResponse, ExportDataOperationMetadata> ExportData(string name, ExportDataConfig exportConfig, CallSettings callSettings = null)

Exports data from a Dataset.

Parameters
Name Description
name string

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

exportConfig ExportDataConfig

Required. The desired output location.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationExportDataResponseExportDataOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
ExportDataConfig exportConfig = new ExportDataConfig();
// Make the request
Operation<ExportDataResponse, ExportDataOperationMetadata> response = datasetServiceClient.ExportData(name, exportConfig);

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

ExportDataAsync(DatasetName, ExportDataConfig, CallSettings)

public virtual Task<Operation<ExportDataResponse, ExportDataOperationMetadata>> ExportDataAsync(DatasetName name, ExportDataConfig exportConfig, CallSettings callSettings = null)

Exports data from a Dataset.

Parameters
Name Description
name DatasetName

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

exportConfig ExportDataConfig

Required. The desired output location.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationExportDataResponseExportDataOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
ExportDataConfig exportConfig = new ExportDataConfig();
// Make the request
Operation<ExportDataResponse, ExportDataOperationMetadata> response = await datasetServiceClient.ExportDataAsync(name, exportConfig);

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

ExportDataAsync(DatasetName, ExportDataConfig, CancellationToken)

public virtual Task<Operation<ExportDataResponse, ExportDataOperationMetadata>> ExportDataAsync(DatasetName name, ExportDataConfig exportConfig, CancellationToken cancellationToken)

Exports data from a Dataset.

Parameters
Name Description
name DatasetName

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

exportConfig ExportDataConfig

Required. The desired output location.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationExportDataResponseExportDataOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
ExportDataConfig exportConfig = new ExportDataConfig();
// Make the request
Operation<ExportDataResponse, ExportDataOperationMetadata> response = await datasetServiceClient.ExportDataAsync(name, exportConfig);

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

ExportDataAsync(ExportDataRequest, CallSettings)

public virtual Task<Operation<ExportDataResponse, ExportDataOperationMetadata>> ExportDataAsync(ExportDataRequest request, CallSettings callSettings = null)

Exports data from a Dataset.

Parameters
Name Description
request ExportDataRequest

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
TaskOperationExportDataResponseExportDataOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
ExportDataRequest request = new ExportDataRequest
{
    DatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    ExportConfig = new ExportDataConfig(),
};
// Make the request
Operation<ExportDataResponse, ExportDataOperationMetadata> response = await datasetServiceClient.ExportDataAsync(request);

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

ExportDataAsync(ExportDataRequest, CancellationToken)

public virtual Task<Operation<ExportDataResponse, ExportDataOperationMetadata>> ExportDataAsync(ExportDataRequest request, CancellationToken cancellationToken)

Exports data from a Dataset.

Parameters
Name Description
request ExportDataRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationExportDataResponseExportDataOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
ExportDataRequest request = new ExportDataRequest
{
    DatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    ExportConfig = new ExportDataConfig(),
};
// Make the request
Operation<ExportDataResponse, ExportDataOperationMetadata> response = await datasetServiceClient.ExportDataAsync(request);

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

ExportDataAsync(string, ExportDataConfig, CallSettings)

public virtual Task<Operation<ExportDataResponse, ExportDataOperationMetadata>> ExportDataAsync(string name, ExportDataConfig exportConfig, CallSettings callSettings = null)

Exports data from a Dataset.

Parameters
Name Description
name string

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

exportConfig ExportDataConfig

Required. The desired output location.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationExportDataResponseExportDataOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
ExportDataConfig exportConfig = new ExportDataConfig();
// Make the request
Operation<ExportDataResponse, ExportDataOperationMetadata> response = await datasetServiceClient.ExportDataAsync(name, exportConfig);

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

ExportDataAsync(string, ExportDataConfig, CancellationToken)

public virtual Task<Operation<ExportDataResponse, ExportDataOperationMetadata>> ExportDataAsync(string name, ExportDataConfig exportConfig, CancellationToken cancellationToken)

Exports data from a Dataset.

Parameters
Name Description
name string

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

exportConfig ExportDataConfig

Required. The desired output location.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationExportDataResponseExportDataOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
ExportDataConfig exportConfig = new ExportDataConfig();
// Make the request
Operation<ExportDataResponse, ExportDataOperationMetadata> response = await datasetServiceClient.ExportDataAsync(name, exportConfig);

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

GetAnnotationSpec(AnnotationSpecName, CallSettings)

public virtual AnnotationSpec GetAnnotationSpec(AnnotationSpecName name, CallSettings callSettings = null)

Gets an AnnotationSpec.

Parameters
Name Description
name AnnotationSpecName

Required. The name of the AnnotationSpec resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AnnotationSpec

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
AnnotationSpecName name = AnnotationSpecName.FromProjectLocationDatasetAnnotationSpec("[PROJECT]", "[LOCATION]", "[DATASET]", "[ANNOTATION_SPEC]");
// Make the request
AnnotationSpec response = datasetServiceClient.GetAnnotationSpec(name);

GetAnnotationSpec(GetAnnotationSpecRequest, CallSettings)

public virtual AnnotationSpec GetAnnotationSpec(GetAnnotationSpecRequest request, CallSettings callSettings = null)

Gets an AnnotationSpec.

Parameters
Name Description
request GetAnnotationSpecRequest

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
AnnotationSpec

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
GetAnnotationSpecRequest request = new GetAnnotationSpecRequest
{
    AnnotationSpecName = AnnotationSpecName.FromProjectLocationDatasetAnnotationSpec("[PROJECT]", "[LOCATION]", "[DATASET]", "[ANNOTATION_SPEC]"),
    ReadMask = new FieldMask(),
};
// Make the request
AnnotationSpec response = datasetServiceClient.GetAnnotationSpec(request);

GetAnnotationSpec(string, CallSettings)

public virtual AnnotationSpec GetAnnotationSpec(string name, CallSettings callSettings = null)

Gets an AnnotationSpec.

Parameters
Name Description
name string

Required. The name of the AnnotationSpec resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AnnotationSpec

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/annotationSpecs/[ANNOTATION_SPEC]";
// Make the request
AnnotationSpec response = datasetServiceClient.GetAnnotationSpec(name);

GetAnnotationSpecAsync(AnnotationSpecName, CallSettings)

public virtual Task<AnnotationSpec> GetAnnotationSpecAsync(AnnotationSpecName name, CallSettings callSettings = null)

Gets an AnnotationSpec.

Parameters
Name Description
name AnnotationSpecName

Required. The name of the AnnotationSpec resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAnnotationSpec

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
AnnotationSpecName name = AnnotationSpecName.FromProjectLocationDatasetAnnotationSpec("[PROJECT]", "[LOCATION]", "[DATASET]", "[ANNOTATION_SPEC]");
// Make the request
AnnotationSpec response = await datasetServiceClient.GetAnnotationSpecAsync(name);

GetAnnotationSpecAsync(AnnotationSpecName, CancellationToken)

public virtual Task<AnnotationSpec> GetAnnotationSpecAsync(AnnotationSpecName name, CancellationToken cancellationToken)

Gets an AnnotationSpec.

Parameters
Name Description
name AnnotationSpecName

Required. The name of the AnnotationSpec resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAnnotationSpec

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
AnnotationSpecName name = AnnotationSpecName.FromProjectLocationDatasetAnnotationSpec("[PROJECT]", "[LOCATION]", "[DATASET]", "[ANNOTATION_SPEC]");
// Make the request
AnnotationSpec response = await datasetServiceClient.GetAnnotationSpecAsync(name);

GetAnnotationSpecAsync(GetAnnotationSpecRequest, CallSettings)

public virtual Task<AnnotationSpec> GetAnnotationSpecAsync(GetAnnotationSpecRequest request, CallSettings callSettings = null)

Gets an AnnotationSpec.

Parameters
Name Description
request GetAnnotationSpecRequest

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
TaskAnnotationSpec

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
GetAnnotationSpecRequest request = new GetAnnotationSpecRequest
{
    AnnotationSpecName = AnnotationSpecName.FromProjectLocationDatasetAnnotationSpec("[PROJECT]", "[LOCATION]", "[DATASET]", "[ANNOTATION_SPEC]"),
    ReadMask = new FieldMask(),
};
// Make the request
AnnotationSpec response = await datasetServiceClient.GetAnnotationSpecAsync(request);

GetAnnotationSpecAsync(GetAnnotationSpecRequest, CancellationToken)

public virtual Task<AnnotationSpec> GetAnnotationSpecAsync(GetAnnotationSpecRequest request, CancellationToken cancellationToken)

Gets an AnnotationSpec.

Parameters
Name Description
request GetAnnotationSpecRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAnnotationSpec

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
GetAnnotationSpecRequest request = new GetAnnotationSpecRequest
{
    AnnotationSpecName = AnnotationSpecName.FromProjectLocationDatasetAnnotationSpec("[PROJECT]", "[LOCATION]", "[DATASET]", "[ANNOTATION_SPEC]"),
    ReadMask = new FieldMask(),
};
// Make the request
AnnotationSpec response = await datasetServiceClient.GetAnnotationSpecAsync(request);

GetAnnotationSpecAsync(string, CallSettings)

public virtual Task<AnnotationSpec> GetAnnotationSpecAsync(string name, CallSettings callSettings = null)

Gets an AnnotationSpec.

Parameters
Name Description
name string

Required. The name of the AnnotationSpec resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAnnotationSpec

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/annotationSpecs/[ANNOTATION_SPEC]";
// Make the request
AnnotationSpec response = await datasetServiceClient.GetAnnotationSpecAsync(name);

GetAnnotationSpecAsync(string, CancellationToken)

public virtual Task<AnnotationSpec> GetAnnotationSpecAsync(string name, CancellationToken cancellationToken)

Gets an AnnotationSpec.

Parameters
Name Description
name string

Required. The name of the AnnotationSpec resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAnnotationSpec

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/annotationSpecs/[ANNOTATION_SPEC]";
// Make the request
AnnotationSpec response = await datasetServiceClient.GetAnnotationSpecAsync(name);

GetDataset(DatasetName, CallSettings)

public virtual Dataset GetDataset(DatasetName name, CallSettings callSettings = null)

Gets a Dataset.

Parameters
Name Description
name DatasetName

Required. The name of the Dataset resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
// Make the request
Dataset response = datasetServiceClient.GetDataset(name);

GetDataset(GetDatasetRequest, CallSettings)

public virtual Dataset GetDataset(GetDatasetRequest request, CallSettings callSettings = null)

Gets a Dataset.

Parameters
Name Description
request GetDatasetRequest

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
Dataset

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
GetDatasetRequest request = new GetDatasetRequest
{
    DatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    ReadMask = new FieldMask(),
};
// Make the request
Dataset response = datasetServiceClient.GetDataset(request);

GetDataset(string, CallSettings)

public virtual Dataset GetDataset(string name, CallSettings callSettings = null)

Gets a Dataset.

Parameters
Name Description
name string

Required. The name of the Dataset resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
// Make the request
Dataset response = datasetServiceClient.GetDataset(name);

GetDatasetAsync(DatasetName, CallSettings)

public virtual Task<Dataset> GetDatasetAsync(DatasetName name, CallSettings callSettings = null)

Gets a Dataset.

Parameters
Name Description
name DatasetName

Required. The name of the Dataset resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
// Make the request
Dataset response = await datasetServiceClient.GetDatasetAsync(name);

GetDatasetAsync(DatasetName, CancellationToken)

public virtual Task<Dataset> GetDatasetAsync(DatasetName name, CancellationToken cancellationToken)

Gets a Dataset.

Parameters
Name Description
name DatasetName

Required. The name of the Dataset resource.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
// Make the request
Dataset response = await datasetServiceClient.GetDatasetAsync(name);

GetDatasetAsync(GetDatasetRequest, CallSettings)

public virtual Task<Dataset> GetDatasetAsync(GetDatasetRequest request, CallSettings callSettings = null)

Gets a Dataset.

Parameters
Name Description
request GetDatasetRequest

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
TaskDataset

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
GetDatasetRequest request = new GetDatasetRequest
{
    DatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    ReadMask = new FieldMask(),
};
// Make the request
Dataset response = await datasetServiceClient.GetDatasetAsync(request);

GetDatasetAsync(GetDatasetRequest, CancellationToken)

public virtual Task<Dataset> GetDatasetAsync(GetDatasetRequest request, CancellationToken cancellationToken)

Gets a Dataset.

Parameters
Name Description
request GetDatasetRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
GetDatasetRequest request = new GetDatasetRequest
{
    DatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    ReadMask = new FieldMask(),
};
// Make the request
Dataset response = await datasetServiceClient.GetDatasetAsync(request);

GetDatasetAsync(string, CallSettings)

public virtual Task<Dataset> GetDatasetAsync(string name, CallSettings callSettings = null)

Gets a Dataset.

Parameters
Name Description
name string

Required. The name of the Dataset resource.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
// Make the request
Dataset response = await datasetServiceClient.GetDatasetAsync(name);

GetDatasetAsync(string, CancellationToken)

public virtual Task<Dataset> GetDatasetAsync(string name, CancellationToken cancellationToken)

Gets a Dataset.

Parameters
Name Description
name string

Required. The name of the Dataset resource.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
// Make the request
Dataset response = await datasetServiceClient.GetDatasetAsync(name);

GetDatasetVersion(DatasetVersionName, CallSettings)

public virtual DatasetVersion GetDatasetVersion(DatasetVersionName name, CallSettings callSettings = null)

Gets a Dataset version.

Parameters
Name Description
name DatasetVersionName

Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DatasetVersion

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DatasetVersionName name = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]");
// Make the request
DatasetVersion response = datasetServiceClient.GetDatasetVersion(name);

GetDatasetVersion(GetDatasetVersionRequest, CallSettings)

public virtual DatasetVersion GetDatasetVersion(GetDatasetVersionRequest request, CallSettings callSettings = null)

Gets a Dataset version.

Parameters
Name Description
request GetDatasetVersionRequest

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
DatasetVersion

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
GetDatasetVersionRequest request = new GetDatasetVersionRequest
{
    DatasetVersionName = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]"),
    ReadMask = new FieldMask(),
};
// Make the request
DatasetVersion response = datasetServiceClient.GetDatasetVersion(request);

GetDatasetVersion(string, CallSettings)

public virtual DatasetVersion GetDatasetVersion(string name, CallSettings callSettings = null)

Gets a Dataset version.

Parameters
Name Description
name string

Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DatasetVersion

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/datasetVersions/[DATASET_VERSION]";
// Make the request
DatasetVersion response = datasetServiceClient.GetDatasetVersion(name);

GetDatasetVersionAsync(DatasetVersionName, CallSettings)

public virtual Task<DatasetVersion> GetDatasetVersionAsync(DatasetVersionName name, CallSettings callSettings = null)

Gets a Dataset version.

Parameters
Name Description
name DatasetVersionName

Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDatasetVersion

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetVersionName name = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]");
// Make the request
DatasetVersion response = await datasetServiceClient.GetDatasetVersionAsync(name);

GetDatasetVersionAsync(DatasetVersionName, CancellationToken)

public virtual Task<DatasetVersion> GetDatasetVersionAsync(DatasetVersionName name, CancellationToken cancellationToken)

Gets a Dataset version.

Parameters
Name Description
name DatasetVersionName

Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDatasetVersion

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetVersionName name = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]");
// Make the request
DatasetVersion response = await datasetServiceClient.GetDatasetVersionAsync(name);

GetDatasetVersionAsync(GetDatasetVersionRequest, CallSettings)

public virtual Task<DatasetVersion> GetDatasetVersionAsync(GetDatasetVersionRequest request, CallSettings callSettings = null)

Gets a Dataset version.

Parameters
Name Description
request GetDatasetVersionRequest

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
TaskDatasetVersion

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
GetDatasetVersionRequest request = new GetDatasetVersionRequest
{
    DatasetVersionName = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]"),
    ReadMask = new FieldMask(),
};
// Make the request
DatasetVersion response = await datasetServiceClient.GetDatasetVersionAsync(request);

GetDatasetVersionAsync(GetDatasetVersionRequest, CancellationToken)

public virtual Task<DatasetVersion> GetDatasetVersionAsync(GetDatasetVersionRequest request, CancellationToken cancellationToken)

Gets a Dataset version.

Parameters
Name Description
request GetDatasetVersionRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDatasetVersion

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
GetDatasetVersionRequest request = new GetDatasetVersionRequest
{
    DatasetVersionName = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]"),
    ReadMask = new FieldMask(),
};
// Make the request
DatasetVersion response = await datasetServiceClient.GetDatasetVersionAsync(request);

GetDatasetVersionAsync(string, CallSettings)

public virtual Task<DatasetVersion> GetDatasetVersionAsync(string name, CallSettings callSettings = null)

Gets a Dataset version.

Parameters
Name Description
name string

Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDatasetVersion

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/datasetVersions/[DATASET_VERSION]";
// Make the request
DatasetVersion response = await datasetServiceClient.GetDatasetVersionAsync(name);

GetDatasetVersionAsync(string, CancellationToken)

public virtual Task<DatasetVersion> GetDatasetVersionAsync(string name, CancellationToken cancellationToken)

Gets a Dataset version.

Parameters
Name Description
name string

Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDatasetVersion

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/datasetVersions/[DATASET_VERSION]";
// Make the request
DatasetVersion response = await datasetServiceClient.GetDatasetVersionAsync(name);

ImportData(DatasetName, IEnumerable<ImportDataConfig>, CallSettings)

public virtual Operation<ImportDataResponse, ImportDataOperationMetadata> ImportData(DatasetName name, IEnumerable<ImportDataConfig> importConfigs, CallSettings callSettings = null)

Imports data into a Dataset.

Parameters
Name Description
name DatasetName

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

importConfigs IEnumerableImportDataConfig

Required. The desired input locations. The contents of all input locations will be imported in one batch.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationImportDataResponseImportDataOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
IEnumerable<ImportDataConfig> importConfigs = new ImportDataConfig[]
{
    new ImportDataConfig(),
};
// Make the request
Operation<ImportDataResponse, ImportDataOperationMetadata> response = datasetServiceClient.ImportData(name, importConfigs);

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

ImportData(ImportDataRequest, CallSettings)

public virtual Operation<ImportDataResponse, ImportDataOperationMetadata> ImportData(ImportDataRequest request, CallSettings callSettings = null)

Imports data into a Dataset.

Parameters
Name Description
request ImportDataRequest

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
OperationImportDataResponseImportDataOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
ImportDataRequest request = new ImportDataRequest
{
    DatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    ImportConfigs =
    {
        new ImportDataConfig(),
    },
};
// Make the request
Operation<ImportDataResponse, ImportDataOperationMetadata> response = datasetServiceClient.ImportData(request);

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

ImportData(string, IEnumerable<ImportDataConfig>, CallSettings)

public virtual Operation<ImportDataResponse, ImportDataOperationMetadata> ImportData(string name, IEnumerable<ImportDataConfig> importConfigs, CallSettings callSettings = null)

Imports data into a Dataset.

Parameters
Name Description
name string

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

importConfigs IEnumerableImportDataConfig

Required. The desired input locations. The contents of all input locations will be imported in one batch.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationImportDataResponseImportDataOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
IEnumerable<ImportDataConfig> importConfigs = new ImportDataConfig[]
{
    new ImportDataConfig(),
};
// Make the request
Operation<ImportDataResponse, ImportDataOperationMetadata> response = datasetServiceClient.ImportData(name, importConfigs);

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

ImportDataAsync(DatasetName, IEnumerable<ImportDataConfig>, CallSettings)

public virtual Task<Operation<ImportDataResponse, ImportDataOperationMetadata>> ImportDataAsync(DatasetName name, IEnumerable<ImportDataConfig> importConfigs, CallSettings callSettings = null)

Imports data into a Dataset.

Parameters
Name Description
name DatasetName

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

importConfigs IEnumerableImportDataConfig

Required. The desired input locations. The contents of all input locations will be imported in one batch.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationImportDataResponseImportDataOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
IEnumerable<ImportDataConfig> importConfigs = new ImportDataConfig[]
{
    new ImportDataConfig(),
};
// Make the request
Operation<ImportDataResponse, ImportDataOperationMetadata> response = await datasetServiceClient.ImportDataAsync(name, importConfigs);

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

ImportDataAsync(DatasetName, IEnumerable<ImportDataConfig>, CancellationToken)

public virtual Task<Operation<ImportDataResponse, ImportDataOperationMetadata>> ImportDataAsync(DatasetName name, IEnumerable<ImportDataConfig> importConfigs, CancellationToken cancellationToken)

Imports data into a Dataset.

Parameters
Name Description
name DatasetName

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

importConfigs IEnumerableImportDataConfig

Required. The desired input locations. The contents of all input locations will be imported in one batch.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationImportDataResponseImportDataOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
IEnumerable<ImportDataConfig> importConfigs = new ImportDataConfig[]
{
    new ImportDataConfig(),
};
// Make the request
Operation<ImportDataResponse, ImportDataOperationMetadata> response = await datasetServiceClient.ImportDataAsync(name, importConfigs);

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

ImportDataAsync(ImportDataRequest, CallSettings)

public virtual Task<Operation<ImportDataResponse, ImportDataOperationMetadata>> ImportDataAsync(ImportDataRequest request, CallSettings callSettings = null)

Imports data into a Dataset.

Parameters
Name Description
request ImportDataRequest

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
TaskOperationImportDataResponseImportDataOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
ImportDataRequest request = new ImportDataRequest
{
    DatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    ImportConfigs =
    {
        new ImportDataConfig(),
    },
};
// Make the request
Operation<ImportDataResponse, ImportDataOperationMetadata> response = await datasetServiceClient.ImportDataAsync(request);

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

ImportDataAsync(ImportDataRequest, CancellationToken)

public virtual Task<Operation<ImportDataResponse, ImportDataOperationMetadata>> ImportDataAsync(ImportDataRequest request, CancellationToken cancellationToken)

Imports data into a Dataset.

Parameters
Name Description
request ImportDataRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationImportDataResponseImportDataOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
ImportDataRequest request = new ImportDataRequest
{
    DatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    ImportConfigs =
    {
        new ImportDataConfig(),
    },
};
// Make the request
Operation<ImportDataResponse, ImportDataOperationMetadata> response = await datasetServiceClient.ImportDataAsync(request);

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

ImportDataAsync(string, IEnumerable<ImportDataConfig>, CallSettings)

public virtual Task<Operation<ImportDataResponse, ImportDataOperationMetadata>> ImportDataAsync(string name, IEnumerable<ImportDataConfig> importConfigs, CallSettings callSettings = null)

Imports data into a Dataset.

Parameters
Name Description
name string

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

importConfigs IEnumerableImportDataConfig

Required. The desired input locations. The contents of all input locations will be imported in one batch.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationImportDataResponseImportDataOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
IEnumerable<ImportDataConfig> importConfigs = new ImportDataConfig[]
{
    new ImportDataConfig(),
};
// Make the request
Operation<ImportDataResponse, ImportDataOperationMetadata> response = await datasetServiceClient.ImportDataAsync(name, importConfigs);

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

ImportDataAsync(string, IEnumerable<ImportDataConfig>, CancellationToken)

public virtual Task<Operation<ImportDataResponse, ImportDataOperationMetadata>> ImportDataAsync(string name, IEnumerable<ImportDataConfig> importConfigs, CancellationToken cancellationToken)

Imports data into a Dataset.

Parameters
Name Description
name string

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

importConfigs IEnumerableImportDataConfig

Required. The desired input locations. The contents of all input locations will be imported in one batch.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationImportDataResponseImportDataOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
IEnumerable<ImportDataConfig> importConfigs = new ImportDataConfig[]
{
    new ImportDataConfig(),
};
// Make the request
Operation<ImportDataResponse, ImportDataOperationMetadata> response = await datasetServiceClient.ImportDataAsync(name, importConfigs);

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

ListAnnotations(DataItemName, string, int?, CallSettings)

public virtual PagedEnumerable<ListAnnotationsResponse, Annotation> ListAnnotations(DataItemName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.

Parameters
Name Description
parent DataItemName

Required. The resource name of the DataItem to list Annotations from. Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}

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
PagedEnumerableListAnnotationsResponseAnnotation

A pageable sequence of Annotation resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DataItemName parent = DataItemName.FromProjectLocationDatasetDataItem("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATA_ITEM]");
// Make the request
PagedEnumerable<ListAnnotationsResponse, Annotation> response = datasetServiceClient.ListAnnotations(parent);

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

ListAnnotations(ListAnnotationsRequest, CallSettings)

public virtual PagedEnumerable<ListAnnotationsResponse, Annotation> ListAnnotations(ListAnnotationsRequest request, CallSettings callSettings = null)

Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.

Parameters
Name Description
request ListAnnotationsRequest

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
PagedEnumerableListAnnotationsResponseAnnotation

A pageable sequence of Annotation resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
ListAnnotationsRequest request = new ListAnnotationsRequest
{
    ParentAsDataItemName = DataItemName.FromProjectLocationDatasetDataItem("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATA_ITEM]"),
    Filter = "",
    ReadMask = new FieldMask(),
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListAnnotationsResponse, Annotation> response = datasetServiceClient.ListAnnotations(request);

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

ListAnnotations(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListAnnotationsResponse, Annotation> ListAnnotations(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.

Parameters
Name Description
parent string

Required. The resource name of the DataItem to list Annotations from. Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}

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
PagedEnumerableListAnnotationsResponseAnnotation

A pageable sequence of Annotation resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/dataItems/[DATA_ITEM]";
// Make the request
PagedEnumerable<ListAnnotationsResponse, Annotation> response = datasetServiceClient.ListAnnotations(parent);

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

ListAnnotationsAsync(DataItemName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAnnotationsResponse, Annotation> ListAnnotationsAsync(DataItemName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.

Parameters
Name Description
parent DataItemName

Required. The resource name of the DataItem to list Annotations from. Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}

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
PagedAsyncEnumerableListAnnotationsResponseAnnotation

A pageable asynchronous sequence of Annotation resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DataItemName parent = DataItemName.FromProjectLocationDatasetDataItem("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATA_ITEM]");
// Make the request
PagedAsyncEnumerable<ListAnnotationsResponse, Annotation> response = datasetServiceClient.ListAnnotationsAsync(parent);

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

ListAnnotationsAsync(ListAnnotationsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListAnnotationsResponse, Annotation> ListAnnotationsAsync(ListAnnotationsRequest request, CallSettings callSettings = null)

Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.

Parameters
Name Description
request ListAnnotationsRequest

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
PagedAsyncEnumerableListAnnotationsResponseAnnotation

A pageable asynchronous sequence of Annotation resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
ListAnnotationsRequest request = new ListAnnotationsRequest
{
    ParentAsDataItemName = DataItemName.FromProjectLocationDatasetDataItem("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATA_ITEM]"),
    Filter = "",
    ReadMask = new FieldMask(),
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListAnnotationsResponse, Annotation> response = datasetServiceClient.ListAnnotationsAsync(request);

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

ListAnnotationsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAnnotationsResponse, Annotation> ListAnnotationsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.

Parameters
Name Description
parent string

Required. The resource name of the DataItem to list Annotations from. Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}

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
PagedAsyncEnumerableListAnnotationsResponseAnnotation

A pageable asynchronous sequence of Annotation resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/dataItems/[DATA_ITEM]";
// Make the request
PagedAsyncEnumerable<ListAnnotationsResponse, Annotation> response = datasetServiceClient.ListAnnotationsAsync(parent);

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

ListDataItems(DatasetName, string, int?, CallSettings)

public virtual PagedEnumerable<ListDataItemsResponse, DataItem> ListDataItems(DatasetName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DataItems in a Dataset.

Parameters
Name Description
parent DatasetName

Required. The resource name of the Dataset to list DataItems from. Format: projects/{project}/locations/{location}/datasets/{dataset}

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
PagedEnumerableListDataItemsResponseDataItem

A pageable sequence of DataItem resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
// Make the request
PagedEnumerable<ListDataItemsResponse, DataItem> response = datasetServiceClient.ListDataItems(parent);

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

ListDataItems(ListDataItemsRequest, CallSettings)

public virtual PagedEnumerable<ListDataItemsResponse, DataItem> ListDataItems(ListDataItemsRequest request, CallSettings callSettings = null)

Lists DataItems in a Dataset.

Parameters
Name Description
request ListDataItemsRequest

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
PagedEnumerableListDataItemsResponseDataItem

A pageable sequence of DataItem resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
ListDataItemsRequest request = new ListDataItemsRequest
{
    ParentAsDatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    Filter = "",
    ReadMask = new FieldMask(),
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListDataItemsResponse, DataItem> response = datasetServiceClient.ListDataItems(request);

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

ListDataItems(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListDataItemsResponse, DataItem> ListDataItems(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DataItems in a Dataset.

Parameters
Name Description
parent string

Required. The resource name of the Dataset to list DataItems from. Format: projects/{project}/locations/{location}/datasets/{dataset}

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
PagedEnumerableListDataItemsResponseDataItem

A pageable sequence of DataItem resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
// Make the request
PagedEnumerable<ListDataItemsResponse, DataItem> response = datasetServiceClient.ListDataItems(parent);

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

ListDataItemsAsync(DatasetName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDataItemsResponse, DataItem> ListDataItemsAsync(DatasetName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DataItems in a Dataset.

Parameters
Name Description
parent DatasetName

Required. The resource name of the Dataset to list DataItems from. Format: projects/{project}/locations/{location}/datasets/{dataset}

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
PagedAsyncEnumerableListDataItemsResponseDataItem

A pageable asynchronous sequence of DataItem resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
// Make the request
PagedAsyncEnumerable<ListDataItemsResponse, DataItem> response = datasetServiceClient.ListDataItemsAsync(parent);

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

ListDataItemsAsync(ListDataItemsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListDataItemsResponse, DataItem> ListDataItemsAsync(ListDataItemsRequest request, CallSettings callSettings = null)

Lists DataItems in a Dataset.

Parameters
Name Description
request ListDataItemsRequest

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
PagedAsyncEnumerableListDataItemsResponseDataItem

A pageable asynchronous sequence of DataItem resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
ListDataItemsRequest request = new ListDataItemsRequest
{
    ParentAsDatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    Filter = "",
    ReadMask = new FieldMask(),
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListDataItemsResponse, DataItem> response = datasetServiceClient.ListDataItemsAsync(request);

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

ListDataItemsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDataItemsResponse, DataItem> ListDataItemsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DataItems in a Dataset.

Parameters
Name Description
parent string

Required. The resource name of the Dataset to list DataItems from. Format: projects/{project}/locations/{location}/datasets/{dataset}

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
PagedAsyncEnumerableListDataItemsResponseDataItem

A pageable asynchronous sequence of DataItem resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
// Make the request
PagedAsyncEnumerable<ListDataItemsResponse, DataItem> response = datasetServiceClient.ListDataItemsAsync(parent);

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

ListDatasetVersions(DatasetName, string, int?, CallSettings)

public virtual PagedEnumerable<ListDatasetVersionsResponse, DatasetVersion> ListDatasetVersions(DatasetName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DatasetVersions in a Dataset.

Parameters
Name Description
parent DatasetName

Required. The resource name of the Dataset to list DatasetVersions from. Format: projects/{project}/locations/{location}/datasets/{dataset}

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
PagedEnumerableListDatasetVersionsResponseDatasetVersion

A pageable sequence of DatasetVersion resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
// Make the request
PagedEnumerable<ListDatasetVersionsResponse, DatasetVersion> response = datasetServiceClient.ListDatasetVersions(parent);

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

ListDatasetVersions(ListDatasetVersionsRequest, CallSettings)

public virtual PagedEnumerable<ListDatasetVersionsResponse, DatasetVersion> ListDatasetVersions(ListDatasetVersionsRequest request, CallSettings callSettings = null)

Lists DatasetVersions in a Dataset.

Parameters
Name Description
request ListDatasetVersionsRequest

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
PagedEnumerableListDatasetVersionsResponseDatasetVersion

A pageable sequence of DatasetVersion resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
ListDatasetVersionsRequest request = new ListDatasetVersionsRequest
{
    ParentAsDatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    Filter = "",
    ReadMask = new FieldMask(),
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListDatasetVersionsResponse, DatasetVersion> response = datasetServiceClient.ListDatasetVersions(request);

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

ListDatasetVersions(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListDatasetVersionsResponse, DatasetVersion> ListDatasetVersions(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DatasetVersions in a Dataset.

Parameters
Name Description
parent string

Required. The resource name of the Dataset to list DatasetVersions from. Format: projects/{project}/locations/{location}/datasets/{dataset}

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
PagedEnumerableListDatasetVersionsResponseDatasetVersion

A pageable sequence of DatasetVersion resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
// Make the request
PagedEnumerable<ListDatasetVersionsResponse, DatasetVersion> response = datasetServiceClient.ListDatasetVersions(parent);

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

ListDatasetVersionsAsync(DatasetName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDatasetVersionsResponse, DatasetVersion> ListDatasetVersionsAsync(DatasetName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DatasetVersions in a Dataset.

Parameters
Name Description
parent DatasetName

Required. The resource name of the Dataset to list DatasetVersions from. Format: projects/{project}/locations/{location}/datasets/{dataset}

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
PagedAsyncEnumerableListDatasetVersionsResponseDatasetVersion

A pageable asynchronous sequence of DatasetVersion resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
// Make the request
PagedAsyncEnumerable<ListDatasetVersionsResponse, DatasetVersion> response = datasetServiceClient.ListDatasetVersionsAsync(parent);

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

ListDatasetVersionsAsync(ListDatasetVersionsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListDatasetVersionsResponse, DatasetVersion> ListDatasetVersionsAsync(ListDatasetVersionsRequest request, CallSettings callSettings = null)

Lists DatasetVersions in a Dataset.

Parameters
Name Description
request ListDatasetVersionsRequest

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
PagedAsyncEnumerableListDatasetVersionsResponseDatasetVersion

A pageable asynchronous sequence of DatasetVersion resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
ListDatasetVersionsRequest request = new ListDatasetVersionsRequest
{
    ParentAsDatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    Filter = "",
    ReadMask = new FieldMask(),
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListDatasetVersionsResponse, DatasetVersion> response = datasetServiceClient.ListDatasetVersionsAsync(request);

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

ListDatasetVersionsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDatasetVersionsResponse, DatasetVersion> ListDatasetVersionsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists DatasetVersions in a Dataset.

Parameters
Name Description
parent string

Required. The resource name of the Dataset to list DatasetVersions from. Format: projects/{project}/locations/{location}/datasets/{dataset}

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
PagedAsyncEnumerableListDatasetVersionsResponseDatasetVersion

A pageable asynchronous sequence of DatasetVersion resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
// Make the request
PagedAsyncEnumerable<ListDatasetVersionsResponse, DatasetVersion> response = datasetServiceClient.ListDatasetVersionsAsync(parent);

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

ListDatasets(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListDatasetsResponse, Dataset> ListDatasets(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Datasets in a Location.

Parameters
Name Description
parent LocationName

Required. The name of the Dataset's parent resource. Format: projects/{project}/locations/{location}

pageToken string

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

pageSize int

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDatasetsResponseDataset

A pageable sequence of Dataset resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListDatasetsResponse, Dataset> response = datasetServiceClient.ListDatasets(parent);

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

ListDatasets(ListDatasetsRequest, CallSettings)

public virtual PagedEnumerable<ListDatasetsResponse, Dataset> ListDatasets(ListDatasetsRequest request, CallSettings callSettings = null)

Lists Datasets in a Location.

Parameters
Name Description
request ListDatasetsRequest

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
PagedEnumerableListDatasetsResponseDataset

A pageable sequence of Dataset resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
ListDatasetsRequest request = new ListDatasetsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    ReadMask = new FieldMask(),
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListDatasetsResponse, Dataset> response = datasetServiceClient.ListDatasets(request);

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

ListDatasets(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListDatasetsResponse, Dataset> ListDatasets(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Datasets in a Location.

Parameters
Name Description
parent string

Required. The name of the Dataset's parent resource. Format: projects/{project}/locations/{location}

pageToken string

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

pageSize int

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDatasetsResponseDataset

A pageable sequence of Dataset resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListDatasetsResponse, Dataset> response = datasetServiceClient.ListDatasets(parent);

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

ListDatasetsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDatasetsResponse, Dataset> ListDatasetsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Datasets in a Location.

Parameters
Name Description
parent LocationName

Required. The name of the Dataset's parent resource. Format: projects/{project}/locations/{location}

pageToken string

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

pageSize int

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDatasetsResponseDataset

A pageable asynchronous sequence of Dataset resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListDatasetsResponse, Dataset> response = datasetServiceClient.ListDatasetsAsync(parent);

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

ListDatasetsAsync(ListDatasetsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListDatasetsResponse, Dataset> ListDatasetsAsync(ListDatasetsRequest request, CallSettings callSettings = null)

Lists Datasets in a Location.

Parameters
Name Description
request ListDatasetsRequest

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
PagedAsyncEnumerableListDatasetsResponseDataset

A pageable asynchronous sequence of Dataset resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
ListDatasetsRequest request = new ListDatasetsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    ReadMask = new FieldMask(),
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListDatasetsResponse, Dataset> response = datasetServiceClient.ListDatasetsAsync(request);

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

ListDatasetsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDatasetsResponse, Dataset> ListDatasetsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Datasets in a Location.

Parameters
Name Description
parent string

Required. The name of the Dataset's parent resource. Format: projects/{project}/locations/{location}

pageToken string

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

pageSize int

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDatasetsResponseDataset

A pageable asynchronous sequence of Dataset resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListDatasetsResponse, Dataset> response = datasetServiceClient.ListDatasetsAsync(parent);

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

ListSavedQueries(DatasetName, string, int?, CallSettings)

public virtual PagedEnumerable<ListSavedQueriesResponse, SavedQuery> ListSavedQueries(DatasetName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists SavedQueries in a Dataset.

Parameters
Name Description
parent DatasetName

Required. The resource name of the Dataset to list SavedQueries from. Format: projects/{project}/locations/{location}/datasets/{dataset}

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
PagedEnumerableListSavedQueriesResponseSavedQuery

A pageable sequence of SavedQuery resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
// Make the request
PagedEnumerable<ListSavedQueriesResponse, SavedQuery> response = datasetServiceClient.ListSavedQueries(parent);

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

ListSavedQueries(ListSavedQueriesRequest, CallSettings)

public virtual PagedEnumerable<ListSavedQueriesResponse, SavedQuery> ListSavedQueries(ListSavedQueriesRequest request, CallSettings callSettings = null)

Lists SavedQueries in a Dataset.

Parameters
Name Description
request ListSavedQueriesRequest

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
PagedEnumerableListSavedQueriesResponseSavedQuery

A pageable sequence of SavedQuery resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
ListSavedQueriesRequest request = new ListSavedQueriesRequest
{
    ParentAsDatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    Filter = "",
    ReadMask = new FieldMask(),
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListSavedQueriesResponse, SavedQuery> response = datasetServiceClient.ListSavedQueries(request);

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

ListSavedQueries(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListSavedQueriesResponse, SavedQuery> ListSavedQueries(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists SavedQueries in a Dataset.

Parameters
Name Description
parent string

Required. The resource name of the Dataset to list SavedQueries from. Format: projects/{project}/locations/{location}/datasets/{dataset}

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
PagedEnumerableListSavedQueriesResponseSavedQuery

A pageable sequence of SavedQuery resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
// Make the request
PagedEnumerable<ListSavedQueriesResponse, SavedQuery> response = datasetServiceClient.ListSavedQueries(parent);

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

ListSavedQueriesAsync(DatasetName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListSavedQueriesResponse, SavedQuery> ListSavedQueriesAsync(DatasetName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists SavedQueries in a Dataset.

Parameters
Name Description
parent DatasetName

Required. The resource name of the Dataset to list SavedQueries from. Format: projects/{project}/locations/{location}/datasets/{dataset}

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
PagedAsyncEnumerableListSavedQueriesResponseSavedQuery

A pageable asynchronous sequence of SavedQuery resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]");
// Make the request
PagedAsyncEnumerable<ListSavedQueriesResponse, SavedQuery> response = datasetServiceClient.ListSavedQueriesAsync(parent);

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

ListSavedQueriesAsync(ListSavedQueriesRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListSavedQueriesResponse, SavedQuery> ListSavedQueriesAsync(ListSavedQueriesRequest request, CallSettings callSettings = null)

Lists SavedQueries in a Dataset.

Parameters
Name Description
request ListSavedQueriesRequest

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
PagedAsyncEnumerableListSavedQueriesResponseSavedQuery

A pageable asynchronous sequence of SavedQuery resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
ListSavedQueriesRequest request = new ListSavedQueriesRequest
{
    ParentAsDatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    Filter = "",
    ReadMask = new FieldMask(),
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListSavedQueriesResponse, SavedQuery> response = datasetServiceClient.ListSavedQueriesAsync(request);

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

ListSavedQueriesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListSavedQueriesResponse, SavedQuery> ListSavedQueriesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists SavedQueries in a Dataset.

Parameters
Name Description
parent string

Required. The resource name of the Dataset to list SavedQueries from. Format: projects/{project}/locations/{location}/datasets/{dataset}

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
PagedAsyncEnumerableListSavedQueriesResponseSavedQuery

A pageable asynchronous sequence of SavedQuery resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]";
// Make the request
PagedAsyncEnumerable<ListSavedQueriesResponse, SavedQuery> response = datasetServiceClient.ListSavedQueriesAsync(parent);

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

PollOnceCreateDataset(string, CallSettings)

public virtual Operation<Dataset, CreateDatasetOperationMetadata> PollOnceCreateDataset(string operationName, CallSettings callSettings = null)

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

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
OperationDatasetCreateDatasetOperationMetadata

The result of polling the operation.

PollOnceCreateDatasetAsync(string, CallSettings)

public virtual Task<Operation<Dataset, CreateDatasetOperationMetadata>> PollOnceCreateDatasetAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationDatasetCreateDatasetOperationMetadata

A task representing the result of polling the operation.

PollOnceCreateDatasetVersion(string, CallSettings)

public virtual Operation<DatasetVersion, CreateDatasetVersionOperationMetadata> PollOnceCreateDatasetVersion(string operationName, CallSettings callSettings = null)

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

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
OperationDatasetVersionCreateDatasetVersionOperationMetadata

The result of polling the operation.

PollOnceCreateDatasetVersionAsync(string, CallSettings)

public virtual Task<Operation<DatasetVersion, CreateDatasetVersionOperationMetadata>> PollOnceCreateDatasetVersionAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationDatasetVersionCreateDatasetVersionOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteDataset(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> PollOnceDeleteDataset(string operationName, CallSettings callSettings = null)

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

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
OperationEmptyDeleteOperationMetadata

The result of polling the operation.

PollOnceDeleteDatasetAsync(string, CallSettings)

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

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

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
TaskOperationEmptyDeleteOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteDatasetVersion(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> PollOnceDeleteDatasetVersion(string operationName, CallSettings callSettings = null)

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

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
OperationEmptyDeleteOperationMetadata

The result of polling the operation.

PollOnceDeleteDatasetVersionAsync(string, CallSettings)

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

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

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
TaskOperationEmptyDeleteOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteSavedQuery(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> PollOnceDeleteSavedQuery(string operationName, CallSettings callSettings = null)

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

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
OperationEmptyDeleteOperationMetadata

The result of polling the operation.

PollOnceDeleteSavedQueryAsync(string, CallSettings)

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

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

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
TaskOperationEmptyDeleteOperationMetadata

A task representing the result of polling the operation.

PollOnceExportData(string, CallSettings)

public virtual Operation<ExportDataResponse, ExportDataOperationMetadata> PollOnceExportData(string operationName, CallSettings callSettings = null)

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

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
OperationExportDataResponseExportDataOperationMetadata

The result of polling the operation.

PollOnceExportDataAsync(string, CallSettings)

public virtual Task<Operation<ExportDataResponse, ExportDataOperationMetadata>> PollOnceExportDataAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationExportDataResponseExportDataOperationMetadata

A task representing the result of polling the operation.

PollOnceImportData(string, CallSettings)

public virtual Operation<ImportDataResponse, ImportDataOperationMetadata> PollOnceImportData(string operationName, CallSettings callSettings = null)

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

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
OperationImportDataResponseImportDataOperationMetadata

The result of polling the operation.

PollOnceImportDataAsync(string, CallSettings)

public virtual Task<Operation<ImportDataResponse, ImportDataOperationMetadata>> PollOnceImportDataAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationImportDataResponseImportDataOperationMetadata

A task representing the result of polling the operation.

PollOnceRestoreDatasetVersion(string, CallSettings)

public virtual Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata> PollOnceRestoreDatasetVersion(string operationName, CallSettings callSettings = null)

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

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
OperationDatasetVersionRestoreDatasetVersionOperationMetadata

The result of polling the operation.

PollOnceRestoreDatasetVersionAsync(string, CallSettings)

public virtual Task<Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata>> PollOnceRestoreDatasetVersionAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationDatasetVersionRestoreDatasetVersionOperationMetadata

A task representing the result of polling the operation.

RestoreDatasetVersion(DatasetVersionName, CallSettings)

public virtual Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata> RestoreDatasetVersion(DatasetVersionName name, CallSettings callSettings = null)

Restores a dataset version.

Parameters
Name Description
name DatasetVersionName

Required. The name of the DatasetVersion resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatasetVersionRestoreDatasetVersionOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DatasetVersionName name = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]");
// Make the request
Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata> response = datasetServiceClient.RestoreDatasetVersion(name);

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

RestoreDatasetVersion(RestoreDatasetVersionRequest, CallSettings)

public virtual Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata> RestoreDatasetVersion(RestoreDatasetVersionRequest request, CallSettings callSettings = null)

Restores a dataset version.

Parameters
Name Description
request RestoreDatasetVersionRequest

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
OperationDatasetVersionRestoreDatasetVersionOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
RestoreDatasetVersionRequest request = new RestoreDatasetVersionRequest
{
    DatasetVersionName = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]"),
};
// Make the request
Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata> response = datasetServiceClient.RestoreDatasetVersion(request);

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

RestoreDatasetVersion(string, CallSettings)

public virtual Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata> RestoreDatasetVersion(string name, CallSettings callSettings = null)

Restores a dataset version.

Parameters
Name Description
name string

Required. The name of the DatasetVersion resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationDatasetVersionRestoreDatasetVersionOperationMetadata

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/datasetVersions/[DATASET_VERSION]";
// Make the request
Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata> response = datasetServiceClient.RestoreDatasetVersion(name);

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

RestoreDatasetVersionAsync(DatasetVersionName, CallSettings)

public virtual Task<Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata>> RestoreDatasetVersionAsync(DatasetVersionName name, CallSettings callSettings = null)

Restores a dataset version.

Parameters
Name Description
name DatasetVersionName

Required. The name of the DatasetVersion resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatasetVersionRestoreDatasetVersionOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetVersionName name = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]");
// Make the request
Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata> response = await datasetServiceClient.RestoreDatasetVersionAsync(name);

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

RestoreDatasetVersionAsync(DatasetVersionName, CancellationToken)

public virtual Task<Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata>> RestoreDatasetVersionAsync(DatasetVersionName name, CancellationToken cancellationToken)

Restores a dataset version.

Parameters
Name Description
name DatasetVersionName

Required. The name of the DatasetVersion resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDatasetVersionRestoreDatasetVersionOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetVersionName name = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]");
// Make the request
Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata> response = await datasetServiceClient.RestoreDatasetVersionAsync(name);

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

RestoreDatasetVersionAsync(RestoreDatasetVersionRequest, CallSettings)

public virtual Task<Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata>> RestoreDatasetVersionAsync(RestoreDatasetVersionRequest request, CallSettings callSettings = null)

Restores a dataset version.

Parameters
Name Description
request RestoreDatasetVersionRequest

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
TaskOperationDatasetVersionRestoreDatasetVersionOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
RestoreDatasetVersionRequest request = new RestoreDatasetVersionRequest
{
    DatasetVersionName = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]"),
};
// Make the request
Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata> response = await datasetServiceClient.RestoreDatasetVersionAsync(request);

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

RestoreDatasetVersionAsync(RestoreDatasetVersionRequest, CancellationToken)

public virtual Task<Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata>> RestoreDatasetVersionAsync(RestoreDatasetVersionRequest request, CancellationToken cancellationToken)

Restores a dataset version.

Parameters
Name Description
request RestoreDatasetVersionRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDatasetVersionRestoreDatasetVersionOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
RestoreDatasetVersionRequest request = new RestoreDatasetVersionRequest
{
    DatasetVersionName = DatasetVersionName.FromProjectLocationDatasetDatasetVersion("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]"),
};
// Make the request
Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata> response = await datasetServiceClient.RestoreDatasetVersionAsync(request);

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

RestoreDatasetVersionAsync(string, CallSettings)

public virtual Task<Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata>> RestoreDatasetVersionAsync(string name, CallSettings callSettings = null)

Restores a dataset version.

Parameters
Name Description
name string

Required. The name of the DatasetVersion resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationDatasetVersionRestoreDatasetVersionOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/datasetVersions/[DATASET_VERSION]";
// Make the request
Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata> response = await datasetServiceClient.RestoreDatasetVersionAsync(name);

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

RestoreDatasetVersionAsync(string, CancellationToken)

public virtual Task<Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata>> RestoreDatasetVersionAsync(string name, CancellationToken cancellationToken)

Restores a dataset version.

Parameters
Name Description
name string

Required. The name of the DatasetVersion resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationDatasetVersionRestoreDatasetVersionOperationMetadata

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/datasets/[DATASET]/datasetVersions/[DATASET_VERSION]";
// Make the request
Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata> response = await datasetServiceClient.RestoreDatasetVersionAsync(name);

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

SearchDataItems(SearchDataItemsRequest, CallSettings)

public virtual PagedEnumerable<SearchDataItemsResponse, DataItemView> SearchDataItems(SearchDataItemsRequest request, CallSettings callSettings = null)

Searches DataItems in a Dataset.

Parameters
Name Description
request SearchDataItemsRequest

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
PagedEnumerableSearchDataItemsResponseDataItemView

A pageable sequence of DataItemView resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
SearchDataItemsRequest request = new SearchDataItemsRequest
{
    DatasetAsDatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    DataLabelingJob = "",
    DataItemFilter = "",
    FieldMask = new FieldMask(),
    AnnotationsLimit = 0,
    AnnotationFilters = { "", },
    OrderByDataItem = "",
};
// Make the request
PagedEnumerable<SearchDataItemsResponse, DataItemView> response = datasetServiceClient.SearchDataItems(request);

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

SearchDataItemsAsync(SearchDataItemsRequest, CallSettings)

public virtual PagedAsyncEnumerable<SearchDataItemsResponse, DataItemView> SearchDataItemsAsync(SearchDataItemsRequest request, CallSettings callSettings = null)

Searches DataItems in a Dataset.

Parameters
Name Description
request SearchDataItemsRequest

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
PagedAsyncEnumerableSearchDataItemsResponseDataItemView

A pageable asynchronous sequence of DataItemView resources.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
SearchDataItemsRequest request = new SearchDataItemsRequest
{
    DatasetAsDatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
    DataLabelingJob = "",
    DataItemFilter = "",
    FieldMask = new FieldMask(),
    AnnotationsLimit = 0,
    AnnotationFilters = { "", },
    OrderByDataItem = "",
};
// Make the request
PagedAsyncEnumerable<SearchDataItemsResponse, DataItemView> response = datasetServiceClient.SearchDataItemsAsync(request);

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

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.

UpdateDataset(Dataset, FieldMask, CallSettings)

public virtual Dataset UpdateDataset(Dataset dataset, FieldMask updateMask, CallSettings callSettings = null)

Updates a Dataset.

Parameters
Name Description
dataset Dataset

Required. The Dataset which replaces the resource on the server.

updateMask FieldMask

Required. The update mask applies to the resource. For the FieldMask definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields:

  • display_name
  • description
  • labels
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
Dataset dataset = new Dataset();
FieldMask updateMask = new FieldMask();
// Make the request
Dataset response = datasetServiceClient.UpdateDataset(dataset, updateMask);

UpdateDataset(UpdateDatasetRequest, CallSettings)

public virtual Dataset UpdateDataset(UpdateDatasetRequest request, CallSettings callSettings = null)

Updates a Dataset.

Parameters
Name Description
request UpdateDatasetRequest

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
Dataset

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
UpdateDatasetRequest request = new UpdateDatasetRequest
{
    Dataset = new Dataset(),
    UpdateMask = new FieldMask(),
};
// Make the request
Dataset response = datasetServiceClient.UpdateDataset(request);

UpdateDatasetAsync(Dataset, FieldMask, CallSettings)

public virtual Task<Dataset> UpdateDatasetAsync(Dataset dataset, FieldMask updateMask, CallSettings callSettings = null)

Updates a Dataset.

Parameters
Name Description
dataset Dataset

Required. The Dataset which replaces the resource on the server.

updateMask FieldMask

Required. The update mask applies to the resource. For the FieldMask definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields:

  • display_name
  • description
  • labels
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
Dataset dataset = new Dataset();
FieldMask updateMask = new FieldMask();
// Make the request
Dataset response = await datasetServiceClient.UpdateDatasetAsync(dataset, updateMask);

UpdateDatasetAsync(Dataset, FieldMask, CancellationToken)

public virtual Task<Dataset> UpdateDatasetAsync(Dataset dataset, FieldMask updateMask, CancellationToken cancellationToken)

Updates a Dataset.

Parameters
Name Description
dataset Dataset

Required. The Dataset which replaces the resource on the server.

updateMask FieldMask

Required. The update mask applies to the resource. For the FieldMask definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields:

  • display_name
  • description
  • labels
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
Dataset dataset = new Dataset();
FieldMask updateMask = new FieldMask();
// Make the request
Dataset response = await datasetServiceClient.UpdateDatasetAsync(dataset, updateMask);

UpdateDatasetAsync(UpdateDatasetRequest, CallSettings)

public virtual Task<Dataset> UpdateDatasetAsync(UpdateDatasetRequest request, CallSettings callSettings = null)

Updates a Dataset.

Parameters
Name Description
request UpdateDatasetRequest

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
TaskDataset

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateDatasetRequest request = new UpdateDatasetRequest
{
    Dataset = new Dataset(),
    UpdateMask = new FieldMask(),
};
// Make the request
Dataset response = await datasetServiceClient.UpdateDatasetAsync(request);

UpdateDatasetAsync(UpdateDatasetRequest, CancellationToken)

public virtual Task<Dataset> UpdateDatasetAsync(UpdateDatasetRequest request, CancellationToken cancellationToken)

Updates a Dataset.

Parameters
Name Description
request UpdateDatasetRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateDatasetRequest request = new UpdateDatasetRequest
{
    Dataset = new Dataset(),
    UpdateMask = new FieldMask(),
};
// Make the request
Dataset response = await datasetServiceClient.UpdateDatasetAsync(request);

UpdateDatasetVersion(DatasetVersion, FieldMask, CallSettings)

public virtual DatasetVersion UpdateDatasetVersion(DatasetVersion datasetVersion, FieldMask updateMask, CallSettings callSettings = null)

Updates a DatasetVersion.

Parameters
Name Description
datasetVersion DatasetVersion

Required. The DatasetVersion which replaces the resource on the server.

updateMask FieldMask

Required. The update mask applies to the resource. For the FieldMask definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields:

  • display_name
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DatasetVersion

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
DatasetVersion datasetVersion = new DatasetVersion();
FieldMask updateMask = new FieldMask();
// Make the request
DatasetVersion response = datasetServiceClient.UpdateDatasetVersion(datasetVersion, updateMask);

UpdateDatasetVersion(UpdateDatasetVersionRequest, CallSettings)

public virtual DatasetVersion UpdateDatasetVersion(UpdateDatasetVersionRequest request, CallSettings callSettings = null)

Updates a DatasetVersion.

Parameters
Name Description
request UpdateDatasetVersionRequest

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
DatasetVersion

The RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
UpdateDatasetVersionRequest request = new UpdateDatasetVersionRequest
{
    DatasetVersion = new DatasetVersion(),
    UpdateMask = new FieldMask(),
};
// Make the request
DatasetVersion response = datasetServiceClient.UpdateDatasetVersion(request);

UpdateDatasetVersionAsync(DatasetVersion, FieldMask, CallSettings)

public virtual Task<DatasetVersion> UpdateDatasetVersionAsync(DatasetVersion datasetVersion, FieldMask updateMask, CallSettings callSettings = null)

Updates a DatasetVersion.

Parameters
Name Description
datasetVersion DatasetVersion

Required. The DatasetVersion which replaces the resource on the server.

updateMask FieldMask

Required. The update mask applies to the resource. For the FieldMask definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields:

  • display_name
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDatasetVersion

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetVersion datasetVersion = new DatasetVersion();
FieldMask updateMask = new FieldMask();
// Make the request
DatasetVersion response = await datasetServiceClient.UpdateDatasetVersionAsync(datasetVersion, updateMask);

UpdateDatasetVersionAsync(DatasetVersion, FieldMask, CancellationToken)

public virtual Task<DatasetVersion> UpdateDatasetVersionAsync(DatasetVersion datasetVersion, FieldMask updateMask, CancellationToken cancellationToken)

Updates a DatasetVersion.

Parameters
Name Description
datasetVersion DatasetVersion

Required. The DatasetVersion which replaces the resource on the server.

updateMask FieldMask

Required. The update mask applies to the resource. For the FieldMask definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields:

  • display_name
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDatasetVersion

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetVersion datasetVersion = new DatasetVersion();
FieldMask updateMask = new FieldMask();
// Make the request
DatasetVersion response = await datasetServiceClient.UpdateDatasetVersionAsync(datasetVersion, updateMask);

UpdateDatasetVersionAsync(UpdateDatasetVersionRequest, CallSettings)

public virtual Task<DatasetVersion> UpdateDatasetVersionAsync(UpdateDatasetVersionRequest request, CallSettings callSettings = null)

Updates a DatasetVersion.

Parameters
Name Description
request UpdateDatasetVersionRequest

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
TaskDatasetVersion

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateDatasetVersionRequest request = new UpdateDatasetVersionRequest
{
    DatasetVersion = new DatasetVersion(),
    UpdateMask = new FieldMask(),
};
// Make the request
DatasetVersion response = await datasetServiceClient.UpdateDatasetVersionAsync(request);

UpdateDatasetVersionAsync(UpdateDatasetVersionRequest, CancellationToken)

public virtual Task<DatasetVersion> UpdateDatasetVersionAsync(UpdateDatasetVersionRequest request, CancellationToken cancellationToken)

Updates a DatasetVersion.

Parameters
Name Description
request UpdateDatasetVersionRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDatasetVersion

A Task containing the RPC response.

Example
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateDatasetVersionRequest request = new UpdateDatasetVersionRequest
{
    DatasetVersion = new DatasetVersion(),
    UpdateMask = new FieldMask(),
};
// Make the request
DatasetVersion response = await datasetServiceClient.UpdateDatasetVersionAsync(request);