Show / Hide Table of Contents

Class MapsPlatformDatasetsV1Alpha.MapsPlatformDatasetsV1AlphaClient

Client for MapsPlatformDatasetsV1Alpha

Inheritance
object
ClientBase
ClientBase<MapsPlatformDatasetsV1Alpha.MapsPlatformDatasetsV1AlphaClient>
MapsPlatformDatasetsV1Alpha.MapsPlatformDatasetsV1AlphaClient
Inherited Members
ClientBase<MapsPlatformDatasetsV1Alpha.MapsPlatformDatasetsV1AlphaClient>.WithHost(string)
ClientBase.CallInvoker
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Maps.MapsPlatformDatasets.V1Alpha
Assembly: Google.Maps.MapsPlatformDatasets.V1Alpha.dll
Syntax
public class MapsPlatformDatasetsV1Alpha.MapsPlatformDatasetsV1AlphaClient : ClientBase<MapsPlatformDatasetsV1Alpha.MapsPlatformDatasetsV1AlphaClient>

Constructors

MapsPlatformDatasetsV1AlphaClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration
protected MapsPlatformDatasetsV1AlphaClient()

MapsPlatformDatasetsV1AlphaClient(CallInvoker)

Creates a new client for MapsPlatformDatasetsV1Alpha that uses a custom CallInvoker.

Declaration
public MapsPlatformDatasetsV1AlphaClient(CallInvoker callInvoker)
Parameters
Type Name Description
CallInvoker callInvoker

The callInvoker to use to make remote calls.

MapsPlatformDatasetsV1AlphaClient(ChannelBase)

Creates a new client for MapsPlatformDatasetsV1Alpha

Declaration
public MapsPlatformDatasetsV1AlphaClient(ChannelBase channel)
Parameters
Type Name Description
ChannelBase channel

The channel to use to make remote calls.

MapsPlatformDatasetsV1AlphaClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration
protected MapsPlatformDatasetsV1AlphaClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration

The client configuration.

Methods

CreateDataset(CreateDatasetRequest, CallOptions)

Create a new dataset for the specified project.

Declaration
public virtual Dataset CreateDataset(CreateDatasetRequest request, CallOptions options)
Parameters
Type Name Description
CreateDatasetRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Dataset

The response received from the server.

CreateDataset(CreateDatasetRequest, Metadata, DateTime?, CancellationToken)

Create a new dataset for the specified project.

