Show / Hide Table of Contents

Class MapsPlatformDatasetsV1AlphaClient

MapsPlatformDatasetsV1Alpha client wrapper, for convenient use.

Inheritance
object
MapsPlatformDatasetsV1AlphaClient
MapsPlatformDatasetsV1AlphaClientImpl
Inherited Members
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Maps.MapsPlatformDatasets.V1Alpha
Assembly: Google.Maps.MapsPlatformDatasets.V1Alpha.dll
Syntax
public abstract class MapsPlatformDatasetsV1AlphaClient
Remarks

Service definition for the Maps Platform Datasets API.

Properties

DefaultEndpoint

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

Declaration
public static string DefaultEndpoint { get; }
Property Value
Type Description
string

DefaultScopes

The default MapsPlatformDatasetsV1Alpha scopes.

Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
Type Description
IReadOnlyList<string>
Remarks

The default MapsPlatformDatasetsV1Alpha scopes are:

  • https://www.googleapis.com/auth/cloud-platform

GrpcClient

The underlying gRPC MapsPlatformDatasetsV1Alpha client

Declaration
public virtual MapsPlatformDatasetsV1Alpha.MapsPlatformDatasetsV1AlphaClient GrpcClient { get; }
Property Value
Type Description
MapsPlatformDatasetsV1Alpha.MapsPlatformDatasetsV1AlphaClient

ServiceMetadata

The service metadata associated with this client type.

Declaration
public static ServiceMetadata ServiceMetadata { get; }
Property Value
Type Description
ServiceMetadata

Methods

Create()

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

Declaration
public static MapsPlatformDatasetsV1AlphaClient Create()
Returns
Type Description
MapsPlatformDatasetsV1AlphaClient

The created MapsPlatformDatasetsV1AlphaClient.

CreateAsync(CancellationToken)

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

Declaration
public static Task<MapsPlatformDatasetsV1AlphaClient> CreateAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
Task<MapsPlatformDatasetsV1AlphaClient>

The task representing the created MapsPlatformDatasetsV1AlphaClient.

CreateDataset(ProjectName, Dataset, CallSettings)

Create a new dataset for the specified project.

