Class MapsPlatformDatasetsClient

MapsPlatformDatasets client wrapper, for convenient use.

Inheritance
object
MapsPlatformDatasetsClient
MapsPlatformDatasetsClientImpl
Inherited Members
Namespace: Google.Maps.MapsPlatformDatasets.V1
Assembly: Google.Maps.MapsPlatformDatasets.V1.dll
Syntax
public abstract class MapsPlatformDatasetsClient
Remarks

Service definition for the Maps Platform Datasets API.

Properties

DefaultEndpoint

The default endpoint for the MapsPlatformDatasets 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 MapsPlatformDatasets scopes.

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

The default MapsPlatformDatasets scopes are:

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

GrpcClient

The underlying gRPC MapsPlatformDatasets client

Declaration
public virtual MapsPlatformDatasets.MapsPlatformDatasetsClient GrpcClient { get; }
Property Value
Type Description
MapsPlatformDatasets.MapsPlatformDatasetsClient

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 MapsPlatformDatasetsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use MapsPlatformDatasetsClientBuilder.

Declaration
public static MapsPlatformDatasetsClient Create()
Returns
Type Description
MapsPlatformDatasetsClient

The created MapsPlatformDatasetsClient.

CreateAsync(CancellationToken)

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

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

The CancellationToken to use while creating the client.
Returns
Type Description
Task<MapsPlatformDatasetsClient>

The task representing the created MapsPlatformDatasetsClient.

CreateDataset(ProjectName, Dataset, CallSettings)

Creates 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}
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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = MapsPlatformDatasetsClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Dataset dataset = new Dataset();
// Make the request
Dataset response = mapsPlatformDatasetsClient.CreateDataset(parent, dataset);

CreateDataset(CreateDatasetRequest, CallSettings)

Creates 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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = MapsPlatformDatasetsClient.Create();
// Initialize request argument(s)
CreateDatasetRequest request = new CreateDatasetRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Dataset = new Dataset(),
};
// Make the request
Dataset response = mapsPlatformDatasetsClient.CreateDataset(request);

CreateDataset(string, Dataset, CallSettings)

Creates 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}
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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = MapsPlatformDatasetsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Dataset dataset = new Dataset();
// Make the request
Dataset response = mapsPlatformDatasetsClient.CreateDataset(parent, dataset);

CreateDatasetAsync(ProjectName, Dataset, CallSettings)

Creates 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}
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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Dataset dataset = new Dataset();
// Make the request
Dataset response = await mapsPlatformDatasetsClient.CreateDatasetAsync(parent, dataset);

CreateDatasetAsync(ProjectName, Dataset, CancellationToken)

Creates 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}
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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Dataset dataset = new Dataset();
// Make the request
Dataset response = await mapsPlatformDatasetsClient.CreateDatasetAsync(parent, dataset);

CreateDatasetAsync(CreateDatasetRequest, CallSettings)

Creates 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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
CreateDatasetRequest request = new CreateDatasetRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Dataset = new Dataset(),
};
// Make the request
Dataset response = await mapsPlatformDatasetsClient.CreateDatasetAsync(request);

CreateDatasetAsync(CreateDatasetRequest, CancellationToken)

Creates 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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
CreateDatasetRequest request = new CreateDatasetRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Dataset = new Dataset(),
};
// Make the request
Dataset response = await mapsPlatformDatasetsClient.CreateDatasetAsync(request);

CreateDatasetAsync(string, Dataset, CallSettings)

Creates 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}
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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Dataset dataset = new Dataset();
// Make the request
Dataset response = await mapsPlatformDatasetsClient.CreateDatasetAsync(parent, dataset);

CreateDatasetAsync(string, Dataset, CancellationToken)

Creates 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}
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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Dataset dataset = new Dataset();
// Make the request
Dataset response = await mapsPlatformDatasetsClient.CreateDatasetAsync(parent, dataset);

DeleteDataset(DatasetName, CallSettings)

Deletes the specified dataset.

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

Required. The name of the dataset to delete. Format: projects/{project}/datasets/{dataset_id}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Sample code
// Create client
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = MapsPlatformDatasetsClient.Create();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
mapsPlatformDatasetsClient.DeleteDataset(name);

DeleteDataset(DeleteDatasetRequest, CallSettings)

Deletes the specified dataset.

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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = MapsPlatformDatasetsClient.Create();
// Initialize request argument(s)
DeleteDatasetRequest request = new DeleteDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
mapsPlatformDatasetsClient.DeleteDataset(request);

