Class v1.JobServiceClient (1.7.2)

A service for creating and managing Vertex AI's jobs. v1

Package

@google-cloud/aiplatform!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of JobServiceClient.

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

descriptors

descriptors: Descriptors;

Property Value

Type	Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

Property Value

Type	Description
{ [name: string]: Function; }

jobServiceStub

jobServiceStub?: Promise<{
        [name: string]: Function;
    }>;

Property Value

Type	Description
Promise<{ [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

Methods

annotationPath(project, location, dataset, dataItem, annotation)

annotationPath(project: string, location: string, dataset: string, dataItem: string, annotation: string): string;

Return a fully-qualified annotation resource name string.

Parameters

Name	Description
project	`string`
location	`string`
dataset	`string`
dataItem	`string`
annotation	`string`

Returns

Type	Description
string	{string} Resource name string.

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.

batchPredictionJobPath(project, location, batchPredictionJob)

batchPredictionJobPath(project: string, location: string, batchPredictionJob: string): string;

Return a fully-qualified batchPredictionJob resource name string.

Parameters

Name	Description
project	`string`
location	`string`
batchPredictionJob	`string`

Returns

Type	Description
string	{string} Resource name string.

cancelBatchPredictionJob(request, options)

cancelBatchPredictionJob(request?: protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest \| undefined), {} \| undefined ]>

cancelBatchPredictionJob(request, options, callback)

cancelBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest`
options	`CallOptions`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

cancelBatchPredictionJob(request, callback)

cancelBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

cancelCustomJob(request, options)

cancelCustomJob(request?: protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest \| undefined, {} \| undefined ]>

cancelCustomJob(request, options, callback)

cancelCustomJob(request: protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest`
options	`CallOptions`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

cancelCustomJob(request, callback)

cancelCustomJob(request: protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

cancelDataLabelingJob(request, options)

cancelDataLabelingJob(request?: protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest \| undefined), {} \| undefined ]>

cancelDataLabelingJob(request, options, callback)

cancelDataLabelingJob(request: protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest`
options	`CallOptions`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

cancelDataLabelingJob(request, callback)

cancelDataLabelingJob(request: protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

cancelHyperparameterTuningJob(request, options)

cancelHyperparameterTuningJob(request?: protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest \| undefined), {} \| undefined ]>

cancelHyperparameterTuningJob(request, options, callback)

cancelHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest`
options	`CallOptions`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

cancelHyperparameterTuningJob(request, callback)

cancelHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

checkDeleteBatchPredictionJobProgress(name)

checkDeleteBatchPredictionJobProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.DeleteOperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.DeleteOperationMetadata>>	{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.

checkDeleteCustomJobProgress(name)

checkDeleteCustomJobProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.DeleteOperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.DeleteOperationMetadata>>	{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.

checkDeleteDataLabelingJobProgress(name)

checkDeleteDataLabelingJobProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.DeleteOperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.DeleteOperationMetadata>>	{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.

checkDeleteHyperparameterTuningJobProgress(name)

checkDeleteHyperparameterTuningJobProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.DeleteOperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.DeleteOperationMetadata>>	{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.

createBatchPredictionJob(request, options)

createBatchPredictionJob(request?: protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IBatchPredictionJob,
        (protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.IBatchPredictionJob, (protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest \| undefined), {} \| undefined ]>

createBatchPredictionJob(request, options, callback)

createBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IBatchPredictionJob, protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.aiplatform.v1.IBatchPredictionJob, protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createBatchPredictionJob(request, callback)

createBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IBatchPredictionJob, protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest`
callback	`Callback<protos.google.cloud.aiplatform.v1.IBatchPredictionJob, protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createCustomJob(request, options)

createCustomJob(request?: protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.ICustomJob,
        protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.ICustomJob, protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest \| undefined, {} \| undefined ]>

createCustomJob(request, options, callback)

createCustomJob(request: protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.ICustomJob, protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.aiplatform.v1.ICustomJob, protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createCustomJob(request, callback)

createCustomJob(request: protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1.ICustomJob, protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest`
callback	`Callback<protos.google.cloud.aiplatform.v1.ICustomJob, protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createDataLabelingJob(request, options)

createDataLabelingJob(request?: protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IDataLabelingJob,
        (protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.IDataLabelingJob, (protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest \| undefined), {} \| undefined ]>

createDataLabelingJob(request, options, callback)

createDataLabelingJob(request: protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IDataLabelingJob, protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.aiplatform.v1.IDataLabelingJob, protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createDataLabelingJob(request, callback)

createDataLabelingJob(request: protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IDataLabelingJob, protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest`
callback	`Callback<protos.google.cloud.aiplatform.v1.IDataLabelingJob, protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createHyperparameterTuningJob(request, options)

createHyperparameterTuningJob(request?: protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob,
        (protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob, (protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest \| undefined), {} \| undefined ]>

createHyperparameterTuningJob(request, options, callback)

createHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob, protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob, protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createHyperparameterTuningJob(request, callback)

createHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob, protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest`
callback	`Callback<protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob, protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

customJobPath(project, location, customJob)

customJobPath(project: string, location: string, customJob: string): string;

Return a fully-qualified customJob resource name string.

Parameters

Name	Description
project	`string`
location	`string`
customJob	`string`

Returns

Type	Description
string	{string} Resource name string.

dataItemPath(project, location, dataset, dataItem)

dataItemPath(project: string, location: string, dataset: string, dataItem: string): string;

Return a fully-qualified dataItem resource name string.

Parameters

Name	Description
project	`string`
location	`string`
dataset	`string`
dataItem	`string`

Returns

Type	Description
string	{string} Resource name string.

dataLabelingJobPath(project, location, dataLabelingJob)

dataLabelingJobPath(project: string, location: string, dataLabelingJob: string): string;

Return a fully-qualified dataLabelingJob resource name string.

Parameters

Name	Description
project	`string`
location	`string`
dataLabelingJob	`string`

Returns

Type	Description
string	{string} Resource name string.

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.

deleteBatchPredictionJob(request, options)

deleteBatchPredictionJob(request?: protos.google.cloud.aiplatform.v1.IDeleteBatchPredictionJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeleteBatchPredictionJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

deleteBatchPredictionJob(request, options, callback)

deleteBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.IDeleteBatchPredictionJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeleteBatchPredictionJobRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteBatchPredictionJob(request, callback)

deleteBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.IDeleteBatchPredictionJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeleteBatchPredictionJobRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteCustomJob(request, options)

deleteCustomJob(request?: protos.google.cloud.aiplatform.v1.IDeleteCustomJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeleteCustomJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

deleteCustomJob(request, options, callback)

deleteCustomJob(request: protos.google.cloud.aiplatform.v1.IDeleteCustomJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeleteCustomJobRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteCustomJob(request, callback)

deleteCustomJob(request: protos.google.cloud.aiplatform.v1.IDeleteCustomJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeleteCustomJobRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteDataLabelingJob(request, options)

deleteDataLabelingJob(request?: protos.google.cloud.aiplatform.v1.IDeleteDataLabelingJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeleteDataLabelingJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

deleteDataLabelingJob(request, options, callback)

deleteDataLabelingJob(request: protos.google.cloud.aiplatform.v1.IDeleteDataLabelingJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeleteDataLabelingJobRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteDataLabelingJob(request, callback)

deleteDataLabelingJob(request: protos.google.cloud.aiplatform.v1.IDeleteDataLabelingJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeleteDataLabelingJobRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteHyperparameterTuningJob(request, options)

deleteHyperparameterTuningJob(request?: protos.google.cloud.aiplatform.v1.IDeleteHyperparameterTuningJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeleteHyperparameterTuningJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

deleteHyperparameterTuningJob(request, options, callback)

deleteHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.IDeleteHyperparameterTuningJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeleteHyperparameterTuningJobRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteHyperparameterTuningJob(request, callback)

deleteHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.IDeleteHyperparameterTuningJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeleteHyperparameterTuningJobRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

endpointPath(project, location, endpoint)

endpointPath(project: string, location: string, endpoint: string): string;

Return a fully-qualified endpoint resource name string.

Parameters

Name	Description
project	`string`
location	`string`
endpoint	`string`

Returns

Type	Description
string	{string} Resource name string.

getBatchPredictionJob(request, options)

getBatchPredictionJob(request?: protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IBatchPredictionJob,
        (protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.IBatchPredictionJob, (protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest \| undefined), {} \| undefined ]>

getBatchPredictionJob(request, options, callback)

getBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IBatchPredictionJob, protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.aiplatform.v1.IBatchPredictionJob, protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getBatchPredictionJob(request, callback)

getBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IBatchPredictionJob, protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest`
callback	`Callback<protos.google.cloud.aiplatform.v1.IBatchPredictionJob, protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getCustomJob(request, options)

getCustomJob(request?: protos.google.cloud.aiplatform.v1.IGetCustomJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.ICustomJob,
        protos.google.cloud.aiplatform.v1.IGetCustomJobRequest | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetCustomJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.ICustomJob, protos.google.cloud.aiplatform.v1.IGetCustomJobRequest \| undefined, {} \| undefined ]>

getCustomJob(request, options, callback)

getCustomJob(request: protos.google.cloud.aiplatform.v1.IGetCustomJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.ICustomJob, protos.google.cloud.aiplatform.v1.IGetCustomJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetCustomJobRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.aiplatform.v1.ICustomJob, protos.google.cloud.aiplatform.v1.IGetCustomJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getCustomJob(request, callback)

getCustomJob(request: protos.google.cloud.aiplatform.v1.IGetCustomJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1.ICustomJob, protos.google.cloud.aiplatform.v1.IGetCustomJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetCustomJobRequest`
callback	`Callback<protos.google.cloud.aiplatform.v1.ICustomJob, protos.google.cloud.aiplatform.v1.IGetCustomJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getDataLabelingJob(request, options)

getDataLabelingJob(request?: protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IDataLabelingJob,
        protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.IDataLabelingJob, protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest \| undefined, {} \| undefined ]>

getDataLabelingJob(request, options, callback)

getDataLabelingJob(request: protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IDataLabelingJob, protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.aiplatform.v1.IDataLabelingJob, protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getDataLabelingJob(request, callback)

getDataLabelingJob(request: protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IDataLabelingJob, protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest`
callback	`Callback<protos.google.cloud.aiplatform.v1.IDataLabelingJob, protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getHyperparameterTuningJob(request, options)

getHyperparameterTuningJob(request?: protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob,
        (protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob, (protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest \| undefined), {} \| undefined ]>

getHyperparameterTuningJob(request, options, callback)

getHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob, protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob, protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getHyperparameterTuningJob(request, callback)

getHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob, protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest`
callback	`Callback<protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob, protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest \| 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

hyperparameterTuningJobPath(project, location, hyperparameterTuningJob)

hyperparameterTuningJobPath(project: string, location: string, hyperparameterTuningJob: string): string;

Return a fully-qualified hyperparameterTuningJob resource name string.

Parameters

Name	Description
project	`string`
location	`string`
hyperparameterTuningJob	`string`

Returns

Type	Description
string	{string} Resource name string.

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.

listBatchPredictionJobs(request, options)

listBatchPredictionJobs(request?: protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IBatchPredictionJob[],
        protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest | null,
        protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsResponse
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.IBatchPredictionJob[], protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest \| null, protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsResponse ]>

listBatchPredictionJobs(request, options, callback)

listBatchPredictionJobs(request: protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest, protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IBatchPredictionJob>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest, protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsResponse \| null \| undefined, protos.google.cloud.aiplatform.v1.IBatchPredictionJob>`

Returns

Type	Description
void

listBatchPredictionJobs(request, callback)

listBatchPredictionJobs(request: protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest, protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IBatchPredictionJob>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest`
callback	`PaginationCallback<protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest, protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsResponse \| null \| undefined, protos.google.cloud.aiplatform.v1.IBatchPredictionJob>`

Returns

Type	Description
void

listBatchPredictionJobsAsync(request, options)

listBatchPredictionJobsAsync(request?: protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.IBatchPredictionJob>;

Equivalent to listBatchPredictionJobs, 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.aiplatform.v1.IListBatchPredictionJobsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.aiplatform.v1.IBatchPredictionJob>

{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 [BatchPredictionJob]. 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.

listBatchPredictionJobsStream(request, options)

listBatchPredictionJobsStream(request?: protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest` 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 [BatchPredictionJob] 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 listBatchPredictionJobsAsync() 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.

listCustomJobs(request, options)

listCustomJobs(request?: protos.google.cloud.aiplatform.v1.IListCustomJobsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.ICustomJob[],
        protos.google.cloud.aiplatform.v1.IListCustomJobsRequest | null,
        protos.google.cloud.aiplatform.v1.IListCustomJobsResponse
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListCustomJobsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.ICustomJob[], protos.google.cloud.aiplatform.v1.IListCustomJobsRequest \| null, protos.google.cloud.aiplatform.v1.IListCustomJobsResponse ]>

listCustomJobs(request, options, callback)

listCustomJobs(request: protos.google.cloud.aiplatform.v1.IListCustomJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListCustomJobsRequest, protos.google.cloud.aiplatform.v1.IListCustomJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1.ICustomJob>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListCustomJobsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.aiplatform.v1.IListCustomJobsRequest, protos.google.cloud.aiplatform.v1.IListCustomJobsResponse \| null \| undefined, protos.google.cloud.aiplatform.v1.ICustomJob>`

Returns

Type	Description
void

listCustomJobs(request, callback)

listCustomJobs(request: protos.google.cloud.aiplatform.v1.IListCustomJobsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListCustomJobsRequest, protos.google.cloud.aiplatform.v1.IListCustomJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1.ICustomJob>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListCustomJobsRequest`
callback	`PaginationCallback<protos.google.cloud.aiplatform.v1.IListCustomJobsRequest, protos.google.cloud.aiplatform.v1.IListCustomJobsResponse \| null \| undefined, protos.google.cloud.aiplatform.v1.ICustomJob>`

Returns

Type	Description
void

listCustomJobsAsync(request, options)

listCustomJobsAsync(request?: protos.google.cloud.aiplatform.v1.IListCustomJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.ICustomJob>;

Equivalent to listCustomJobs, 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.aiplatform.v1.IListCustomJobsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.aiplatform.v1.ICustomJob>

{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 [CustomJob]. 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.

listCustomJobsStream(request, options)

listCustomJobsStream(request?: protos.google.cloud.aiplatform.v1.IListCustomJobsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListCustomJobsRequest` 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 [CustomJob] 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 listCustomJobsAsync() 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.

listDataLabelingJobs(request, options)

listDataLabelingJobs(request?: protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IDataLabelingJob[],
        protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest | null,
        protos.google.cloud.aiplatform.v1.IListDataLabelingJobsResponse
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.IDataLabelingJob[], protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest \| null, protos.google.cloud.aiplatform.v1.IListDataLabelingJobsResponse ]>

listDataLabelingJobs(request, options, callback)

listDataLabelingJobs(request: protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest, protos.google.cloud.aiplatform.v1.IListDataLabelingJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IDataLabelingJob>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest, protos.google.cloud.aiplatform.v1.IListDataLabelingJobsResponse \| null \| undefined, protos.google.cloud.aiplatform.v1.IDataLabelingJob>`

Returns

Type	Description
void

listDataLabelingJobs(request, callback)

listDataLabelingJobs(request: protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest, protos.google.cloud.aiplatform.v1.IListDataLabelingJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IDataLabelingJob>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest`
callback	`PaginationCallback<protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest, protos.google.cloud.aiplatform.v1.IListDataLabelingJobsResponse \| null \| undefined, protos.google.cloud.aiplatform.v1.IDataLabelingJob>`

Returns

Type	Description
void

listDataLabelingJobsAsync(request, options)

listDataLabelingJobsAsync(request?: protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.IDataLabelingJob>;

Equivalent to listDataLabelingJobs, 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.aiplatform.v1.IListDataLabelingJobsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.aiplatform.v1.IDataLabelingJob>

{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 [DataLabelingJob]. 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.

listDataLabelingJobsStream(request, options)

listDataLabelingJobsStream(request?: protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest` 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 [DataLabelingJob] 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 listDataLabelingJobsAsync() 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.

listHyperparameterTuningJobs(request, options)

listHyperparameterTuningJobs(request?: protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob[],
        protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest | null,
        protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsResponse
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob[], protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest \| null, protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsResponse ]>

listHyperparameterTuningJobs(request, options, callback)

listHyperparameterTuningJobs(request: protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest, protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest, protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsResponse \| null \| undefined, protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob>`

Returns

Type	Description
void

listHyperparameterTuningJobs(request, callback)

listHyperparameterTuningJobs(request: protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest, protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest`
callback	`PaginationCallback<protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest, protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsResponse \| null \| undefined, protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob>`

Returns

Type	Description
void

listHyperparameterTuningJobsAsync(request, options)

listHyperparameterTuningJobsAsync(request?: protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob>;

Equivalent to listHyperparameterTuningJobs, 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.aiplatform.v1.IListHyperparameterTuningJobsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob>

{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 [HyperparameterTuningJob]. 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.

listHyperparameterTuningJobsStream(request, options)

listHyperparameterTuningJobsStream(request?: protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest` 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 [HyperparameterTuningJob] 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 listHyperparameterTuningJobsAsync() 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.

matchAnnotationFromAnnotationName(annotationName)

matchAnnotationFromAnnotationName(annotationName: string): string | number;

Parse the annotation from Annotation resource.

Parameter

Name	Description
annotationName	`string` A fully-qualified path representing Annotation resource.

Returns

Type	Description
string \| number	{string} A string representing the annotation.

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.

matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName)

matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the batch_prediction_job from BatchPredictionJob resource.

Parameter

Name	Description
batchPredictionJobName	`string` A fully-qualified path representing BatchPredictionJob resource.

Returns

Type	Description
string \| number	{string} A string representing the batch_prediction_job.

matchCustomJobFromCustomJobName(customJobName)

matchCustomJobFromCustomJobName(customJobName: string): string | number;

Parse the custom_job from CustomJob resource.

Parameter

Name	Description
customJobName	`string` A fully-qualified path representing CustomJob resource.

Returns

Type	Description
string \| number	{string} A string representing the custom_job.

matchDataItemFromAnnotationName(annotationName)

matchDataItemFromAnnotationName(annotationName: string): string | number;

Parse the data_item from Annotation resource.

Parameter

Name	Description
annotationName	`string` A fully-qualified path representing Annotation resource.

Returns

Type	Description
string \| number	{string} A string representing the data_item.

matchDataItemFromDataItemName(dataItemName)

matchDataItemFromDataItemName(dataItemName: string): string | number;

Parse the data_item from DataItem resource.

Parameter

Name	Description
dataItemName	`string` A fully-qualified path representing DataItem resource.

Returns

Type	Description
string \| number	{string} A string representing the data_item.

matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName)

matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName: string): string | number;

Parse the data_labeling_job from DataLabelingJob resource.

Parameter

Name	Description
dataLabelingJobName	`string` A fully-qualified path representing DataLabelingJob resource.

Returns

Type	Description
string \| number	{string} A string representing the data_labeling_job.

matchDatasetFromAnnotationName(annotationName)

matchDatasetFromAnnotationName(annotationName: string): string | number;

Parse the dataset from Annotation resource.

Parameter

Name	Description
annotationName	`string` A fully-qualified path representing Annotation resource.

Returns

Type	Description
string \| number	{string} A string representing the dataset.

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.

matchDatasetFromDataItemName(dataItemName)

matchDatasetFromDataItemName(dataItemName: string): string | number;

Parse the dataset from DataItem resource.

Parameter

Name	Description
dataItemName	`string` A fully-qualified path representing DataItem 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.

matchEndpointFromEndpointName(endpointName)

matchEndpointFromEndpointName(endpointName: string): string | number;

Parse the endpoint from Endpoint resource.

Parameter

Name	Description
endpointName	`string` A fully-qualified path representing Endpoint resource.

Returns

Type	Description
string \| number	{string} A string representing the endpoint.

matchEvaluationFromModelEvaluationName(modelEvaluationName)

matchEvaluationFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the 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 evaluation.

matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName)

matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the evaluation from ModelEvaluationSlice resource.

Parameter

Name	Description
modelEvaluationSliceName	`string` A fully-qualified path representing ModelEvaluationSlice resource.

Returns

Type	Description
string \| number	{string} A string representing the evaluation.

matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName)

matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;

Parse the hyperparameter_tuning_job from HyperparameterTuningJob resource.

Parameter

Name	Description
hyperparameterTuningJobName	`string` A fully-qualified path representing HyperparameterTuningJob resource.

Returns

Type	Description
string \| number	{string} A string representing the hyperparameter_tuning_job.

matchLocationFromAnnotationName(annotationName)

matchLocationFromAnnotationName(annotationName: string): string | number;

Parse the location from Annotation resource.

Parameter

Name	Description
annotationName	`string` A fully-qualified path representing Annotation resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

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.

matchLocationFromBatchPredictionJobName(batchPredictionJobName)

matchLocationFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the location from BatchPredictionJob resource.

Parameter

Name	Description
batchPredictionJobName	`string` A fully-qualified path representing BatchPredictionJob resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromCustomJobName(customJobName)

matchLocationFromCustomJobName(customJobName: string): string | number;

Parse the location from CustomJob resource.

Parameter

Name	Description
customJobName	`string` A fully-qualified path representing CustomJob resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromDataItemName(dataItemName)

matchLocationFromDataItemName(dataItemName: string): string | number;

Parse the location from DataItem resource.

Parameter

Name	Description
dataItemName	`string` A fully-qualified path representing DataItem resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromDataLabelingJobName(dataLabelingJobName)

matchLocationFromDataLabelingJobName(dataLabelingJobName: string): string | number;

Parse the location from DataLabelingJob resource.

Parameter

Name	Description
dataLabelingJobName	`string` A fully-qualified path representing DataLabelingJob 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.

matchLocationFromEndpointName(endpointName)

matchLocationFromEndpointName(endpointName: string): string | number;

Parse the location from Endpoint resource.

Parameter

Name	Description
endpointName	`string` A fully-qualified path representing Endpoint resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName)

matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;

Parse the location from HyperparameterTuningJob resource.

Parameter

Name	Description
hyperparameterTuningJobName	`string` A fully-qualified path representing HyperparameterTuningJob 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.

matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName)

matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the location from ModelEvaluationSlice resource.

Parameter

Name	Description
modelEvaluationSliceName	`string` A fully-qualified path representing ModelEvaluationSlice 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.

matchLocationFromSpecialistPoolName(specialistPoolName)

matchLocationFromSpecialistPoolName(specialistPoolName: string): string | number;

Parse the location from SpecialistPool resource.

Parameter

Name	Description
specialistPoolName	`string` A fully-qualified path representing SpecialistPool resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromTrainingPipelineName(trainingPipelineName)

matchLocationFromTrainingPipelineName(trainingPipelineName: string): string | number;

Parse the location from TrainingPipeline resource.

Parameter

Name	Description
trainingPipelineName	`string` A fully-qualified path representing TrainingPipeline resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromTrialName(trialName)

matchLocationFromTrialName(trialName: string): string | number;

Parse the location from Trial resource.

Parameter

Name	Description
trialName	`string` A fully-qualified path representing Trial resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

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.

matchModelFromModelEvaluationSliceName(modelEvaluationSliceName)

matchModelFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the model from ModelEvaluationSlice resource.

Parameter

Name	Description
modelEvaluationSliceName	`string` A fully-qualified path representing ModelEvaluationSlice 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.

matchProjectFromAnnotationName(annotationName)

matchProjectFromAnnotationName(annotationName: string): string | number;

Parse the project from Annotation resource.

Parameter

Name	Description
annotationName	`string` A fully-qualified path representing Annotation resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

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.

matchProjectFromBatchPredictionJobName(batchPredictionJobName)

matchProjectFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the project from BatchPredictionJob resource.

Parameter

Name	Description
batchPredictionJobName	`string` A fully-qualified path representing BatchPredictionJob resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromCustomJobName(customJobName)

matchProjectFromCustomJobName(customJobName: string): string | number;

Parse the project from CustomJob resource.

Parameter

Name	Description
customJobName	`string` A fully-qualified path representing CustomJob resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromDataItemName(dataItemName)

matchProjectFromDataItemName(dataItemName: string): string | number;

Parse the project from DataItem resource.

Parameter

Name	Description
dataItemName	`string` A fully-qualified path representing DataItem resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromDataLabelingJobName(dataLabelingJobName)

matchProjectFromDataLabelingJobName(dataLabelingJobName: string): string | number;

Parse the project from DataLabelingJob resource.

Parameter

Name	Description
dataLabelingJobName	`string` A fully-qualified path representing DataLabelingJob 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.

matchProjectFromEndpointName(endpointName)

matchProjectFromEndpointName(endpointName: string): string | number;

Parse the project from Endpoint resource.

Parameter

Name	Description
endpointName	`string` A fully-qualified path representing Endpoint resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromHyperparameterTuningJobName(hyperparameterTuningJobName)

matchProjectFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;

Parse the project from HyperparameterTuningJob resource.

Parameter

Name	Description
hyperparameterTuningJobName	`string` A fully-qualified path representing HyperparameterTuningJob 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.

matchProjectFromModelEvaluationSliceName(modelEvaluationSliceName)

matchProjectFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the project from ModelEvaluationSlice resource.

Parameter

Name	Description
modelEvaluationSliceName	`string` A fully-qualified path representing ModelEvaluationSlice 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.

matchProjectFromSpecialistPoolName(specialistPoolName)

matchProjectFromSpecialistPoolName(specialistPoolName: string): string | number;

Parse the project from SpecialistPool resource.

Parameter

Name	Description
specialistPoolName	`string` A fully-qualified path representing SpecialistPool resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromTrainingPipelineName(trainingPipelineName)

matchProjectFromTrainingPipelineName(trainingPipelineName: string): string | number;

Parse the project from TrainingPipeline resource.

Parameter

Name	Description
trainingPipelineName	`string` A fully-qualified path representing TrainingPipeline resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromTrialName(trialName)

matchProjectFromTrialName(trialName: string): string | number;

Parse the project from Trial resource.

Parameter

Name	Description
trialName	`string` A fully-qualified path representing Trial resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchSliceFromModelEvaluationSliceName(modelEvaluationSliceName)

matchSliceFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the slice from ModelEvaluationSlice resource.

Parameter

Name	Description
modelEvaluationSliceName	`string` A fully-qualified path representing ModelEvaluationSlice resource.

Returns

Type	Description
string \| number	{string} A string representing the slice.

matchSpecialistPoolFromSpecialistPoolName(specialistPoolName)

matchSpecialistPoolFromSpecialistPoolName(specialistPoolName: string): string | number;

Parse the specialist_pool from SpecialistPool resource.

Parameter

Name	Description
specialistPoolName	`string` A fully-qualified path representing SpecialistPool resource.

Returns

Type	Description
string \| number	{string} A string representing the specialist_pool.

matchStudyFromTrialName(trialName)

matchStudyFromTrialName(trialName: string): string | number;

Parse the study from Trial resource.

Parameter

Name	Description
trialName	`string` A fully-qualified path representing Trial resource.

Returns

Type	Description
string \| number	{string} A string representing the study.

matchTrainingPipelineFromTrainingPipelineName(trainingPipelineName)

matchTrainingPipelineFromTrainingPipelineName(trainingPipelineName: string): string | number;

Parse the training_pipeline from TrainingPipeline resource.

Parameter

Name	Description
trainingPipelineName	`string` A fully-qualified path representing TrainingPipeline resource.

Returns

Type	Description
string \| number	{string} A string representing the training_pipeline.

matchTrialFromTrialName(trialName)

matchTrialFromTrialName(trialName: string): string | number;

Parse the trial from Trial resource.

Parameter

Name	Description
trialName	`string` A fully-qualified path representing Trial resource.

Returns

Type	Description
string \| number	{string} A string representing the trial.

modelEvaluationPath(project, location, model, evaluation)

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

Return a fully-qualified modelEvaluation resource name string.

Parameters

Name	Description
project	`string`
location	`string`
model	`string`
evaluation	`string`

Returns

Type	Description
string	{string} Resource name string.

modelEvaluationSlicePath(project, location, model, evaluation, slice)

modelEvaluationSlicePath(project: string, location: string, model: string, evaluation: string, slice: string): string;

Return a fully-qualified modelEvaluationSlice resource name string.

Parameters

Name	Description
project	`string`
location	`string`
model	`string`
evaluation	`string`
slice	`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.

specialistPoolPath(project, location, specialistPool)

specialistPoolPath(project: string, location: string, specialistPool: string): string;

Return a fully-qualified specialistPool resource name string.

Parameters

Name	Description
project	`string`
location	`string`
specialistPool	`string`

Returns

Type	Description
string	{string} Resource name string.

trainingPipelinePath(project, location, trainingPipeline)

trainingPipelinePath(project: string, location: string, trainingPipeline: string): string;

Return a fully-qualified trainingPipeline resource name string.

Parameters

Name	Description
project	`string`
location	`string`
trainingPipeline	`string`

Returns

Type	Description
string	{string} Resource name string.

trialPath(project, location, study, trial)

trialPath(project: string, location: string, study: string, trial: string): string;

Return a fully-qualified trial resource name string.

Parameters

Name	Description
project	`string`
location	`string`
study	`string`
trial	`string`

Returns

Type	Description
string	{string} Resource name string.