Class AutoMlClientImpl

AutoMl client wrapper implementation, for convenient use.

Inheritance
System.Object
AutoMlClient
AutoMlClientImpl
Inherited Members
System.Object.ToString()
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Cloud.AutoML.V1
Assembly: Google.Cloud.AutoML.V1.dll
Syntax
public sealed class AutoMlClientImpl : AutoMlClient
Remarks

AutoML Server API.

The resource names are assigned by the server. The server never reuses names that it has created after the resources with those names are deleted.

An ID of a resource is the last element of the item's resource name. For projects/{project_id}/locations/{location_id}/datasets/{dataset_id}, then the id for the item is {dataset_id}.

Currently the only supported location_id is "us-central1".

On any input that is documented to expect a string parameter in snake_case or kebab-case, either of those cases is accepted.

Constructors

AutoMlClientImpl(AutoMl.AutoMlClient, AutoMlSettings)

Constructs a client wrapper for the AutoMl service, with the specified gRPC client and settings.

Declaration
public AutoMlClientImpl(AutoMl.AutoMlClient grpcClient, AutoMlSettings settings)
Parameters
Type Name Description
AutoMl.AutoMlClient grpcClient

The underlying gRPC client.
AutoMlSettings settings

The base AutoMlSettings used within this client.

Properties

CreateDatasetOperationsClient

The long-running operations client for CreateDataset.

Declaration
public override OperationsClient CreateDatasetOperationsClient { get; }
Property Value
Type Description
OperationsClient
Overrides

CreateModelOperationsClient

The long-running operations client for CreateModel.

Declaration
public override OperationsClient CreateModelOperationsClient { get; }
Property Value
Type Description
OperationsClient
Overrides

DeleteDatasetOperationsClient

The long-running operations client for DeleteDataset.

Declaration
public override OperationsClient DeleteDatasetOperationsClient { get; }
Property Value
Type Description
OperationsClient
Overrides

DeleteModelOperationsClient

The long-running operations client for DeleteModel.

Declaration
public override OperationsClient DeleteModelOperationsClient { get; }
Property Value
Type Description
OperationsClient
Overrides

DeployModelOperationsClient

The long-running operations client for DeployModel.

Declaration
public override OperationsClient DeployModelOperationsClient { get; }
Property Value
Type Description
OperationsClient
Overrides

ExportDataOperationsClient

The long-running operations client for ExportData.

Declaration
public override OperationsClient ExportDataOperationsClient { get; }
Property Value
Type Description
OperationsClient
Overrides

ExportModelOperationsClient

The long-running operations client for ExportModel.

Declaration
public override OperationsClient ExportModelOperationsClient { get; }
Property Value
Type Description
OperationsClient
Overrides

GrpcClient

The underlying gRPC AutoMl client

Declaration
public override AutoMl.AutoMlClient GrpcClient { get; }
Property Value
Type Description
AutoMl.AutoMlClient
Overrides

ImportDataOperationsClient

The long-running operations client for ImportData.

Declaration
public override OperationsClient ImportDataOperationsClient { get; }
Property Value
Type Description
OperationsClient
Overrides

UndeployModelOperationsClient

The long-running operations client for UndeployModel.

Declaration
public override OperationsClient UndeployModelOperationsClient { get; }
Property Value
Type Description
OperationsClient
Overrides

Methods

CreateDataset(CreateDatasetRequest, CallSettings)

Creates a dataset.

Declaration
public override Operation<Dataset, OperationMetadata> 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
Operation<Dataset, OperationMetadata>

The RPC response.
Overrides

CreateDatasetAsync(CreateDatasetRequest, CallSettings)

Creates a dataset.

Declaration
public override Task<Operation<Dataset, OperationMetadata>> 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
System.Threading.Tasks.Task<Operation<Dataset, OperationMetadata>>

A Task containing the RPC response.
Overrides

CreateModel(CreateModelRequest, CallSettings)

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.