DeleteDataset(string, CallSettings)

Deletes the specified dataset.

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

Required. The name of the dataset to delete. Format: projects/{project}/datasets/{dataset_id}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Sample code
// Create client
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = MapsPlatformDatasetsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
mapsPlatformDatasetsClient.DeleteDataset(name);

DeleteDatasetAsync(DatasetName, CallSettings)

Deletes the specified dataset.

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

Required. The name of the dataset to delete. 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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
await mapsPlatformDatasetsClient.DeleteDatasetAsync(name);

DeleteDatasetAsync(DatasetName, CancellationToken)

Deletes the specified dataset.

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

Required. The name of the dataset to delete. 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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
await mapsPlatformDatasetsClient.DeleteDatasetAsync(name);

DeleteDatasetAsync(DeleteDatasetRequest, CallSettings)

Deletes the specified dataset.

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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
DeleteDatasetRequest request = new DeleteDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
await mapsPlatformDatasetsClient.DeleteDatasetAsync(request);

DeleteDatasetAsync(DeleteDatasetRequest, CancellationToken)

Deletes the specified dataset.

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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
DeleteDatasetRequest request = new DeleteDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
await mapsPlatformDatasetsClient.DeleteDatasetAsync(request);

DeleteDatasetAsync(string, CallSettings)

Deletes the specified dataset.

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

Required. The name of the dataset to delete. 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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
await mapsPlatformDatasetsClient.DeleteDatasetAsync(name);

DeleteDatasetAsync(string, CancellationToken)

Deletes the specified dataset.

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

Required. The name of the dataset to delete. 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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
await mapsPlatformDatasetsClient.DeleteDatasetAsync(name);

FetchDatasetErrors(DatasetName, string, int?, CallSettings)

Gets all the errors of a dataset.