Declaration
public virtual Dataset CreateDataset(ProjectName parent, Dataset dataset, CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Parent project that will own the dataset. Format: projects/{$project_number}

Dataset dataset

Required. The dataset version to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Dataset dataset = new Dataset();
// Make the request
Dataset response = mapsPlatformDatasetsV1AlphaClient.CreateDataset(parent, dataset);

CreateDataset(CreateDatasetRequest, CallSettings)

Create a new dataset for the specified project.

Declaration
public virtual Dataset CreateDataset(CreateDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateDatasetRequest request

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.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
CreateDatasetRequest request = new CreateDatasetRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Dataset = new Dataset(),
};
// Make the request
Dataset response = mapsPlatformDatasetsV1AlphaClient.CreateDataset(request);

CreateDataset(string, Dataset, CallSettings)

Create a new dataset for the specified project.

Declaration
public virtual Dataset CreateDataset(string parent, Dataset dataset, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. Parent project that will own the dataset. Format: projects/{$project_number}

Dataset dataset

Required. The dataset version to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Dataset dataset = new Dataset();
// Make the request
Dataset response = mapsPlatformDatasetsV1AlphaClient.CreateDataset(parent, dataset);

CreateDatasetAsync(ProjectName, Dataset, CallSettings)

Create a new dataset for the specified project.

Declaration
public virtual Task<Dataset> CreateDatasetAsync(ProjectName parent, Dataset dataset, CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Parent project that will own the dataset. Format: projects/{$project_number}

Dataset dataset

Required. The dataset version to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Dataset dataset = new Dataset();
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.CreateDatasetAsync(parent, dataset);

CreateDatasetAsync(ProjectName, Dataset, CancellationToken)

Create a new dataset for the specified project.

Declaration
public virtual Task<Dataset> CreateDatasetAsync(ProjectName parent, Dataset dataset, CancellationToken cancellationToken)
Parameters
Type Name Description
ProjectName parent

Required. Parent project that will own the dataset. Format: projects/{$project_number}

Dataset dataset

Required. The dataset version to create.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Dataset dataset = new Dataset();
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.CreateDatasetAsync(parent, dataset);

CreateDatasetAsync(CreateDatasetRequest, CallSettings)

Create a new dataset for the specified project.

Declaration
public virtual Task<Dataset> CreateDatasetAsync(CreateDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateDatasetRequest request

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
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
CreateDatasetRequest request = new CreateDatasetRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Dataset = new Dataset(),
};
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.CreateDatasetAsync(request);

CreateDatasetAsync(CreateDatasetRequest, CancellationToken)

Create a new dataset for the specified project.

Declaration
public virtual Task<Dataset> CreateDatasetAsync(CreateDatasetRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
CreateDatasetRequest request

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

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
CreateDatasetRequest request = new CreateDatasetRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Dataset = new Dataset(),
};
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.CreateDatasetAsync(request);

CreateDatasetAsync(string, Dataset, CallSettings)

Create a new dataset for the specified project.

Declaration
public virtual Task<Dataset> CreateDatasetAsync(string parent, Dataset dataset, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. Parent project that will own the dataset. Format: projects/{$project_number}

Dataset dataset

Required. The dataset version to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Dataset dataset = new Dataset();
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.CreateDatasetAsync(parent, dataset);

CreateDatasetAsync(string, Dataset, CancellationToken)

Create a new dataset for the specified project.

Declaration
public virtual Task<Dataset> CreateDatasetAsync(string parent, Dataset dataset, CancellationToken cancellationToken)
Parameters
Type Name Description
string parent

Required. Parent project that will own the dataset. Format: projects/{$project_number}

Dataset dataset

Required. The dataset version to create.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Dataset dataset = new Dataset();
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.CreateDatasetAsync(parent, dataset);

DeleteDataset(DatasetName, CallSettings)

Delete the specified dataset and optionally all its corresponding versions.

Declaration
public virtual void DeleteDataset(DatasetName name, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. Format: projects/${project}/datasets/{dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
mapsPlatformDatasetsV1AlphaClient.DeleteDataset(name);

DeleteDataset(DeleteDatasetRequest, CallSettings)

Delete the specified dataset and optionally all its corresponding versions.

Declaration
public virtual void DeleteDataset(DeleteDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteDatasetRequest request

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
DeleteDatasetRequest request = new DeleteDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    Force = false,
};
// Make the request
mapsPlatformDatasetsV1AlphaClient.DeleteDataset(request);

DeleteDataset(string, CallSettings)

Delete the specified dataset and optionally all its corresponding versions.

Declaration
public virtual void DeleteDataset(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. Format: projects/${project}/datasets/{dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
mapsPlatformDatasetsV1AlphaClient.DeleteDataset(name);

DeleteDatasetAsync(DatasetName, CallSettings)

Delete the specified dataset and optionally all its corresponding versions.

Declaration
public virtual Task DeleteDatasetAsync(DatasetName name, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. Format: projects/${project}/datasets/{dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
await mapsPlatformDatasetsV1AlphaClient.DeleteDatasetAsync(name);

DeleteDatasetAsync(DatasetName, CancellationToken)

Delete the specified dataset and optionally all its corresponding versions.

Declaration
public virtual Task DeleteDatasetAsync(DatasetName name, CancellationToken cancellationToken)
Parameters
Type Name Description
DatasetName name

Required. Format: projects/${project}/datasets/{dataset_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
await mapsPlatformDatasetsV1AlphaClient.DeleteDatasetAsync(name);

DeleteDatasetAsync(DeleteDatasetRequest, CallSettings)

Delete the specified dataset and optionally all its corresponding versions.

Declaration
public virtual Task DeleteDatasetAsync(DeleteDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteDatasetRequest request

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
Task

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
DeleteDatasetRequest request = new DeleteDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    Force = false,
};
// Make the request
await mapsPlatformDatasetsV1AlphaClient.DeleteDatasetAsync(request);

DeleteDatasetAsync(DeleteDatasetRequest, CancellationToken)

Delete the specified dataset and optionally all its corresponding versions.

Declaration
public virtual Task DeleteDatasetAsync(DeleteDatasetRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
DeleteDatasetRequest request

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

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
DeleteDatasetRequest request = new DeleteDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    Force = false,
};
// Make the request
await mapsPlatformDatasetsV1AlphaClient.DeleteDatasetAsync(request);

DeleteDatasetAsync(string, CallSettings)

Delete the specified dataset and optionally all its corresponding versions.

Declaration
public virtual Task DeleteDatasetAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. Format: projects/${project}/datasets/{dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
await mapsPlatformDatasetsV1AlphaClient.DeleteDatasetAsync(name);

DeleteDatasetAsync(string, CancellationToken)

Delete the specified dataset and optionally all its corresponding versions.

Declaration
public virtual Task DeleteDatasetAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
string name

Required. Format: projects/${project}/datasets/{dataset_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
await mapsPlatformDatasetsV1AlphaClient.DeleteDatasetAsync(name);

DeleteDatasetVersion(DatasetName, CallSettings)

Delete a specific version of the dataset.

Declaration
public virtual void DeleteDatasetVersion(DatasetName name, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. Format: projects/${project}/datasets/{dataset_id}@{version-id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
mapsPlatformDatasetsV1AlphaClient.DeleteDatasetVersion(name);

DeleteDatasetVersion(DeleteDatasetVersionRequest, CallSettings)

Delete a specific version of the dataset.

Declaration
public virtual void DeleteDatasetVersion(DeleteDatasetVersionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteDatasetVersionRequest request

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
DeleteDatasetVersionRequest request = new DeleteDatasetVersionRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
mapsPlatformDatasetsV1AlphaClient.DeleteDatasetVersion(request);

DeleteDatasetVersion(string, CallSettings)

Delete a specific version of the dataset.

Declaration
public virtual void DeleteDatasetVersion(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. Format: projects/${project}/datasets/{dataset_id}@{version-id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
mapsPlatformDatasetsV1AlphaClient.DeleteDatasetVersion(name);

DeleteDatasetVersionAsync(DatasetName, CallSettings)

Delete a specific version of the dataset.

Declaration
public virtual Task DeleteDatasetVersionAsync(DatasetName name, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. Format: projects/${project}/datasets/{dataset_id}@{version-id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
await mapsPlatformDatasetsV1AlphaClient.DeleteDatasetVersionAsync(name);

DeleteDatasetVersionAsync(DatasetName, CancellationToken)

Delete a specific version of the dataset.

Declaration
public virtual Task DeleteDatasetVersionAsync(DatasetName name, CancellationToken cancellationToken)
Parameters
Type Name Description
DatasetName name

Required. Format: projects/${project}/datasets/{dataset_id}@{version-id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
await mapsPlatformDatasetsV1AlphaClient.DeleteDatasetVersionAsync(name);

DeleteDatasetVersionAsync(DeleteDatasetVersionRequest, CallSettings)

Delete a specific version of the dataset.

Declaration
public virtual Task DeleteDatasetVersionAsync(DeleteDatasetVersionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteDatasetVersionRequest request

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
Task

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
DeleteDatasetVersionRequest request = new DeleteDatasetVersionRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
await mapsPlatformDatasetsV1AlphaClient.DeleteDatasetVersionAsync(request);

DeleteDatasetVersionAsync(DeleteDatasetVersionRequest, CancellationToken)

Delete a specific version of the dataset.

Declaration
public virtual Task DeleteDatasetVersionAsync(DeleteDatasetVersionRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
DeleteDatasetVersionRequest request

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

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
DeleteDatasetVersionRequest request = new DeleteDatasetVersionRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
await mapsPlatformDatasetsV1AlphaClient.DeleteDatasetVersionAsync(request);

DeleteDatasetVersionAsync(string, CallSettings)

Delete a specific version of the dataset.

Declaration
public virtual Task DeleteDatasetVersionAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. Format: projects/${project}/datasets/{dataset_id}@{version-id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
await mapsPlatformDatasetsV1AlphaClient.DeleteDatasetVersionAsync(name);

DeleteDatasetVersionAsync(string, CancellationToken)

Delete a specific version of the dataset.

Declaration
public virtual Task DeleteDatasetVersionAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
string name

Required. Format: projects/${project}/datasets/{dataset_id}@{version-id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
await mapsPlatformDatasetsV1AlphaClient.DeleteDatasetVersionAsync(name);

GetDataset(DatasetName, CallSettings)

Get the published or latest version of the dataset.

Declaration
public virtual Dataset GetDataset(DatasetName name, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. Resource name. Can also fetch a specified version projects/{project}/datasets/{dataset_id} projects/{project}/datasets/{dataset_id}@{version-id}

In order to retrieve a previous version of the dataset, also provide the version ID. Example: projects/123/datasets/assisted-driving-preferences@c7cfa2a8

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
Dataset response = mapsPlatformDatasetsV1AlphaClient.GetDataset(name);

GetDataset(GetDatasetRequest, CallSettings)

Get the published or latest version of the dataset.

Declaration
public virtual Dataset GetDataset(GetDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDatasetRequest request

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.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
GetDatasetRequest request = new GetDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    PublishedUsage = Usage.Unspecified,
};
// Make the request
Dataset response = mapsPlatformDatasetsV1AlphaClient.GetDataset(request);

GetDataset(string, CallSettings)

Get the published or latest version of the dataset.

Declaration
public virtual Dataset GetDataset(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. Resource name. Can also fetch a specified version projects/{project}/datasets/{dataset_id} projects/{project}/datasets/{dataset_id}@{version-id}

In order to retrieve a previous version of the dataset, also provide the version ID. Example: projects/123/datasets/assisted-driving-preferences@c7cfa2a8

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
Dataset response = mapsPlatformDatasetsV1AlphaClient.GetDataset(name);

GetDatasetAsync(DatasetName, CallSettings)

Get the published or latest version of the dataset.

Declaration
public virtual Task<Dataset> GetDatasetAsync(DatasetName name, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. Resource name. Can also fetch a specified version projects/{project}/datasets/{dataset_id} projects/{project}/datasets/{dataset_id}@{version-id}

In order to retrieve a previous version of the dataset, also provide the version ID. Example: projects/123/datasets/assisted-driving-preferences@c7cfa2a8

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.GetDatasetAsync(name);

GetDatasetAsync(DatasetName, CancellationToken)

Get the published or latest version of the dataset.

Declaration
public virtual Task<Dataset> GetDatasetAsync(DatasetName name, CancellationToken cancellationToken)
Parameters
Type Name Description
DatasetName name

Required. Resource name. Can also fetch a specified version projects/{project}/datasets/{dataset_id} projects/{project}/datasets/{dataset_id}@{version-id}

In order to retrieve a previous version of the dataset, also provide the version ID. Example: projects/123/datasets/assisted-driving-preferences@c7cfa2a8

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.GetDatasetAsync(name);

GetDatasetAsync(GetDatasetRequest, CallSettings)

Get the published or latest version of the dataset.

Declaration
public virtual Task<Dataset> GetDatasetAsync(GetDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDatasetRequest request

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
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
GetDatasetRequest request = new GetDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    PublishedUsage = Usage.Unspecified,
};
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.GetDatasetAsync(request);

GetDatasetAsync(GetDatasetRequest, CancellationToken)

Get the published or latest version of the dataset.

Declaration
public virtual Task<Dataset> GetDatasetAsync(GetDatasetRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetDatasetRequest request

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

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
GetDatasetRequest request = new GetDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    PublishedUsage = Usage.Unspecified,
};
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.GetDatasetAsync(request);

GetDatasetAsync(string, CallSettings)

Get the published or latest version of the dataset.

Declaration
public virtual Task<Dataset> GetDatasetAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. Resource name. Can also fetch a specified version projects/{project}/datasets/{dataset_id} projects/{project}/datasets/{dataset_id}@{version-id}

In order to retrieve a previous version of the dataset, also provide the version ID. Example: projects/123/datasets/assisted-driving-preferences@c7cfa2a8

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.GetDatasetAsync(name);

GetDatasetAsync(string, CancellationToken)

Get the published or latest version of the dataset.

Declaration
public virtual Task<Dataset> GetDatasetAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
string name

Required. Resource name. Can also fetch a specified version projects/{project}/datasets/{dataset_id} projects/{project}/datasets/{dataset_id}@{version-id}

In order to retrieve a previous version of the dataset, also provide the version ID. Example: projects/123/datasets/assisted-driving-preferences@c7cfa2a8

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.GetDatasetAsync(name);

ListDatasetVersions(DatasetName, string, int?, CallSettings)

List all the versions of a dataset.

Declaration
public virtual PagedEnumerable<ListDatasetVersionsResponse, Dataset> ListDatasetVersions(DatasetName name, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. The name of the dataset to list all the versions for.

string pageToken

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

int? pageSize

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
PagedEnumerable<ListDatasetVersionsResponse, Dataset>

A pageable sequence of Dataset resources.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
PagedEnumerable<ListDatasetVersionsResponse, Dataset> response = mapsPlatformDatasetsV1AlphaClient.ListDatasetVersions(name);

// 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 (ListDatasetVersionsResponse 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;

ListDatasetVersions(ListDatasetVersionsRequest, CallSettings)

List all the versions of a dataset.

Declaration
public virtual PagedEnumerable<ListDatasetVersionsResponse, Dataset> ListDatasetVersions(ListDatasetVersionsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListDatasetVersionsRequest request

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
PagedEnumerable<ListDatasetVersionsResponse, Dataset>

A pageable sequence of Dataset resources.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
ListDatasetVersionsRequest request = new ListDatasetVersionsRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
PagedEnumerable<ListDatasetVersionsResponse, Dataset> response = mapsPlatformDatasetsV1AlphaClient.ListDatasetVersions(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 (ListDatasetVersionsResponse 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;

ListDatasetVersions(string, string, int?, CallSettings)

List all the versions of a dataset.

Declaration
public virtual PagedEnumerable<ListDatasetVersionsResponse, Dataset> ListDatasetVersions(string name, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The name of the dataset to list all the versions for.

string pageToken

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

int? pageSize

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
PagedEnumerable<ListDatasetVersionsResponse, Dataset>

A pageable sequence of Dataset resources.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
PagedEnumerable<ListDatasetVersionsResponse, Dataset> response = mapsPlatformDatasetsV1AlphaClient.ListDatasetVersions(name);

// 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 (ListDatasetVersionsResponse 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;

ListDatasetVersionsAsync(DatasetName, string, int?, CallSettings)

List all the versions of a dataset.

Declaration
public virtual PagedAsyncEnumerable<ListDatasetVersionsResponse, Dataset> ListDatasetVersionsAsync(DatasetName name, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. The name of the dataset to list all the versions for.

string pageToken

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

int? pageSize

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
PagedAsyncEnumerable<ListDatasetVersionsResponse, Dataset>

A pageable asynchronous sequence of Dataset resources.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
PagedAsyncEnumerable<ListDatasetVersionsResponse, Dataset> response = mapsPlatformDatasetsV1AlphaClient.ListDatasetVersionsAsync(name);

// 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((ListDatasetVersionsResponse 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;

ListDatasetVersionsAsync(ListDatasetVersionsRequest, CallSettings)

List all the versions of a dataset.

Declaration
public virtual PagedAsyncEnumerable<ListDatasetVersionsResponse, Dataset> ListDatasetVersionsAsync(ListDatasetVersionsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListDatasetVersionsRequest request

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
PagedAsyncEnumerable<ListDatasetVersionsResponse, Dataset>

A pageable asynchronous sequence of Dataset resources.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
ListDatasetVersionsRequest request = new ListDatasetVersionsRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
PagedAsyncEnumerable<ListDatasetVersionsResponse, Dataset> response = mapsPlatformDatasetsV1AlphaClient.ListDatasetVersionsAsync(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((ListDatasetVersionsResponse 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;

ListDatasetVersionsAsync(string, string, int?, CallSettings)

List all the versions of a dataset.

Declaration
public virtual PagedAsyncEnumerable<ListDatasetVersionsResponse, Dataset> ListDatasetVersionsAsync(string name, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The name of the dataset to list all the versions for.

string pageToken

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

int? pageSize

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
PagedAsyncEnumerable<ListDatasetVersionsResponse, Dataset>

A pageable asynchronous sequence of Dataset resources.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
PagedAsyncEnumerable<ListDatasetVersionsResponse, Dataset> response = mapsPlatformDatasetsV1AlphaClient.ListDatasetVersionsAsync(name);

// 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((ListDatasetVersionsResponse 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;

ListDatasets(ProjectName, string, int?, CallSettings)

List all the datasets for the specified project.

Declaration
public virtual PagedEnumerable<ListDatasetsResponse, Dataset> ListDatasets(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. The name of the project to list all the datasets for.

string pageToken

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

int? pageSize

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
PagedEnumerable<ListDatasetsResponse, Dataset>

A pageable sequence of Dataset resources.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedEnumerable<ListDatasetsResponse, Dataset> response = mapsPlatformDatasetsV1AlphaClient.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)

List all the datasets for the specified project.

Declaration
public virtual PagedEnumerable<ListDatasetsResponse, Dataset> ListDatasets(ListDatasetsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListDatasetsRequest request

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
PagedEnumerable<ListDatasetsResponse, Dataset>

A pageable sequence of Dataset resources.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
ListDatasetsRequest request = new ListDatasetsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
PagedEnumerable<ListDatasetsResponse, Dataset> response = mapsPlatformDatasetsV1AlphaClient.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)

List all the datasets for the specified project.

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

Required. The name of the project to list all the datasets for.

string pageToken

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

int? pageSize

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
PagedEnumerable<ListDatasetsResponse, Dataset>

A pageable sequence of Dataset resources.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedEnumerable<ListDatasetsResponse, Dataset> response = mapsPlatformDatasetsV1AlphaClient.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(ProjectName, string, int?, CallSettings)

List all the datasets for the specified project.

Declaration
public virtual PagedAsyncEnumerable<ListDatasetsResponse, Dataset> ListDatasetsAsync(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. The name of the project to list all the datasets for.

string pageToken

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

int? pageSize

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
PagedAsyncEnumerable<ListDatasetsResponse, Dataset>

A pageable asynchronous sequence of Dataset resources.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedAsyncEnumerable<ListDatasetsResponse, Dataset> response = mapsPlatformDatasetsV1AlphaClient.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)

List all the datasets for the specified project.

Declaration
public virtual PagedAsyncEnumerable<ListDatasetsResponse, Dataset> ListDatasetsAsync(ListDatasetsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListDatasetsRequest request

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
PagedAsyncEnumerable<ListDatasetsResponse, Dataset>

A pageable asynchronous sequence of Dataset resources.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
ListDatasetsRequest request = new ListDatasetsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
PagedAsyncEnumerable<ListDatasetsResponse, Dataset> response = mapsPlatformDatasetsV1AlphaClient.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)

List all the datasets for the specified project.

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

Required. The name of the project to list all the datasets for.

string pageToken

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

int? pageSize

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
PagedAsyncEnumerable<ListDatasetsResponse, Dataset>

A pageable asynchronous sequence of Dataset resources.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedAsyncEnumerable<ListDatasetsResponse, Dataset> response = mapsPlatformDatasetsV1AlphaClient.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;

ShutdownDefaultChannelsAsync()

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

Declaration
public static Task ShutdownDefaultChannelsAsync()
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.

UpdateDatasetMetadata(Dataset, FieldMask, CallSettings)

Update the metadata for the dataset. To update the data use: UploadDataset.

Declaration
public virtual Dataset UpdateDatasetMetadata(Dataset dataset, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
Dataset dataset

Required. The dataset to update. The dataset's name is used to identify the dataset to be updated. The name has the format: projects/{project}/datasets/{dataset_id}

FieldMask updateMask

The list of fields to be updated. Support the value "*" for full replacement.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
Dataset dataset = new Dataset();
FieldMask updateMask = new FieldMask();
// Make the request
Dataset response = mapsPlatformDatasetsV1AlphaClient.UpdateDatasetMetadata(dataset, updateMask);

UpdateDatasetMetadata(UpdateDatasetMetadataRequest, CallSettings)

Update the metadata for the dataset. To update the data use: UploadDataset.

Declaration
public virtual Dataset UpdateDatasetMetadata(UpdateDatasetMetadataRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateDatasetMetadataRequest request

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.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = MapsPlatformDatasetsV1AlphaClient.Create();
// Initialize request argument(s)
UpdateDatasetMetadataRequest request = new UpdateDatasetMetadataRequest
{
    Dataset = new Dataset(),
    UpdateMask = new FieldMask(),
};
// Make the request
Dataset response = mapsPlatformDatasetsV1AlphaClient.UpdateDatasetMetadata(request);

UpdateDatasetMetadataAsync(Dataset, FieldMask, CallSettings)

Update the metadata for the dataset. To update the data use: UploadDataset.

Declaration
public virtual Task<Dataset> UpdateDatasetMetadataAsync(Dataset dataset, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
Dataset dataset

Required. The dataset to update. The dataset's name is used to identify the dataset to be updated. The name has the format: projects/{project}/datasets/{dataset_id}

FieldMask updateMask

The list of fields to be updated. Support the value "*" for full replacement.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
Dataset dataset = new Dataset();
FieldMask updateMask = new FieldMask();
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.UpdateDatasetMetadataAsync(dataset, updateMask);

UpdateDatasetMetadataAsync(Dataset, FieldMask, CancellationToken)

Update the metadata for the dataset. To update the data use: UploadDataset.

Declaration
public virtual Task<Dataset> UpdateDatasetMetadataAsync(Dataset dataset, FieldMask updateMask, CancellationToken cancellationToken)
Parameters
Type Name Description
Dataset dataset

Required. The dataset to update. The dataset's name is used to identify the dataset to be updated. The name has the format: projects/{project}/datasets/{dataset_id}

FieldMask updateMask

The list of fields to be updated. Support the value "*" for full replacement.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
Dataset dataset = new Dataset();
FieldMask updateMask = new FieldMask();
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.UpdateDatasetMetadataAsync(dataset, updateMask);

UpdateDatasetMetadataAsync(UpdateDatasetMetadataRequest, CallSettings)

Update the metadata for the dataset. To update the data use: UploadDataset.

Declaration
public virtual Task<Dataset> UpdateDatasetMetadataAsync(UpdateDatasetMetadataRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateDatasetMetadataRequest request

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
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
UpdateDatasetMetadataRequest request = new UpdateDatasetMetadataRequest
{
    Dataset = new Dataset(),
    UpdateMask = new FieldMask(),
};
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.UpdateDatasetMetadataAsync(request);

UpdateDatasetMetadataAsync(UpdateDatasetMetadataRequest, CancellationToken)

Update the metadata for the dataset. To update the data use: UploadDataset.

Declaration
public virtual Task<Dataset> UpdateDatasetMetadataAsync(UpdateDatasetMetadataRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
UpdateDatasetMetadataRequest request

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

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
MapsPlatformDatasetsV1AlphaClient mapsPlatformDatasetsV1AlphaClient = await MapsPlatformDatasetsV1AlphaClient.CreateAsync();
// Initialize request argument(s)
UpdateDatasetMetadataRequest request = new UpdateDatasetMetadataRequest
{
    Dataset = new Dataset(),
    UpdateMask = new FieldMask(),
};
// Make the request
Dataset response = await mapsPlatformDatasetsV1AlphaClient.UpdateDatasetMetadataAsync(request);
In this article
Back to top Generated by DocFX