Declaration
public override Operation<Model, OperationMetadata> CreateModel(CreateModelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateModelRequest 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
Operation<Model, OperationMetadata>

The RPC response.
Overrides

CreateModelAsync(CreateModelRequest, CallSettings)

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.

Declaration
public override Task<Operation<Model, OperationMetadata>> CreateModelAsync(CreateModelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateModelRequest 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
System.Threading.Tasks.Task<Operation<Model, OperationMetadata>>

A Task containing the RPC response.
Overrides

DeleteDataset(DeleteDatasetRequest, CallSettings)

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.

Declaration
public override Operation<Empty, OperationMetadata> 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.
Returns
Type Description
Operation<Empty, OperationMetadata>

The RPC response.
Overrides

DeleteDatasetAsync(DeleteDatasetRequest, CallSettings)

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.

Declaration
public override Task<Operation<Empty, OperationMetadata>> 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
System.Threading.Tasks.Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.
Overrides

DeleteModel(DeleteModelRequest, CallSettings)

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.

Declaration
public override Operation<Empty, OperationMetadata> DeleteModel(DeleteModelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteModelRequest 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
Operation<Empty, OperationMetadata>

The RPC response.
Overrides

DeleteModelAsync(DeleteModelRequest, CallSettings)

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.

Declaration
public override Task<Operation<Empty, OperationMetadata>> DeleteModelAsync(DeleteModelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteModelRequest 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
System.Threading.Tasks.Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.
Overrides

DeployModel(DeployModelRequest, CallSettings)

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.

Declaration
public override Operation<Empty, OperationMetadata> DeployModel(DeployModelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeployModelRequest 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
Operation<Empty, OperationMetadata>

The RPC response.
Overrides

DeployModelAsync(DeployModelRequest, CallSettings)

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.

Declaration
public override Task<Operation<Empty, OperationMetadata>> DeployModelAsync(DeployModelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeployModelRequest 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
System.Threading.Tasks.Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.
Overrides

ExportData(ExportDataRequest, CallSettings)

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

Declaration
public override Operation<Empty, OperationMetadata> ExportData(ExportDataRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ExportDataRequest 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
Operation<Empty, OperationMetadata>

The RPC response.
Overrides

ExportDataAsync(ExportDataRequest, CallSettings)

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

Declaration
public override Task<Operation<Empty, OperationMetadata>> ExportDataAsync(ExportDataRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ExportDataRequest 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
System.Threading.Tasks.Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.
Overrides

ExportModel(ExportModelRequest, CallSettings)

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.

Declaration
public override Operation<Empty, OperationMetadata> ExportModel(ExportModelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ExportModelRequest 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
Operation<Empty, OperationMetadata>

The RPC response.
Overrides

ExportModelAsync(ExportModelRequest, CallSettings)

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.

Declaration
public override Task<Operation<Empty, OperationMetadata>> ExportModelAsync(ExportModelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ExportModelRequest 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
System.Threading.Tasks.Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.
Overrides

GetAnnotationSpec(GetAnnotationSpecRequest, CallSettings)

Gets an annotation spec.

Declaration
public override AnnotationSpec GetAnnotationSpec(GetAnnotationSpecRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetAnnotationSpecRequest 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
AnnotationSpec

The RPC response.
Overrides

GetAnnotationSpecAsync(GetAnnotationSpecRequest, CallSettings)

Gets an annotation spec.

Declaration
public override Task<AnnotationSpec> GetAnnotationSpecAsync(GetAnnotationSpecRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetAnnotationSpecRequest 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
System.Threading.Tasks.Task<AnnotationSpec>

A Task containing the RPC response.
Overrides

GetDataset(GetDatasetRequest, CallSettings)

Gets a dataset.

Declaration
public override 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.
Overrides

GetDatasetAsync(GetDatasetRequest, CallSettings)

Gets a dataset.

Declaration
public override 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
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.
Overrides

GetModel(GetModelRequest, CallSettings)

Gets a model.

Declaration
public override Model GetModel(GetModelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetModelRequest 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
Model

The RPC response.
Overrides

GetModelAsync(GetModelRequest, CallSettings)

Gets a model.

Declaration
public override Task<Model> GetModelAsync(GetModelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetModelRequest 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
System.Threading.Tasks.Task<Model>

A Task containing the RPC response.
Overrides

GetModelEvaluation(GetModelEvaluationRequest, CallSettings)

Gets a model evaluation.

Declaration
public override ModelEvaluation GetModelEvaluation(GetModelEvaluationRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetModelEvaluationRequest 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
ModelEvaluation

The RPC response.
Overrides

GetModelEvaluationAsync(GetModelEvaluationRequest, CallSettings)

Gets a model evaluation.

Declaration
public override Task<ModelEvaluation> GetModelEvaluationAsync(GetModelEvaluationRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetModelEvaluationRequest 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
System.Threading.Tasks.Task<ModelEvaluation>

A Task containing the RPC response.
Overrides

ImportData(ImportDataRequest, CallSettings)

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.
Declaration
public override Operation<Empty, OperationMetadata> ImportData(ImportDataRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ImportDataRequest 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
Operation<Empty, OperationMetadata>

The RPC response.
Overrides

ImportDataAsync(ImportDataRequest, CallSettings)

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.
Declaration
public override Task<Operation<Empty, OperationMetadata>> ImportDataAsync(ImportDataRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ImportDataRequest 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
System.Threading.Tasks.Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.
Overrides

ListDatasets(ListDatasetsRequest, CallSettings)

Lists datasets in a project.

Declaration
public override 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.
Overrides

ListDatasetsAsync(ListDatasetsRequest, CallSettings)

Lists datasets in a project.

Declaration
public override 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.
Overrides

ListModelEvaluations(ListModelEvaluationsRequest, CallSettings)

Lists model evaluations.

Declaration
public override PagedEnumerable<ListModelEvaluationsResponse, ModelEvaluation> ListModelEvaluations(ListModelEvaluationsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListModelEvaluationsRequest 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<ListModelEvaluationsResponse, ModelEvaluation>

A pageable sequence of ModelEvaluation resources.
Overrides

ListModelEvaluationsAsync(ListModelEvaluationsRequest, CallSettings)

Lists model evaluations.

Declaration
public override PagedAsyncEnumerable<ListModelEvaluationsResponse, ModelEvaluation> ListModelEvaluationsAsync(ListModelEvaluationsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListModelEvaluationsRequest 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<ListModelEvaluationsResponse, ModelEvaluation>

A pageable asynchronous sequence of ModelEvaluation resources.
Overrides

ListModels(ListModelsRequest, CallSettings)

Lists models.

Declaration
public override PagedEnumerable<ListModelsResponse, Model> ListModels(ListModelsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListModelsRequest 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<ListModelsResponse, Model>

A pageable sequence of Model resources.
Overrides

ListModelsAsync(ListModelsRequest, CallSettings)

Lists models.

Declaration
public override PagedAsyncEnumerable<ListModelsResponse, Model> ListModelsAsync(ListModelsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListModelsRequest 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<ListModelsResponse, Model>

A pageable asynchronous sequence of Model resources.
Overrides

UndeployModel(UndeployModelRequest, CallSettings)

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.

Declaration
public override Operation<Empty, OperationMetadata> UndeployModel(UndeployModelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UndeployModelRequest 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
Operation<Empty, OperationMetadata>

The RPC response.
Overrides

UndeployModelAsync(UndeployModelRequest, CallSettings)

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.

Declaration
public override Task<Operation<Empty, OperationMetadata>> UndeployModelAsync(UndeployModelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UndeployModelRequest 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
System.Threading.Tasks.Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.
Overrides

UpdateDataset(UpdateDatasetRequest, CallSettings)

Updates a dataset.

Declaration
public override Dataset UpdateDataset(UpdateDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateDatasetRequest 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.
Overrides

UpdateDatasetAsync(UpdateDatasetRequest, CallSettings)

Updates a dataset.

Declaration
public override Task<Dataset> UpdateDatasetAsync(UpdateDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateDatasetRequest 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
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.
Overrides

UpdateModel(UpdateModelRequest, CallSettings)

Updates a model.

Declaration
public override Model UpdateModel(UpdateModelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateModelRequest 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
Model

The RPC response.
Overrides

UpdateModelAsync(UpdateModelRequest, CallSettings)

Updates a model.

Declaration
public override Task<Model> UpdateModelAsync(UpdateModelRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateModelRequest 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
System.Threading.Tasks.Task<Model>

A Task containing the RPC response.
Overrides