Declaration
public virtual PagedEnumerable<FetchDatasetErrorsResponse, Status> FetchDatasetErrors(DatasetName dataset, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName dataset

Required. The name of the dataset to list all the errors for. Format: projects/{project}/datasets/{dataset_id}
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<FetchDatasetErrorsResponse, Status>

A pageable sequence of Status resources.
Sample code
// Create client
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = MapsPlatformDatasetsClient.Create();
// Initialize request argument(s)
DatasetName dataset = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
PagedEnumerable<FetchDatasetErrorsResponse, gr::Status> response = mapsPlatformDatasetsClient.FetchDatasetErrors(dataset);

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

FetchDatasetErrors(FetchDatasetErrorsRequest, CallSettings)

Gets all the errors of a dataset.

Declaration
public virtual PagedEnumerable<FetchDatasetErrorsResponse, Status> FetchDatasetErrors(FetchDatasetErrorsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
FetchDatasetErrorsRequest 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<FetchDatasetErrorsResponse, Status>

A pageable sequence of Status resources.
Sample code
// Create client
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = MapsPlatformDatasetsClient.Create();
// Initialize request argument(s)
FetchDatasetErrorsRequest request = new FetchDatasetErrorsRequest
{
    DatasetAsDatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
PagedEnumerable<FetchDatasetErrorsResponse, gr::Status> response = mapsPlatformDatasetsClient.FetchDatasetErrors(request);

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

FetchDatasetErrors(string, string, int?, CallSettings)

Gets all the errors of a dataset.

Declaration
public virtual PagedEnumerable<FetchDatasetErrorsResponse, Status> FetchDatasetErrors(string dataset, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string dataset

Required. The name of the dataset to list all the errors for. Format: projects/{project}/datasets/{dataset_id}
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<FetchDatasetErrorsResponse, Status>

A pageable sequence of Status resources.
Sample code
// Create client
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = MapsPlatformDatasetsClient.Create();
// Initialize request argument(s)
string dataset = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
PagedEnumerable<FetchDatasetErrorsResponse, gr::Status> response = mapsPlatformDatasetsClient.FetchDatasetErrors(dataset);

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

FetchDatasetErrorsAsync(DatasetName, string, int?, CallSettings)

Gets all the errors of a dataset.

Declaration
public virtual PagedAsyncEnumerable<FetchDatasetErrorsResponse, Status> FetchDatasetErrorsAsync(DatasetName dataset, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName dataset

Required. The name of the dataset to list all the errors for. Format: projects/{project}/datasets/{dataset_id}
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<FetchDatasetErrorsResponse, Status>

A pageable asynchronous sequence of Status resources.
Sample code
// Create client
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
DatasetName dataset = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
PagedAsyncEnumerable<FetchDatasetErrorsResponse, gr::Status> response = mapsPlatformDatasetsClient.FetchDatasetErrorsAsync(dataset);

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

FetchDatasetErrorsAsync(FetchDatasetErrorsRequest, CallSettings)

Gets all the errors of a dataset.

Declaration
public virtual PagedAsyncEnumerable<FetchDatasetErrorsResponse, Status> FetchDatasetErrorsAsync(FetchDatasetErrorsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
FetchDatasetErrorsRequest 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<FetchDatasetErrorsResponse, Status>

A pageable asynchronous sequence of Status resources.
Sample code
// Create client
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
FetchDatasetErrorsRequest request = new FetchDatasetErrorsRequest
{
    DatasetAsDatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
PagedAsyncEnumerable<FetchDatasetErrorsResponse, gr::Status> response = mapsPlatformDatasetsClient.FetchDatasetErrorsAsync(request);

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

FetchDatasetErrorsAsync(string, string, int?, CallSettings)

Gets all the errors of a dataset.

Declaration
public virtual PagedAsyncEnumerable<FetchDatasetErrorsResponse, Status> FetchDatasetErrorsAsync(string dataset, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string dataset

Required. The name of the dataset to list all the errors for. Format: projects/{project}/datasets/{dataset_id}
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<FetchDatasetErrorsResponse, Status>

A pageable asynchronous sequence of Status resources.
Sample code
// Create client
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
string dataset = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
PagedAsyncEnumerable<FetchDatasetErrorsResponse, gr::Status> response = mapsPlatformDatasetsClient.FetchDatasetErrorsAsync(dataset);

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

GetDataset(DatasetName, CallSettings)

Gets the dataset.

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

Required. Resource name. Format: projects/{project}/datasets/{dataset_id}

Can also fetch some special versions by appending "@" and a tag. Format: projects/{project}/datasets/{dataset_id}@{tag}

Tag "active": The info of the latest completed version will be included, and NOT_FOUND if the dataset does not have one.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Dataset

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

GetDataset(GetDatasetRequest, CallSettings)

Gets 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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = MapsPlatformDatasetsClient.Create();
// Initialize request argument(s)
GetDatasetRequest request = new GetDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
Dataset response = mapsPlatformDatasetsClient.GetDataset(request);

GetDataset(string, CallSettings)

Gets the dataset.

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

Required. Resource name. Format: projects/{project}/datasets/{dataset_id}

Can also fetch some special versions by appending "@" and a tag. Format: projects/{project}/datasets/{dataset_id}@{tag}

Tag "active": The info of the latest completed version will be included, and NOT_FOUND if the dataset does not have one.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Dataset

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

GetDatasetAsync(DatasetName, CallSettings)

Gets the dataset.

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

Required. Resource name. Format: projects/{project}/datasets/{dataset_id}

Can also fetch some special versions by appending "@" and a tag. Format: projects/{project}/datasets/{dataset_id}@{tag}

Tag "active": The info of the latest completed version will be included, and NOT_FOUND if the dataset does not have one.
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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
Dataset response = await mapsPlatformDatasetsClient.GetDatasetAsync(name);

GetDatasetAsync(DatasetName, CancellationToken)

Gets the dataset.

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

Required. Resource name. Format: projects/{project}/datasets/{dataset_id}

Can also fetch some special versions by appending "@" and a tag. Format: projects/{project}/datasets/{dataset_id}@{tag}

Tag "active": The info of the latest completed version will be included, and NOT_FOUND if the dataset does not have one.
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<Dataset>

A Task containing the RPC response.
Sample code
// Create client
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
Dataset response = await mapsPlatformDatasetsClient.GetDatasetAsync(name);

GetDatasetAsync(GetDatasetRequest, CallSettings)

Gets 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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
GetDatasetRequest request = new GetDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
Dataset response = await mapsPlatformDatasetsClient.GetDatasetAsync(request);

GetDatasetAsync(GetDatasetRequest, CancellationToken)

Gets 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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
GetDatasetRequest request = new GetDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
Dataset response = await mapsPlatformDatasetsClient.GetDatasetAsync(request);

GetDatasetAsync(string, CallSettings)

Gets the dataset.

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

Required. Resource name. Format: projects/{project}/datasets/{dataset_id}

Can also fetch some special versions by appending "@" and a tag. Format: projects/{project}/datasets/{dataset_id}@{tag}

Tag "active": The info of the latest completed version will be included, and NOT_FOUND if the dataset does not have one.
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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
Dataset response = await mapsPlatformDatasetsClient.GetDatasetAsync(name);

GetDatasetAsync(string, CancellationToken)

Gets the dataset.

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

Required. Resource name. Format: projects/{project}/datasets/{dataset_id}

Can also fetch some special versions by appending "@" and a tag. Format: projects/{project}/datasets/{dataset_id}@{tag}

Tag "active": The info of the latest completed version will be included, and NOT_FOUND if the dataset does not have one.
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<Dataset>

A Task containing the RPC response.
Sample code
// Create client
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
Dataset response = await mapsPlatformDatasetsClient.GetDatasetAsync(name);

ListDatasets(ProjectName, string, int?, CallSettings)

Lists 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. Format: projects/{project}
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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = MapsPlatformDatasetsClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedEnumerable<ListDatasetsResponse, Dataset> response = mapsPlatformDatasetsClient.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)

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

Lists 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. Format: projects/{project}
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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = MapsPlatformDatasetsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedEnumerable<ListDatasetsResponse, Dataset> response = mapsPlatformDatasetsClient.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)

Lists 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. Format: projects/{project}
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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedAsyncEnumerable<ListDatasetsResponse, Dataset> response = mapsPlatformDatasetsClient.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)

Lists 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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
ListDatasetsRequest request = new ListDatasetsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Tag = "",
};
// Make the request
PagedAsyncEnumerable<ListDatasetsResponse, Dataset> response = mapsPlatformDatasetsClient.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)

Lists 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. Format: projects/{project}
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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedAsyncEnumerable<ListDatasetsResponse, Dataset> response = mapsPlatformDatasetsClient.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)

Updates the metadata for the dataset.

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

Required. Resource name of the dataset to update. Format: projects/{project}/datasets/{dataset_id}
FieldMask updateMask

The list of fields to be updated.

The value "*" is used for full replacement (default).
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Dataset

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

UpdateDatasetMetadata(UpdateDatasetMetadataRequest, CallSettings)

Updates the metadata for the dataset.

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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = MapsPlatformDatasetsClient.Create();
// Initialize request argument(s)
UpdateDatasetMetadataRequest request = new UpdateDatasetMetadataRequest
{
    Dataset = new Dataset(),
    UpdateMask = new FieldMask(),
};
// Make the request
Dataset response = mapsPlatformDatasetsClient.UpdateDatasetMetadata(request);

UpdateDatasetMetadataAsync(Dataset, FieldMask, CallSettings)

Updates the metadata for the dataset.

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

Required. Resource name of the dataset to update. Format: projects/{project}/datasets/{dataset_id}
FieldMask updateMask

The list of fields to be updated.

The value "*" is used for full replacement (default).
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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
Dataset dataset = new Dataset();
FieldMask updateMask = new FieldMask();
// Make the request
Dataset response = await mapsPlatformDatasetsClient.UpdateDatasetMetadataAsync(dataset, updateMask);

UpdateDatasetMetadataAsync(Dataset, FieldMask, CancellationToken)

Updates the metadata for the dataset.

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

Required. Resource name of the dataset to update. Format: projects/{project}/datasets/{dataset_id}
FieldMask updateMask

The list of fields to be updated.

The value "*" is used for full replacement (default).
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<Dataset>

A Task containing the RPC response.
Sample code
// Create client
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
Dataset dataset = new Dataset();
FieldMask updateMask = new FieldMask();
// Make the request
Dataset response = await mapsPlatformDatasetsClient.UpdateDatasetMetadataAsync(dataset, updateMask);

UpdateDatasetMetadataAsync(UpdateDatasetMetadataRequest, CallSettings)

Updates the metadata for the dataset.

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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
UpdateDatasetMetadataRequest request = new UpdateDatasetMetadataRequest
{
    Dataset = new Dataset(),
    UpdateMask = new FieldMask(),
};
// Make the request
Dataset response = await mapsPlatformDatasetsClient.UpdateDatasetMetadataAsync(request);

UpdateDatasetMetadataAsync(UpdateDatasetMetadataRequest, CancellationToken)

Updates the metadata for the dataset.

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
MapsPlatformDatasetsClient mapsPlatformDatasetsClient = await MapsPlatformDatasetsClient.CreateAsync();
// Initialize request argument(s)
UpdateDatasetMetadataRequest request = new UpdateDatasetMetadataRequest
{
    Dataset = new Dataset(),
    UpdateMask = new FieldMask(),
};
// Make the request
Dataset response = await mapsPlatformDatasetsClient.UpdateDatasetMetadataAsync(request);