Class AutoMl.AutoMlClient

public class AutoMlClient : ClientBase<AutoMl.AutoMlClient>

Client for AutoMl

Inheritance

Object > ClientBase > ClientBase<AutoMl.AutoMlClient> > AutoMl.AutoMlClient

Namespace

Google.Cloud.AutoML.V1

Assembly

Google.Cloud.AutoML.V1.dll

Constructors

AutoMlClient()

protected AutoMlClient()

Protected parameterless constructor to allow creation of test doubles.

AutoMlClient(CallInvoker)

public AutoMlClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

AutoMlClient(Channel)

[Obsolete("This constructor overload is present for compatibility only, and will be removed in the next major version")]
public AutoMlClient(Channel channel)

Creates a new client using a channel.

Parameter
NameDescription
channelChannel

The channel to use to make remote calls.

AutoMlClient(ChannelBase)

public AutoMlClient(ChannelBase channel)

Creates a new client for AutoMl

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

AutoMlClient(ClientBase.ClientBaseConfiguration)

protected AutoMlClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateDataset(CreateDatasetRequest, CallOptions)

public virtual Operation CreateDataset(CreateDatasetRequest request, CallOptions options)

Creates a dataset.

Parameters
NameDescription
requestCreateDatasetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateDataset(CreateDatasetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateDataset(CreateDatasetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a dataset.

Parameters
NameDescription
requestCreateDatasetRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateDatasetAsync(CreateDatasetRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateDatasetAsync(CreateDatasetRequest request, CallOptions options)

Creates a dataset.

Parameters
NameDescription
requestCreateDatasetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateDatasetAsync(CreateDatasetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateDatasetAsync(CreateDatasetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a dataset.

Parameters
NameDescription
requestCreateDatasetRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateModel(CreateModelRequest, CallOptions)

public virtual Operation CreateModel(CreateModelRequest request, CallOptions options)

Creates a model. Returns a Model in the [response][google.longrunning.Operation.response] field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.

Parameters
NameDescription
requestCreateModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateModel(CreateModelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateModel(CreateModelRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a model. Returns a Model in the [response][google.longrunning.Operation.response] field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.

Parameters
NameDescription
requestCreateModelRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateModelAsync(CreateModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateModelAsync(CreateModelRequest request, CallOptions options)

Creates a model. Returns a Model in the [response][google.longrunning.Operation.response] field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.

Parameters
NameDescription
requestCreateModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateModelAsync(CreateModelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateModelAsync(CreateModelRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a model. Returns a Model in the [response][google.longrunning.Operation.response] field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.

Parameters
NameDescription
requestCreateModelRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

DeleteDataset(DeleteDatasetRequest, CallOptions)

public virtual Operation DeleteDataset(DeleteDatasetRequest request, CallOptions options)

Deletes a dataset and all of its contents. Returns empty response in the [response][google.longrunning.Operation.response] field when it completes, and delete_details in the [metadata][google.longrunning.Operation.metadata] field.

Parameters
NameDescription
requestDeleteDatasetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteDataset(DeleteDatasetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteDataset(DeleteDatasetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes a dataset and all of its contents. Returns empty response in the [response][google.longrunning.Operation.response] field when it completes, and delete_details in the [metadata][google.longrunning.Operation.metadata] field.

Parameters
NameDescription
requestDeleteDatasetRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteDatasetAsync(DeleteDatasetRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteDatasetAsync(DeleteDatasetRequest request, CallOptions options)

Deletes a dataset and all of its contents. Returns empty response in the [response][google.longrunning.Operation.response] field when it completes, and delete_details in the [metadata][google.longrunning.Operation.metadata] field.

Parameters
NameDescription
requestDeleteDatasetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteDatasetAsync(DeleteDatasetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteDatasetAsync(DeleteDatasetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes a dataset and all of its contents. Returns empty response in the [response][google.longrunning.Operation.response] field when it completes, and delete_details in the [metadata][google.longrunning.Operation.metadata] field.

Parameters
NameDescription
requestDeleteDatasetRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteModel(DeleteModelRequest, CallOptions)

public virtual Operation DeleteModel(DeleteModelRequest request, CallOptions options)

Deletes a model. Returns google.protobuf.Empty in the [response][google.longrunning.Operation.response] field when it completes, and delete_details in the [metadata][google.longrunning.Operation.metadata] field.

Parameters
NameDescription
requestDeleteModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteModel(DeleteModelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteModel(DeleteModelRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes a model. Returns google.protobuf.Empty in the [response][google.longrunning.Operation.response] field when it completes, and delete_details in the [metadata][google.longrunning.Operation.metadata] field.

Parameters
NameDescription
requestDeleteModelRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteModelAsync(DeleteModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteModelAsync(DeleteModelRequest request, CallOptions options)

Deletes a model. Returns google.protobuf.Empty in the [response][google.longrunning.Operation.response] field when it completes, and delete_details in the [metadata][google.longrunning.Operation.metadata] field.

Parameters
NameDescription
requestDeleteModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteModelAsync(DeleteModelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteModelAsync(DeleteModelRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes a model. Returns google.protobuf.Empty in the [response][google.longrunning.Operation.response] field when it completes, and delete_details in the [metadata][google.longrunning.Operation.metadata] field.

Parameters
NameDescription
requestDeleteModelRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeployModel(DeployModelRequest, CallOptions)

public virtual Operation DeployModel(DeployModelRequest request, CallOptions options)

Deploys a model. If a model is already deployed, deploying it with the same parameters has no effect. Deploying with different parametrs (as e.g. changing [node_number][google.cloud.automl.v1p1beta.ImageObjectDetectionModelDeploymentMetadata.node_number]) will reset the deployment state without pausing the model's availability.

Only applicable for Text Classification, Image Object Detection , Tables, and Image Segmentation; all other domains manage deployment automatically.

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestDeployModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeployModel(DeployModelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeployModel(DeployModelRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deploys a model. If a model is already deployed, deploying it with the same parameters has no effect. Deploying with different parametrs (as e.g. changing [node_number][google.cloud.automl.v1p1beta.ImageObjectDetectionModelDeploymentMetadata.node_number]) will reset the deployment state without pausing the model's availability.

Only applicable for Text Classification, Image Object Detection , Tables, and Image Segmentation; all other domains manage deployment automatically.

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestDeployModelRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeployModelAsync(DeployModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeployModelAsync(DeployModelRequest request, CallOptions options)

Deploys a model. If a model is already deployed, deploying it with the same parameters has no effect. Deploying with different parametrs (as e.g. changing [node_number][google.cloud.automl.v1p1beta.ImageObjectDetectionModelDeploymentMetadata.node_number]) will reset the deployment state without pausing the model's availability.

Only applicable for Text Classification, Image Object Detection , Tables, and Image Segmentation; all other domains manage deployment automatically.

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestDeployModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeployModelAsync(DeployModelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeployModelAsync(DeployModelRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deploys a model. If a model is already deployed, deploying it with the same parameters has no effect. Deploying with different parametrs (as e.g. changing [node_number][google.cloud.automl.v1p1beta.ImageObjectDetectionModelDeploymentMetadata.node_number]) will reset the deployment state without pausing the model's availability.

Only applicable for Text Classification, Image Object Detection , Tables, and Image Segmentation; all other domains manage deployment automatically.

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestDeployModelRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ExportData(ExportDataRequest, CallOptions)

public virtual Operation ExportData(ExportDataRequest request, CallOptions options)

Exports dataset's data to the provided output location. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestExportDataRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ExportData(ExportDataRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ExportData(ExportDataRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Exports dataset's data to the provided output location. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestExportDataRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ExportDataAsync(ExportDataRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportDataAsync(ExportDataRequest request, CallOptions options)

Exports dataset's data to the provided output location. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestExportDataRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ExportDataAsync(ExportDataRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportDataAsync(ExportDataRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Exports dataset's data to the provided output location. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestExportDataRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ExportModel(ExportModelRequest, CallOptions)

public virtual Operation ExportModel(ExportModelRequest request, CallOptions options)

Exports a trained, "export-able", model to a user specified Google Cloud Storage location. A model is considered export-able if and only if it has an export format defined for it in [ModelExportOutputConfig][google.cloud.automl.v1.ModelExportOutputConfig].

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestExportModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ExportModel(ExportModelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ExportModel(ExportModelRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Exports a trained, "export-able", model to a user specified Google Cloud Storage location. A model is considered export-able if and only if it has an export format defined for it in [ModelExportOutputConfig][google.cloud.automl.v1.ModelExportOutputConfig].

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestExportModelRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ExportModelAsync(ExportModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportModelAsync(ExportModelRequest request, CallOptions options)

Exports a trained, "export-able", model to a user specified Google Cloud Storage location. A model is considered export-able if and only if it has an export format defined for it in [ModelExportOutputConfig][google.cloud.automl.v1.ModelExportOutputConfig].

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestExportModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ExportModelAsync(ExportModelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportModelAsync(ExportModelRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Exports a trained, "export-able", model to a user specified Google Cloud Storage location. A model is considered export-able if and only if it has an export format defined for it in [ModelExportOutputConfig][google.cloud.automl.v1.ModelExportOutputConfig].

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestExportModelRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

GetAnnotationSpec(GetAnnotationSpecRequest, CallOptions)

public virtual AnnotationSpec GetAnnotationSpec(GetAnnotationSpecRequest request, CallOptions options)

Gets an annotation spec.

Parameters
NameDescription
requestGetAnnotationSpecRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AnnotationSpec

The response received from the server.

GetAnnotationSpec(GetAnnotationSpecRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AnnotationSpec GetAnnotationSpec(GetAnnotationSpecRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets an annotation spec.

Parameters
NameDescription
requestGetAnnotationSpecRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AnnotationSpec

The response received from the server.

GetAnnotationSpecAsync(GetAnnotationSpecRequest, CallOptions)

public virtual AsyncUnaryCall<AnnotationSpec> GetAnnotationSpecAsync(GetAnnotationSpecRequest request, CallOptions options)

Gets an annotation spec.

Parameters
NameDescription
requestGetAnnotationSpecRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<AnnotationSpec>

The call object.

GetAnnotationSpecAsync(GetAnnotationSpecRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<AnnotationSpec> GetAnnotationSpecAsync(GetAnnotationSpecRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets an annotation spec.

Parameters
NameDescription
requestGetAnnotationSpecRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<AnnotationSpec>

The call object.

GetDataset(GetDatasetRequest, CallOptions)

public virtual Dataset GetDataset(GetDatasetRequest request, CallOptions options)

Gets a dataset.

Parameters
NameDescription
requestGetDatasetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Dataset

The response received from the server.

GetDataset(GetDatasetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Dataset GetDataset(GetDatasetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets a dataset.

Parameters
NameDescription
requestGetDatasetRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Dataset

The response received from the server.

GetDatasetAsync(GetDatasetRequest, CallOptions)

public virtual AsyncUnaryCall<Dataset> GetDatasetAsync(GetDatasetRequest request, CallOptions options)

Gets a dataset.

Parameters
NameDescription
requestGetDatasetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Dataset>

The call object.

GetDatasetAsync(GetDatasetRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets a dataset.

Parameters
NameDescription
requestGetDatasetRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Dataset>

The call object.

GetModel(GetModelRequest, CallOptions)

public virtual Model GetModel(GetModelRequest request, CallOptions options)

Gets a model.

Parameters
NameDescription
requestGetModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Model

The response received from the server.

GetModel(GetModelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Model GetModel(GetModelRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets a model.

Parameters
NameDescription
requestGetModelRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Model

The response received from the server.

GetModelAsync(GetModelRequest, CallOptions)

public virtual AsyncUnaryCall<Model> GetModelAsync(GetModelRequest request, CallOptions options)

Gets a model.

Parameters
NameDescription
requestGetModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Model>

The call object.

GetModelAsync(GetModelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Model> GetModelAsync(GetModelRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets a model.

Parameters
NameDescription
requestGetModelRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Model>

The call object.

GetModelEvaluation(GetModelEvaluationRequest, CallOptions)

public virtual ModelEvaluation GetModelEvaluation(GetModelEvaluationRequest request, CallOptions options)

Gets a model evaluation.

Parameters
NameDescription
requestGetModelEvaluationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ModelEvaluation

The response received from the server.

GetModelEvaluation(GetModelEvaluationRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ModelEvaluation GetModelEvaluation(GetModelEvaluationRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets a model evaluation.

Parameters
NameDescription
requestGetModelEvaluationRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ModelEvaluation

The response received from the server.

GetModelEvaluationAsync(GetModelEvaluationRequest, CallOptions)

public virtual AsyncUnaryCall<ModelEvaluation> GetModelEvaluationAsync(GetModelEvaluationRequest request, CallOptions options)

Gets a model evaluation.

Parameters
NameDescription
requestGetModelEvaluationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ModelEvaluation>

The call object.

GetModelEvaluationAsync(GetModelEvaluationRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ModelEvaluation> GetModelEvaluationAsync(GetModelEvaluationRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets a model evaluation.

Parameters
NameDescription
requestGetModelEvaluationRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ModelEvaluation>

The call object.

ImportData(ImportDataRequest, CallOptions)

public virtual Operation ImportData(ImportDataRequest request, CallOptions options)

Imports data into a dataset. For Tables this method can only be called on an empty Dataset.

For Tables:

  • A [schema_inference_version][google.cloud.automl.v1.InputConfig.params] parameter must be explicitly set. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.
Parameters
NameDescription
requestImportDataRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ImportData(ImportDataRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ImportData(ImportDataRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Imports data into a dataset. For Tables this method can only be called on an empty Dataset.

For Tables:

  • A [schema_inference_version][google.cloud.automl.v1.InputConfig.params] parameter must be explicitly set. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.
Parameters
NameDescription
requestImportDataRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ImportDataAsync(ImportDataRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportDataAsync(ImportDataRequest request, CallOptions options)

Imports data into a dataset. For Tables this method can only be called on an empty Dataset.

For Tables:

  • A [schema_inference_version][google.cloud.automl.v1.InputConfig.params] parameter must be explicitly set. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.
Parameters
NameDescription
requestImportDataRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ImportDataAsync(ImportDataRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ImportDataAsync(ImportDataRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Imports data into a dataset. For Tables this method can only be called on an empty Dataset.

For Tables:

  • A [schema_inference_version][google.cloud.automl.v1.InputConfig.params] parameter must be explicitly set. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.
Parameters
NameDescription
requestImportDataRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ListDatasets(ListDatasetsRequest, CallOptions)

public virtual ListDatasetsResponse ListDatasets(ListDatasetsRequest request, CallOptions options)

Lists datasets in a project.

Parameters
NameDescription
requestListDatasetsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListDatasetsResponse

The response received from the server.

ListDatasets(ListDatasetsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListDatasetsResponse ListDatasets(ListDatasetsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists datasets in a project.

Parameters
NameDescription
requestListDatasetsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListDatasetsResponse

The response received from the server.

ListDatasetsAsync(ListDatasetsRequest, CallOptions)

public virtual AsyncUnaryCall<ListDatasetsResponse> ListDatasetsAsync(ListDatasetsRequest request, CallOptions options)

Lists datasets in a project.

Parameters
NameDescription
requestListDatasetsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListDatasetsResponse>

The call object.

ListDatasetsAsync(ListDatasetsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists datasets in a project.

Parameters
NameDescription
requestListDatasetsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListDatasetsResponse>

The call object.

ListModelEvaluations(ListModelEvaluationsRequest, CallOptions)

public virtual ListModelEvaluationsResponse ListModelEvaluations(ListModelEvaluationsRequest request, CallOptions options)

Lists model evaluations.

Parameters
NameDescription
requestListModelEvaluationsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListModelEvaluationsResponse

The response received from the server.

ListModelEvaluations(ListModelEvaluationsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListModelEvaluationsResponse ListModelEvaluations(ListModelEvaluationsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists model evaluations.

Parameters
NameDescription
requestListModelEvaluationsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListModelEvaluationsResponse

The response received from the server.

ListModelEvaluationsAsync(ListModelEvaluationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListModelEvaluationsResponse> ListModelEvaluationsAsync(ListModelEvaluationsRequest request, CallOptions options)

Lists model evaluations.

Parameters
NameDescription
requestListModelEvaluationsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListModelEvaluationsResponse>

The call object.

ListModelEvaluationsAsync(ListModelEvaluationsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListModelEvaluationsResponse> ListModelEvaluationsAsync(ListModelEvaluationsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists model evaluations.

Parameters
NameDescription
requestListModelEvaluationsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListModelEvaluationsResponse>

The call object.

ListModels(ListModelsRequest, CallOptions)

public virtual ListModelsResponse ListModels(ListModelsRequest request, CallOptions options)

Lists models.

Parameters
NameDescription
requestListModelsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListModelsResponse

The response received from the server.

ListModels(ListModelsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListModelsResponse ListModels(ListModelsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists models.

Parameters
NameDescription
requestListModelsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListModelsResponse

The response received from the server.

ListModelsAsync(ListModelsRequest, CallOptions)

public virtual AsyncUnaryCall<ListModelsResponse> ListModelsAsync(ListModelsRequest request, CallOptions options)

Lists models.

Parameters
NameDescription
requestListModelsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListModelsResponse>

The call object.

ListModelsAsync(ListModelsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListModelsResponse> ListModelsAsync(ListModelsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists models.

Parameters
NameDescription
requestListModelsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListModelsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override AutoMl.AutoMlClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
AutoMl.AutoMlClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.AutoML.V1.AutoMl.AutoMlClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UndeployModel(UndeployModelRequest, CallOptions)

public virtual Operation UndeployModel(UndeployModelRequest request, CallOptions options)

Undeploys a model. If the model is not deployed this method has no effect.

Only applicable for Text Classification, Image Object Detection and Tables; all other domains manage deployment automatically.

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestUndeployModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UndeployModel(UndeployModelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UndeployModel(UndeployModelRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Undeploys a model. If the model is not deployed this method has no effect.

Only applicable for Text Classification, Image Object Detection and Tables; all other domains manage deployment automatically.

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestUndeployModelRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UndeployModelAsync(UndeployModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UndeployModelAsync(UndeployModelRequest request, CallOptions options)

Undeploys a model. If the model is not deployed this method has no effect.

Only applicable for Text Classification, Image Object Detection and Tables; all other domains manage deployment automatically.

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestUndeployModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UndeployModelAsync(UndeployModelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UndeployModelAsync(UndeployModelRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Undeploys a model. If the model is not deployed this method has no effect.

Only applicable for Text Classification, Image Object Detection and Tables; all other domains manage deployment automatically.

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
NameDescription
requestUndeployModelRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateDataset(UpdateDatasetRequest, CallOptions)

public virtual Dataset UpdateDataset(UpdateDatasetRequest request, CallOptions options)

Updates a dataset.

Parameters
NameDescription
requestUpdateDatasetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Dataset

The response received from the server.

UpdateDataset(UpdateDatasetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Dataset UpdateDataset(UpdateDatasetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates a dataset.

Parameters
NameDescription
requestUpdateDatasetRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Dataset

The response received from the server.

UpdateDatasetAsync(UpdateDatasetRequest, CallOptions)

public virtual AsyncUnaryCall<Dataset> UpdateDatasetAsync(UpdateDatasetRequest request, CallOptions options)

Updates a dataset.

Parameters
NameDescription
requestUpdateDatasetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Dataset>

The call object.

UpdateDatasetAsync(UpdateDatasetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Dataset> UpdateDatasetAsync(UpdateDatasetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates a dataset.

Parameters
NameDescription
requestUpdateDatasetRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Dataset>

The call object.

UpdateModel(UpdateModelRequest, CallOptions)

public virtual Model UpdateModel(UpdateModelRequest request, CallOptions options)

Updates a model.

Parameters
NameDescription
requestUpdateModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Model

The response received from the server.

UpdateModel(UpdateModelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Model UpdateModel(UpdateModelRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates a model.

Parameters
NameDescription
requestUpdateModelRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Model

The response received from the server.

UpdateModelAsync(UpdateModelRequest, CallOptions)

public virtual AsyncUnaryCall<Model> UpdateModelAsync(UpdateModelRequest request, CallOptions options)

Updates a model.

Parameters
NameDescription
requestUpdateModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Model>

The call object.

UpdateModelAsync(UpdateModelRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Model> UpdateModelAsync(UpdateModelRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates a model.

Parameters
NameDescription
requestUpdateModelRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Model>

The call object.