Class v1.AutoMlClient (2.4.5)

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. v1

Package

@google-cloud/automl!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of AutoMlClient.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

autoMlStub

autoMlStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;
Property Value
Type Description
gax.OperationsClient

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

annotationSpecPath(project, location, dataset, annotationSpec)

annotationSpecPath(project: string, location: string, dataset: string, annotationSpec: string): string;

Return a fully-qualified annotationSpec resource name string.

Parameters
Name Description
project string
location string
dataset string
annotationSpec string
Returns
Type Description
string

{string} Resource name string.

checkCreateDatasetProgress(name)

checkCreateDatasetProgress(name: string): Promise<LROperation<protos.google.cloud.automl.v1.Dataset, protos.google.cloud.automl.v1.OperationMetadata>>;

Check the status of the long running operation returned by createDataset().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.automl.v1.Dataset, protos.google.cloud.automl.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkCreateModelProgress(name)

checkCreateModelProgress(name: string): Promise<LROperation<protos.google.cloud.automl.v1.Model, protos.google.cloud.automl.v1.OperationMetadata>>;

Check the status of the long running operation returned by createModel().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.automl.v1.Model, protos.google.cloud.automl.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkDeleteDatasetProgress(name)

checkDeleteDatasetProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.automl.v1.OperationMetadata>>;

Check the status of the long running operation returned by deleteDataset().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.automl.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkDeleteModelProgress(name)

checkDeleteModelProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.automl.v1.OperationMetadata>>;

Check the status of the long running operation returned by deleteModel().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.automl.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkDeployModelProgress(name)

checkDeployModelProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.automl.v1.OperationMetadata>>;

Check the status of the long running operation returned by deployModel().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.automl.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkExportDataProgress(name)

checkExportDataProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.automl.v1.OperationMetadata>>;

Check the status of the long running operation returned by exportData().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.automl.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkExportModelProgress(name)

checkExportModelProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.automl.v1.OperationMetadata>>;

Check the status of the long running operation returned by exportModel().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.automl.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkImportDataProgress(name)

checkImportDataProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.automl.v1.OperationMetadata>>;

Check the status of the long running operation returned by importData().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.automl.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkUndeployModelProgress(name)

checkUndeployModelProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.automl.v1.OperationMetadata>>;

Check the status of the long running operation returned by undeployModel().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.automl.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

createDataset(request, options)