Declaration
public virtual Dataset CreateDataset(CreateDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateDatasetRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
Dataset

The response received from the server.

CreateDatasetAsync(CreateDatasetRequest, CallOptions)

Create a new dataset for the specified project.

Declaration
public virtual AsyncUnaryCall<Dataset> CreateDatasetAsync(CreateDatasetRequest request, CallOptions options)
Parameters
Type Name Description
CreateDatasetRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Dataset>

The call object.

CreateDatasetAsync(CreateDatasetRequest, Metadata, DateTime?, CancellationToken)

Create a new dataset for the specified project.

Declaration
public virtual AsyncUnaryCall<Dataset> CreateDatasetAsync(CreateDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateDatasetRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Dataset>

The call object.

DeleteDataset(DeleteDatasetRequest, CallOptions)

Delete the specified dataset and optionally all its corresponding versions.

Declaration
public virtual Empty DeleteDataset(DeleteDatasetRequest request, CallOptions options)
Parameters
Type Name Description
DeleteDatasetRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteDataset(DeleteDatasetRequest, Metadata, DateTime?, CancellationToken)

Delete the specified dataset and optionally all its corresponding versions.

Declaration
public virtual Empty DeleteDataset(DeleteDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DeleteDatasetRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
Empty

The response received from the server.

DeleteDatasetAsync(DeleteDatasetRequest, CallOptions)

Delete the specified dataset and optionally all its corresponding versions.

Declaration
public virtual AsyncUnaryCall<Empty> DeleteDatasetAsync(DeleteDatasetRequest request, CallOptions options)
Parameters
Type Name Description
DeleteDatasetRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Empty>

The call object.

DeleteDatasetAsync(DeleteDatasetRequest, Metadata, DateTime?, CancellationToken)

Delete the specified dataset and optionally all its corresponding versions.

Declaration
public virtual AsyncUnaryCall<Empty> DeleteDatasetAsync(DeleteDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DeleteDatasetRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Empty>

The call object.

DeleteDatasetVersion(DeleteDatasetVersionRequest, CallOptions)

Delete a specific version of the dataset.

Declaration
public virtual Empty DeleteDatasetVersion(DeleteDatasetVersionRequest request, CallOptions options)
Parameters
Type Name Description
DeleteDatasetVersionRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteDatasetVersion(DeleteDatasetVersionRequest, Metadata, DateTime?, CancellationToken)

Delete a specific version of the dataset.

Declaration
public virtual Empty DeleteDatasetVersion(DeleteDatasetVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DeleteDatasetVersionRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
Empty

The response received from the server.

DeleteDatasetVersionAsync(DeleteDatasetVersionRequest, CallOptions)

Delete a specific version of the dataset.

Declaration
public virtual AsyncUnaryCall<Empty> DeleteDatasetVersionAsync(DeleteDatasetVersionRequest request, CallOptions options)
Parameters
Type Name Description
DeleteDatasetVersionRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Empty>

The call object.

DeleteDatasetVersionAsync(DeleteDatasetVersionRequest, Metadata, DateTime?, CancellationToken)

Delete a specific version of the dataset.

Declaration
public virtual AsyncUnaryCall<Empty> DeleteDatasetVersionAsync(DeleteDatasetVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DeleteDatasetVersionRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Empty>

The call object.

GetDataset(GetDatasetRequest, CallOptions)

Get the published or latest version of the dataset.

Declaration
public virtual Dataset GetDataset(GetDatasetRequest request, CallOptions options)
Parameters
Type Name Description
GetDatasetRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Dataset

The response received from the server.

GetDataset(GetDatasetRequest, Metadata, DateTime?, CancellationToken)

Get the published or latest version of the dataset.

Declaration
public virtual Dataset GetDataset(GetDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetDatasetRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
Dataset

The response received from the server.

GetDatasetAsync(GetDatasetRequest, CallOptions)

Get the published or latest version of the dataset.

Declaration
public virtual AsyncUnaryCall<Dataset> GetDatasetAsync(GetDatasetRequest request, CallOptions options)
Parameters
Type Name Description
GetDatasetRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Dataset>

The call object.

GetDatasetAsync(GetDatasetRequest, Metadata, DateTime?, CancellationToken)

Get the published or latest version of the dataset.

Declaration
public virtual AsyncUnaryCall<Dataset> GetDatasetAsync(GetDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetDatasetRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Dataset>

The call object.

ListDatasetVersions(ListDatasetVersionsRequest, CallOptions)

List all the versions of a dataset.

Declaration
public virtual ListDatasetVersionsResponse ListDatasetVersions(ListDatasetVersionsRequest request, CallOptions options)
Parameters
Type Name Description
ListDatasetVersionsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
ListDatasetVersionsResponse

The response received from the server.

ListDatasetVersions(ListDatasetVersionsRequest, Metadata, DateTime?, CancellationToken)

List all the versions of a dataset.

Declaration
public virtual ListDatasetVersionsResponse ListDatasetVersions(ListDatasetVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListDatasetVersionsRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
ListDatasetVersionsResponse

The response received from the server.

ListDatasetVersionsAsync(ListDatasetVersionsRequest, CallOptions)

List all the versions of a dataset.

Declaration
public virtual AsyncUnaryCall<ListDatasetVersionsResponse> ListDatasetVersionsAsync(ListDatasetVersionsRequest request, CallOptions options)
Parameters
Type Name Description
ListDatasetVersionsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListDatasetVersionsResponse>

The call object.

ListDatasetVersionsAsync(ListDatasetVersionsRequest, Metadata, DateTime?, CancellationToken)

List all the versions of a dataset.

Declaration
public virtual AsyncUnaryCall<ListDatasetVersionsResponse> ListDatasetVersionsAsync(ListDatasetVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListDatasetVersionsRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<ListDatasetVersionsResponse>

The call object.

ListDatasets(ListDatasetsRequest, CallOptions)

List all the datasets for the specified project.

Declaration
public virtual ListDatasetsResponse ListDatasets(ListDatasetsRequest request, CallOptions options)
Parameters
Type Name Description
ListDatasetsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
ListDatasetsResponse

The response received from the server.

ListDatasets(ListDatasetsRequest, Metadata, DateTime?, CancellationToken)

List all the datasets for the specified project.

Declaration
public virtual ListDatasetsResponse ListDatasets(ListDatasetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListDatasetsRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
ListDatasetsResponse

The response received from the server.

ListDatasetsAsync(ListDatasetsRequest, CallOptions)

List all the datasets for the specified project.

Declaration
public virtual AsyncUnaryCall<ListDatasetsResponse> ListDatasetsAsync(ListDatasetsRequest request, CallOptions options)
Parameters
Type Name Description
ListDatasetsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListDatasetsResponse>

The call object.

ListDatasetsAsync(ListDatasetsRequest, Metadata, DateTime?, CancellationToken)

List all the datasets for the specified project.

Declaration
public virtual AsyncUnaryCall<ListDatasetsResponse> ListDatasetsAsync(ListDatasetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListDatasetsRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<ListDatasetsResponse>

The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration
protected override MapsPlatformDatasetsV1Alpha.MapsPlatformDatasetsV1AlphaClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration
Returns
Type Description
MapsPlatformDatasetsV1Alpha.MapsPlatformDatasetsV1AlphaClient
Overrides
ClientBase<MapsPlatformDatasetsV1Alpha.MapsPlatformDatasetsV1AlphaClient>.NewInstance(ClientBase.ClientBaseConfiguration)

UpdateDatasetMetadata(UpdateDatasetMetadataRequest, CallOptions)

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

Declaration
public virtual Dataset UpdateDatasetMetadata(UpdateDatasetMetadataRequest request, CallOptions options)
Parameters
Type Name Description
UpdateDatasetMetadataRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Dataset

The response received from the server.

UpdateDatasetMetadata(UpdateDatasetMetadataRequest, Metadata, DateTime?, CancellationToken)

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

Declaration
public virtual Dataset UpdateDatasetMetadata(UpdateDatasetMetadataRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
UpdateDatasetMetadataRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
Dataset

The response received from the server.

UpdateDatasetMetadataAsync(UpdateDatasetMetadataRequest, CallOptions)

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

Declaration
public virtual AsyncUnaryCall<Dataset> UpdateDatasetMetadataAsync(UpdateDatasetMetadataRequest request, CallOptions options)
Parameters
Type Name Description
UpdateDatasetMetadataRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Dataset>

The call object.

UpdateDatasetMetadataAsync(UpdateDatasetMetadataRequest, Metadata, DateTime?, CancellationToken)

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

Declaration
public virtual AsyncUnaryCall<Dataset> UpdateDatasetMetadataAsync(UpdateDatasetMetadataRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
UpdateDatasetMetadataRequest request

The request to send to the server.

Metadata headers

The initial metadata to send with the call. This parameter is optional.

DateTime? deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationToken cancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Dataset>

The call object.

In this article
Back to top Generated by DocFX