createDataset(request?: protos.google.cloud.automl.v1.ICreateDatasetRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.ICreateDatasetRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

createDataset(request, options, callback)

createDataset(request: protos.google.cloud.automl.v1.ICreateDatasetRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.ICreateDatasetRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDataset(request, callback)

createDataset(request: protos.google.cloud.automl.v1.ICreateDatasetRequest, callback: Callback<LROperation<protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.ICreateDatasetRequest
callback Callback<LROperation<protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createModel(request, options)

createModel(request?: protos.google.cloud.automl.v1.ICreateModelRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.ICreateModelRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

createModel(request, options, callback)

createModel(request: protos.google.cloud.automl.v1.ICreateModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.ICreateModelRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createModel(request, callback)

createModel(request: protos.google.cloud.automl.v1.ICreateModelRequest, callback: Callback<LROperation<protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.ICreateModelRequest
callback Callback<LROperation<protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

datasetPath(project, location, dataset)

datasetPath(project: string, location: string, dataset: string): string;

Return a fully-qualified dataset resource name string.

Parameters
Name Description
project string
location string
dataset string
Returns
Type Description
string

{string} Resource name string.

deleteDataset(request, options)

deleteDataset(request?: protos.google.cloud.automl.v1.IDeleteDatasetRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IDeleteDatasetRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

deleteDataset(request, options, callback)

deleteDataset(request: protos.google.cloud.automl.v1.IDeleteDatasetRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IDeleteDatasetRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteDataset(request, callback)

deleteDataset(request: protos.google.cloud.automl.v1.IDeleteDatasetRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IDeleteDatasetRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteModel(request, options)

deleteModel(request?: protos.google.cloud.automl.v1.IDeleteModelRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IDeleteModelRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

deleteModel(request, options, callback)

deleteModel(request: protos.google.cloud.automl.v1.IDeleteModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IDeleteModelRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteModel(request, callback)

deleteModel(request: protos.google.cloud.automl.v1.IDeleteModelRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IDeleteModelRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deployModel(request, options)

deployModel(request?: protos.google.cloud.automl.v1.IDeployModelRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IDeployModelRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

deployModel(request, options, callback)

deployModel(request: protos.google.cloud.automl.v1.IDeployModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IDeployModelRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deployModel(request, callback)

deployModel(request: protos.google.cloud.automl.v1.IDeployModelRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IDeployModelRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportData(request, options)

exportData(request?: protos.google.cloud.automl.v1.IExportDataRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IExportDataRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

exportData(request, options, callback)

exportData(request: protos.google.cloud.automl.v1.IExportDataRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IExportDataRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportData(request, callback)

exportData(request: protos.google.cloud.automl.v1.IExportDataRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IExportDataRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportModel(request, options)

exportModel(request?: protos.google.cloud.automl.v1.IExportModelRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IExportModelRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

exportModel(request, options, callback)

exportModel(request: protos.google.cloud.automl.v1.IExportModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IExportModelRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportModel(request, callback)

exportModel(request: protos.google.cloud.automl.v1.IExportModelRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IExportModelRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAnnotationSpec(request, options)

getAnnotationSpec(request?: protos.google.cloud.automl.v1.IGetAnnotationSpecRequest, options?: CallOptions): Promise<[protos.google.cloud.automl.v1.IAnnotationSpec, protos.google.cloud.automl.v1.IGetAnnotationSpecRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IGetAnnotationSpecRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.automl.v1.IAnnotationSpec, protos.google.cloud.automl.v1.IGetAnnotationSpecRequest | undefined, {} | undefined]>

getAnnotationSpec(request, options, callback)

getAnnotationSpec(request: protos.google.cloud.automl.v1.IGetAnnotationSpecRequest, options: CallOptions, callback: Callback<protos.google.cloud.automl.v1.IAnnotationSpec, protos.google.cloud.automl.v1.IGetAnnotationSpecRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IGetAnnotationSpecRequest
options CallOptions
callback Callback<protos.google.cloud.automl.v1.IAnnotationSpec, protos.google.cloud.automl.v1.IGetAnnotationSpecRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAnnotationSpec(request, callback)

getAnnotationSpec(request: protos.google.cloud.automl.v1.IGetAnnotationSpecRequest, callback: Callback<protos.google.cloud.automl.v1.IAnnotationSpec, protos.google.cloud.automl.v1.IGetAnnotationSpecRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IGetAnnotationSpecRequest
callback Callback<protos.google.cloud.automl.v1.IAnnotationSpec, protos.google.cloud.automl.v1.IGetAnnotationSpecRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDataset(request, options)

getDataset(request?: protos.google.cloud.automl.v1.IGetDatasetRequest, options?: CallOptions): Promise<[protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IGetDatasetRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IGetDatasetRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IGetDatasetRequest | undefined, {} | undefined]>

getDataset(request, options, callback)

getDataset(request: protos.google.cloud.automl.v1.IGetDatasetRequest, options: CallOptions, callback: Callback<protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IGetDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IGetDatasetRequest
options CallOptions
callback Callback<protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IGetDatasetRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDataset(request, callback)

getDataset(request: protos.google.cloud.automl.v1.IGetDatasetRequest, callback: Callback<protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IGetDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IGetDatasetRequest
callback Callback<protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IGetDatasetRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getModel(request, options)

getModel(request?: protos.google.cloud.automl.v1.IGetModelRequest, options?: CallOptions): Promise<[protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IGetModelRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IGetModelRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IGetModelRequest | undefined, {} | undefined]>

getModel(request, options, callback)

getModel(request: protos.google.cloud.automl.v1.IGetModelRequest, options: CallOptions, callback: Callback<protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IGetModelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IGetModelRequest
options CallOptions
callback Callback<protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IGetModelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getModel(request, callback)

getModel(request: protos.google.cloud.automl.v1.IGetModelRequest, callback: Callback<protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IGetModelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IGetModelRequest
callback Callback<protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IGetModelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getModelEvaluation(request, options)

getModelEvaluation(request?: protos.google.cloud.automl.v1.IGetModelEvaluationRequest, options?: CallOptions): Promise<[protos.google.cloud.automl.v1.IModelEvaluation, protos.google.cloud.automl.v1.IGetModelEvaluationRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IGetModelEvaluationRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.automl.v1.IModelEvaluation, protos.google.cloud.automl.v1.IGetModelEvaluationRequest | undefined, {} | undefined]>

getModelEvaluation(request, options, callback)

getModelEvaluation(request: protos.google.cloud.automl.v1.IGetModelEvaluationRequest, options: CallOptions, callback: Callback<protos.google.cloud.automl.v1.IModelEvaluation, protos.google.cloud.automl.v1.IGetModelEvaluationRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IGetModelEvaluationRequest
options CallOptions
callback Callback<protos.google.cloud.automl.v1.IModelEvaluation, protos.google.cloud.automl.v1.IGetModelEvaluationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getModelEvaluation(request, callback)

getModelEvaluation(request: protos.google.cloud.automl.v1.IGetModelEvaluationRequest, callback: Callback<protos.google.cloud.automl.v1.IModelEvaluation, protos.google.cloud.automl.v1.IGetModelEvaluationRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IGetModelEvaluationRequest
callback Callback<protos.google.cloud.automl.v1.IModelEvaluation, protos.google.cloud.automl.v1.IGetModelEvaluationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

importData(request, options)

importData(request?: protos.google.cloud.automl.v1.IImportDataRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IImportDataRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

importData(request, options, callback)

importData(request: protos.google.cloud.automl.v1.IImportDataRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IImportDataRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

importData(request, callback)

importData(request: protos.google.cloud.automl.v1.IImportDataRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IImportDataRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listDatasets(request, options)

listDatasets(request?: protos.google.cloud.automl.v1.IListDatasetsRequest, options?: CallOptions): Promise<[protos.google.cloud.automl.v1.IDataset[], protos.google.cloud.automl.v1.IListDatasetsRequest | null, protos.google.cloud.automl.v1.IListDatasetsResponse]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IListDatasetsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.automl.v1.IDataset[], protos.google.cloud.automl.v1.IListDatasetsRequest | null, protos.google.cloud.automl.v1.IListDatasetsResponse]>

listDatasets(request, options, callback)

listDatasets(request: protos.google.cloud.automl.v1.IListDatasetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.automl.v1.IListDatasetsRequest, protos.google.cloud.automl.v1.IListDatasetsResponse | null | undefined, protos.google.cloud.automl.v1.IDataset>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IListDatasetsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.automl.v1.IListDatasetsRequest, protos.google.cloud.automl.v1.IListDatasetsResponse | null | undefined, protos.google.cloud.automl.v1.IDataset>
Returns
Type Description
void

listDatasets(request, callback)

listDatasets(request: protos.google.cloud.automl.v1.IListDatasetsRequest, callback: PaginationCallback<protos.google.cloud.automl.v1.IListDatasetsRequest, protos.google.cloud.automl.v1.IListDatasetsResponse | null | undefined, protos.google.cloud.automl.v1.IDataset>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IListDatasetsRequest
callback PaginationCallback<protos.google.cloud.automl.v1.IListDatasetsRequest, protos.google.cloud.automl.v1.IListDatasetsResponse | null | undefined, protos.google.cloud.automl.v1.IDataset>
Returns
Type Description
void

listDatasetsAsync(request, options)

listDatasetsAsync(request?: protos.google.cloud.automl.v1.IListDatasetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.automl.v1.IDataset>;

Equivalent to listDatasets, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.google.cloud.automl.v1.IListDatasetsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.automl.v1.IDataset>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Dataset]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDatasetsStream(request, options)

listDatasetsStream(request?: protos.google.cloud.automl.v1.IListDatasetsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.automl.v1.IListDatasetsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Dataset] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDatasetsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listModelEvaluations(request, options)

listModelEvaluations(request?: protos.google.cloud.automl.v1.IListModelEvaluationsRequest, options?: CallOptions): Promise<[protos.google.cloud.automl.v1.IModelEvaluation[], protos.google.cloud.automl.v1.IListModelEvaluationsRequest | null, protos.google.cloud.automl.v1.IListModelEvaluationsResponse]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IListModelEvaluationsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.automl.v1.IModelEvaluation[], protos.google.cloud.automl.v1.IListModelEvaluationsRequest | null, protos.google.cloud.automl.v1.IListModelEvaluationsResponse]>

listModelEvaluations(request, options, callback)

listModelEvaluations(request: protos.google.cloud.automl.v1.IListModelEvaluationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.automl.v1.IListModelEvaluationsRequest, protos.google.cloud.automl.v1.IListModelEvaluationsResponse | null | undefined, protos.google.cloud.automl.v1.IModelEvaluation>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IListModelEvaluationsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.automl.v1.IListModelEvaluationsRequest, protos.google.cloud.automl.v1.IListModelEvaluationsResponse | null | undefined, protos.google.cloud.automl.v1.IModelEvaluation>
Returns
Type Description
void

listModelEvaluations(request, callback)

listModelEvaluations(request: protos.google.cloud.automl.v1.IListModelEvaluationsRequest, callback: PaginationCallback<protos.google.cloud.automl.v1.IListModelEvaluationsRequest, protos.google.cloud.automl.v1.IListModelEvaluationsResponse | null | undefined, protos.google.cloud.automl.v1.IModelEvaluation>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IListModelEvaluationsRequest
callback PaginationCallback<protos.google.cloud.automl.v1.IListModelEvaluationsRequest, protos.google.cloud.automl.v1.IListModelEvaluationsResponse | null | undefined, protos.google.cloud.automl.v1.IModelEvaluation>
Returns
Type Description
void

listModelEvaluationsAsync(request, options)

listModelEvaluationsAsync(request?: protos.google.cloud.automl.v1.IListModelEvaluationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.automl.v1.IModelEvaluation>;

Equivalent to listModelEvaluations, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.google.cloud.automl.v1.IListModelEvaluationsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.automl.v1.IModelEvaluation>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [ModelEvaluation]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listModelEvaluationsStream(request, options)

listModelEvaluationsStream(request?: protos.google.cloud.automl.v1.IListModelEvaluationsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.automl.v1.IListModelEvaluationsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [ModelEvaluation] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listModelEvaluationsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listModels(request, options)

listModels(request?: protos.google.cloud.automl.v1.IListModelsRequest, options?: CallOptions): Promise<[protos.google.cloud.automl.v1.IModel[], protos.google.cloud.automl.v1.IListModelsRequest | null, protos.google.cloud.automl.v1.IListModelsResponse]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IListModelsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.automl.v1.IModel[], protos.google.cloud.automl.v1.IListModelsRequest | null, protos.google.cloud.automl.v1.IListModelsResponse]>

listModels(request, options, callback)

listModels(request: protos.google.cloud.automl.v1.IListModelsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.automl.v1.IListModelsRequest, protos.google.cloud.automl.v1.IListModelsResponse | null | undefined, protos.google.cloud.automl.v1.IModel>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IListModelsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.automl.v1.IListModelsRequest, protos.google.cloud.automl.v1.IListModelsResponse | null | undefined, protos.google.cloud.automl.v1.IModel>
Returns
Type Description
void

listModels(request, callback)

listModels(request: protos.google.cloud.automl.v1.IListModelsRequest, callback: PaginationCallback<protos.google.cloud.automl.v1.IListModelsRequest, protos.google.cloud.automl.v1.IListModelsResponse | null | undefined, protos.google.cloud.automl.v1.IModel>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IListModelsRequest
callback PaginationCallback<protos.google.cloud.automl.v1.IListModelsRequest, protos.google.cloud.automl.v1.IListModelsResponse | null | undefined, protos.google.cloud.automl.v1.IModel>
Returns
Type Description
void

listModelsAsync(request, options)

listModelsAsync(request?: protos.google.cloud.automl.v1.IListModelsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.automl.v1.IModel>;

Equivalent to listModels, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.google.cloud.automl.v1.IListModelsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.automl.v1.IModel>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Model]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listModelsStream(request, options)

listModelsStream(request?: protos.google.cloud.automl.v1.IListModelsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.automl.v1.IListModelsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Model] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listModelsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName)

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the annotation_spec from AnnotationSpec resource.

Parameter
Name Description
annotationSpecName string

A fully-qualified path representing AnnotationSpec resource.
Returns
Type Description
string | number

{string} A string representing the annotation_spec.

matchDatasetFromAnnotationSpecName(annotationSpecName)

matchDatasetFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the dataset from AnnotationSpec resource.

Parameter
Name Description
annotationSpecName string

A fully-qualified path representing AnnotationSpec resource.
Returns
Type Description
string | number

{string} A string representing the dataset.

matchDatasetFromDatasetName(datasetName)

matchDatasetFromDatasetName(datasetName: string): string | number;

Parse the dataset from Dataset resource.

Parameter
Name Description
datasetName string

A fully-qualified path representing Dataset resource.
Returns
Type Description
string | number

{string} A string representing the dataset.

matchLocationFromAnnotationSpecName(annotationSpecName)

matchLocationFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the location from AnnotationSpec resource.

Parameter
Name Description
annotationSpecName string

A fully-qualified path representing AnnotationSpec resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromDatasetName(datasetName)

matchLocationFromDatasetName(datasetName: string): string | number;

Parse the location from Dataset resource.

Parameter
Name Description
datasetName string

A fully-qualified path representing Dataset resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromModelEvaluationName(modelEvaluationName)

matchLocationFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the location from ModelEvaluation resource.

Parameter
Name Description
modelEvaluationName string

A fully-qualified path representing ModelEvaluation resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromModelName(modelName)

matchLocationFromModelName(modelName: string): string | number;

Parse the location from Model resource.

Parameter
Name Description
modelName string

A fully-qualified path representing Model resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchModelEvaluationFromModelEvaluationName(modelEvaluationName)

matchModelEvaluationFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the model_evaluation from ModelEvaluation resource.

Parameter
Name Description
modelEvaluationName string

A fully-qualified path representing ModelEvaluation resource.
Returns
Type Description
string | number

{string} A string representing the model_evaluation.

matchModelFromModelEvaluationName(modelEvaluationName)

matchModelFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the model from ModelEvaluation resource.

Parameter
Name Description
modelEvaluationName string

A fully-qualified path representing ModelEvaluation resource.
Returns
Type Description
string | number

{string} A string representing the model.

matchModelFromModelName(modelName)

matchModelFromModelName(modelName: string): string | number;

Parse the model from Model resource.

Parameter
Name Description
modelName string

A fully-qualified path representing Model resource.
Returns
Type Description
string | number

{string} A string representing the model.

matchProjectFromAnnotationSpecName(annotationSpecName)

matchProjectFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the project from AnnotationSpec resource.

Parameter
Name Description
annotationSpecName string

A fully-qualified path representing AnnotationSpec resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromDatasetName(datasetName)

matchProjectFromDatasetName(datasetName: string): string | number;

Parse the project from Dataset resource.

Parameter
Name Description
datasetName string

A fully-qualified path representing Dataset resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromModelEvaluationName(modelEvaluationName)

matchProjectFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the project from ModelEvaluation resource.

Parameter
Name Description
modelEvaluationName string

A fully-qualified path representing ModelEvaluation resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromModelName(modelName)

matchProjectFromModelName(modelName: string): string | number;

Parse the project from Model resource.

Parameter
Name Description
modelName string

A fully-qualified path representing Model resource.
Returns
Type Description
string | number

{string} A string representing the project.

modelEvaluationPath(project, location, model, modelEvaluation)

modelEvaluationPath(project: string, location: string, model: string, modelEvaluation: string): string;

Return a fully-qualified modelEvaluation resource name string.

Parameters
Name Description
project string
location string
model string
modelEvaluation string
Returns
Type Description
string

{string} Resource name string.

modelPath(project, location, model)

modelPath(project: string, location: string, model: string): string;

Return a fully-qualified model resource name string.

Parameters
Name Description
project string
location string
model string
Returns
Type Description
string

{string} Resource name string.

undeployModel(request, options)

undeployModel(request?: protos.google.cloud.automl.v1.IUndeployModelRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IUndeployModelRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

undeployModel(request, options, callback)

undeployModel(request: protos.google.cloud.automl.v1.IUndeployModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IUndeployModelRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

undeployModel(request, callback)

undeployModel(request: protos.google.cloud.automl.v1.IUndeployModelRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IUndeployModelRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.automl.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDataset(request, options)

updateDataset(request?: protos.google.cloud.automl.v1.IUpdateDatasetRequest, options?: CallOptions): Promise<[protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IUpdateDatasetRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IUpdateDatasetRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IUpdateDatasetRequest | undefined, {} | undefined]>

updateDataset(request, options, callback)

updateDataset(request: protos.google.cloud.automl.v1.IUpdateDatasetRequest, options: CallOptions, callback: Callback<protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IUpdateDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IUpdateDatasetRequest
options CallOptions
callback Callback<protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IUpdateDatasetRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDataset(request, callback)

updateDataset(request: protos.google.cloud.automl.v1.IUpdateDatasetRequest, callback: Callback<protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IUpdateDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IUpdateDatasetRequest
callback Callback<protos.google.cloud.automl.v1.IDataset, protos.google.cloud.automl.v1.IUpdateDatasetRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateModel(request, options)

updateModel(request?: protos.google.cloud.automl.v1.IUpdateModelRequest, options?: CallOptions): Promise<[protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IUpdateModelRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.automl.v1.IUpdateModelRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IUpdateModelRequest | undefined, {} | undefined]>

updateModel(request, options, callback)

updateModel(request: protos.google.cloud.automl.v1.IUpdateModelRequest, options: CallOptions, callback: Callback<protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IUpdateModelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IUpdateModelRequest
options CallOptions
callback Callback<protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IUpdateModelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateModel(request, callback)

updateModel(request: protos.google.cloud.automl.v1.IUpdateModelRequest, callback: Callback<protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IUpdateModelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.automl.v1.IUpdateModelRequest
callback Callback<protos.google.cloud.automl.v1.IModel, protos.google.cloud.automl.v1.IUpdateModelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void