Class v1.PipelineServiceClient (1.11.0)

A service for creating and managing Vertex AI's pipelines. This includes both TrainingPipeline resources (used for AutoML and custom training) and PipelineJob resources (used for Vertex Pipelines). v1

Package

@google-cloud/aiplatform

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of PipelineServiceClient.

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; }

operationsClient

operationsClient: gax.OperationsClient;

Property Value

Type	Description
gax.OperationsClient

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

Property Value

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

pipelineServiceStub

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

Property Value

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

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

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.

artifactPath(project, location, metadataStore, artifact)

artifactPath(project: string, location: string, metadataStore: string, artifact: string): string;

Return a fully-qualified artifact resource name string.

Parameters

Name	Description
project	`string`
location	`string`
metadataStore	`string`
artifact	`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.

cancelPipelineJob(request, options)

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

Parameters

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

Returns

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

cancelPipelineJob(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

cancelPipelineJob(request, callback)

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

Parameters

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

Returns

Type	Description
void

cancelTrainingPipeline(request, options)

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

Parameters

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

Returns

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

cancelTrainingPipeline(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

cancelTrainingPipeline(request, callback)

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

Parameters

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

Returns

Type	Description
void

checkDeletePipelineJobProgress(name)

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

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

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.

Example

const decodedOperation = await checkDeletePipelineJobProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);

checkDeleteTrainingPipelineProgress(name)

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

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

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.

Example

const decodedOperation = await checkDeleteTrainingPipelineProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);

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.

contextPath(project, location, metadataStore, context)

contextPath(project: string, location: string, metadataStore: string, context: string): string;

Return a fully-qualified context resource name string.

Parameters

Name	Description
project	`string`
location	`string`
metadataStore	`string`
context	`string`

Returns

Type	Description
string	{string} Resource name string.

createPipelineJob(request, options)

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

Parameters

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

Returns

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

createPipelineJob(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

createPipelineJob(request, callback)

createPipelineJob(request: protos.google.cloud.aiplatform.v1.ICreatePipelineJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IPipelineJob, protos.google.cloud.aiplatform.v1.ICreatePipelineJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

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

Returns

Type	Description
void

createTrainingPipeline(request, options)

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

Parameters

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

Returns

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

createTrainingPipeline(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

createTrainingPipeline(request, callback)

createTrainingPipeline(request: protos.google.cloud.aiplatform.v1.ICreateTrainingPipelineRequest, callback: Callback<protos.google.cloud.aiplatform.v1.ITrainingPipeline, protos.google.cloud.aiplatform.v1.ICreateTrainingPipelineRequest | null | undefined, {} | null | undefined>): void;

Parameters

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

deletePipelineJob(request, options)

deletePipelineJob(request?: protos.google.cloud.aiplatform.v1.IDeletePipelineJobRequest, 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.IDeletePipelineJobRequest`
options	`CallOptions`

Returns

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

deletePipelineJob(request, options, callback)

deletePipelineJob(request: protos.google.cloud.aiplatform.v1.IDeletePipelineJobRequest, 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.IDeletePipelineJobRequest`
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

deletePipelineJob(request, callback)

deletePipelineJob(request: protos.google.cloud.aiplatform.v1.IDeletePipelineJobRequest, 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.IDeletePipelineJobRequest`
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

deleteTrainingPipeline(request, options)

deleteTrainingPipeline(request?: protos.google.cloud.aiplatform.v1.IDeleteTrainingPipelineRequest, 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.IDeleteTrainingPipelineRequest`
options	`CallOptions`

Returns

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

deleteTrainingPipeline(request, options, callback)

deleteTrainingPipeline(request: protos.google.cloud.aiplatform.v1.IDeleteTrainingPipelineRequest, 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.IDeleteTrainingPipelineRequest`
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

deleteTrainingPipeline(request, callback)

deleteTrainingPipeline(request: protos.google.cloud.aiplatform.v1.IDeleteTrainingPipelineRequest, 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.IDeleteTrainingPipelineRequest`
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.

entityTypePath(project, location, featurestore, entityType)

entityTypePath(project: string, location: string, featurestore: string, entityType: string): string;

Return a fully-qualified entityType resource name string.

Parameters

Name	Description
project	`string`
location	`string`
featurestore	`string`
entityType	`string`

Returns

Type	Description
string	{string} Resource name string.

executionPath(project, location, metadataStore, execution)

executionPath(project: string, location: string, metadataStore: string, execution: string): string;

Return a fully-qualified execution resource name string.

Parameters

Name	Description
project	`string`
location	`string`
metadataStore	`string`
execution	`string`

Returns

Type	Description
string	{string} Resource name string.

featurePath(project, location, featurestore, entityType, feature)

featurePath(project: string, location: string, featurestore: string, entityType: string, feature: string): string;

Return a fully-qualified feature resource name string.

Parameters

Name	Description
project	`string`
location	`string`
featurestore	`string`
entityType	`string`
feature	`string`

Returns

Type	Description
string	{string} Resource name string.

featurestorePath(project, location, featurestore)

featurestorePath(project: string, location: string, featurestore: string): string;

Return a fully-qualified featurestore resource name string.

Parameters

Name	Description
project	`string`
location	`string`
featurestore	`string`

Returns

Type	Description
string	{string} Resource name string.

getPipelineJob(request, options)

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

Parameters

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

Returns

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

getPipelineJob(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

getPipelineJob(request, callback)

getPipelineJob(request: protos.google.cloud.aiplatform.v1.IGetPipelineJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IPipelineJob, protos.google.cloud.aiplatform.v1.IGetPipelineJobRequest | null | undefined, {} | null | undefined>): void;

Parameters

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

getTrainingPipeline(request, options)

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

Parameters

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

Returns

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

getTrainingPipeline(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

getTrainingPipeline(request, callback)

getTrainingPipeline(request: protos.google.cloud.aiplatform.v1.IGetTrainingPipelineRequest, callback: Callback<protos.google.cloud.aiplatform.v1.ITrainingPipeline, protos.google.cloud.aiplatform.v1.IGetTrainingPipelineRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetTrainingPipelineRequest`
callback	`Callback<protos.google.cloud.aiplatform.v1.ITrainingPipeline, protos.google.cloud.aiplatform.v1.IGetTrainingPipelineRequest \| null \| undefined, {} \| null \| 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.

indexEndpointPath(project, location, indexEndpoint)

indexEndpointPath(project: string, location: string, indexEndpoint: string): string;

Return a fully-qualified indexEndpoint resource name string.

Parameters

Name	Description
project	`string`
location	`string`
indexEndpoint	`string`

Returns

Type	Description
string	{string} Resource name string.

indexPath(project, location, index)

indexPath(project: string, location: string, index: string): string;

Return a fully-qualified index resource name string.

Parameters

Name	Description
project	`string`
location	`string`
index	`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.

listPipelineJobs(request, options)

listPipelineJobs(request?: protos.google.cloud.aiplatform.v1.IListPipelineJobsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IPipelineJob[],
        protos.google.cloud.aiplatform.v1.IListPipelineJobsRequest | null,
        protos.google.cloud.aiplatform.v1.IListPipelineJobsResponse
    ]>;

Parameters

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

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.IPipelineJob[], protos.google.cloud.aiplatform.v1.IListPipelineJobsRequest \| null, protos.google.cloud.aiplatform.v1.IListPipelineJobsResponse ]>

listPipelineJobs(request, options, callback)

listPipelineJobs(request: protos.google.cloud.aiplatform.v1.IListPipelineJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListPipelineJobsRequest, protos.google.cloud.aiplatform.v1.IListPipelineJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IPipelineJob>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListPipelineJobsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.aiplatform.v1.IListPipelineJobsRequest, protos.google.cloud.aiplatform.v1.IListPipelineJobsResponse \| null \| undefined, protos.google.cloud.aiplatform.v1.IPipelineJob>`

Returns

Type	Description
void

listPipelineJobs(request, callback)

listPipelineJobs(request: protos.google.cloud.aiplatform.v1.IListPipelineJobsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListPipelineJobsRequest, protos.google.cloud.aiplatform.v1.IListPipelineJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IPipelineJob>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListPipelineJobsRequest`
callback	`PaginationCallback<protos.google.cloud.aiplatform.v1.IListPipelineJobsRequest, protos.google.cloud.aiplatform.v1.IListPipelineJobsResponse \| null \| undefined, protos.google.cloud.aiplatform.v1.IPipelineJob>`

Returns

Type	Description
void

listPipelineJobsAsync(request, options)

listPipelineJobsAsync(request?: protos.google.cloud.aiplatform.v1.IListPipelineJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.IPipelineJob>;

Equivalent to listPipelineJobs, 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.IListPipelineJobsRequest` 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.IPipelineJob>

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

Example

const iterable = client.listPipelineJobsAsync(request); for await (const response of iterable) { // process response }

listPipelineJobsStream(request, options)

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

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

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListPipelineJobsRequest` 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 [PipelineJob] 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 listPipelineJobsAsync() 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.

listTrainingPipelines(request, options)

listTrainingPipelines(request?: protos.google.cloud.aiplatform.v1.IListTrainingPipelinesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.ITrainingPipeline[],
        protos.google.cloud.aiplatform.v1.IListTrainingPipelinesRequest | null,
        protos.google.cloud.aiplatform.v1.IListTrainingPipelinesResponse
    ]>;

Parameters

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

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.ITrainingPipeline[], protos.google.cloud.aiplatform.v1.IListTrainingPipelinesRequest \| null, protos.google.cloud.aiplatform.v1.IListTrainingPipelinesResponse ]>

listTrainingPipelines(request, options, callback)

listTrainingPipelines(request: protos.google.cloud.aiplatform.v1.IListTrainingPipelinesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListTrainingPipelinesRequest, protos.google.cloud.aiplatform.v1.IListTrainingPipelinesResponse | null | undefined, protos.google.cloud.aiplatform.v1.ITrainingPipeline>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListTrainingPipelinesRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.aiplatform.v1.IListTrainingPipelinesRequest, protos.google.cloud.aiplatform.v1.IListTrainingPipelinesResponse \| null \| undefined, protos.google.cloud.aiplatform.v1.ITrainingPipeline>`

Returns

Type	Description
void

listTrainingPipelines(request, callback)

listTrainingPipelines(request: protos.google.cloud.aiplatform.v1.IListTrainingPipelinesRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListTrainingPipelinesRequest, protos.google.cloud.aiplatform.v1.IListTrainingPipelinesResponse | null | undefined, protos.google.cloud.aiplatform.v1.ITrainingPipeline>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListTrainingPipelinesRequest`
callback	`PaginationCallback<protos.google.cloud.aiplatform.v1.IListTrainingPipelinesRequest, protos.google.cloud.aiplatform.v1.IListTrainingPipelinesResponse \| null \| undefined, protos.google.cloud.aiplatform.v1.ITrainingPipeline>`

Returns

Type	Description
void

listTrainingPipelinesAsync(request, options)

listTrainingPipelinesAsync(request?: protos.google.cloud.aiplatform.v1.IListTrainingPipelinesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.ITrainingPipeline>;

Equivalent to listTrainingPipelines, 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.IListTrainingPipelinesRequest` 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.ITrainingPipeline>

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

Example

const iterable = client.listTrainingPipelinesAsync(request); for await (const response of iterable) { // process response }

listTrainingPipelinesStream(request, options)

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

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

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListTrainingPipelinesRequest` 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 [TrainingPipeline] 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 listTrainingPipelinesAsync() 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.

matchArtifactFromArtifactName(artifactName)

matchArtifactFromArtifactName(artifactName: string): string | number;

Parse the artifact from Artifact resource.

Parameter

Name	Description
artifactName	`string` A fully-qualified path representing Artifact resource.

Returns

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

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.

matchContextFromContextName(contextName)

matchContextFromContextName(contextName: string): string | number;

Parse the context from Context resource.

Parameter

Name	Description
contextName	`string` A fully-qualified path representing Context resource.

Returns

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

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.

matchEntityTypeFromEntityTypeName(entityTypeName)

matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;

Parse the entity_type from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

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

matchEntityTypeFromFeatureName(featureName)

matchEntityTypeFromFeatureName(featureName: string): string | number;

Parse the entity_type from Feature resource.

Parameter

Name	Description
featureName	`string` A fully-qualified path representing Feature resource.

Returns

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

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.

matchExecutionFromExecutionName(executionName)

matchExecutionFromExecutionName(executionName: string): string | number;

Parse the execution from Execution resource.

Parameter

Name	Description
executionName	`string` A fully-qualified path representing Execution resource.

Returns

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

matchFeatureFromFeatureName(featureName)

matchFeatureFromFeatureName(featureName: string): string | number;

Parse the feature from Feature resource.

Parameter

Name	Description
featureName	`string` A fully-qualified path representing Feature resource.

Returns

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

matchFeaturestoreFromEntityTypeName(entityTypeName)

matchFeaturestoreFromEntityTypeName(entityTypeName: string): string | number;

Parse the featurestore from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

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

matchFeaturestoreFromFeatureName(featureName)

matchFeaturestoreFromFeatureName(featureName: string): string | number;

Parse the featurestore from Feature resource.

Parameter

Name	Description
featureName	`string` A fully-qualified path representing Feature resource.

Returns

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

matchFeaturestoreFromFeaturestoreName(featurestoreName)

matchFeaturestoreFromFeaturestoreName(featurestoreName: string): string | number;

Parse the featurestore from Featurestore resource.

Parameter

Name	Description
featurestoreName	`string` A fully-qualified path representing Featurestore resource.

Returns

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

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.

matchIndexEndpointFromIndexEndpointName(indexEndpointName)

matchIndexEndpointFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the index_endpoint from IndexEndpoint resource.

Parameter

Name	Description
indexEndpointName	`string` A fully-qualified path representing IndexEndpoint resource.

Returns

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

matchIndexFromIndexName(indexName)

matchIndexFromIndexName(indexName: string): string | number;

Parse the index from Index resource.

Parameter

Name	Description
indexName	`string` A fully-qualified path representing Index resource.

Returns

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

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.

matchLocationFromArtifactName(artifactName)

matchLocationFromArtifactName(artifactName: string): string | number;

Parse the location from Artifact resource.

Parameter

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

matchLocationFromContextName(contextName)

matchLocationFromContextName(contextName: string): string | number;

Parse the location from Context resource.

Parameter

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

matchLocationFromEntityTypeName(entityTypeName)

matchLocationFromEntityTypeName(entityTypeName: string): string | number;

Parse the location from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

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

matchLocationFromExecutionName(executionName)

matchLocationFromExecutionName(executionName: string): string | number;

Parse the location from Execution resource.

Parameter

Name	Description
executionName	`string` A fully-qualified path representing Execution resource.

Returns

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

matchLocationFromFeatureName(featureName)

matchLocationFromFeatureName(featureName: string): string | number;

Parse the location from Feature resource.

Parameter

Name	Description
featureName	`string` A fully-qualified path representing Feature resource.

Returns

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

matchLocationFromFeaturestoreName(featurestoreName)

matchLocationFromFeaturestoreName(featurestoreName: string): string | number;

Parse the location from Featurestore resource.

Parameter

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

matchLocationFromIndexEndpointName(indexEndpointName)

matchLocationFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the location from IndexEndpoint resource.

Parameter

Name	Description
indexEndpointName	`string` A fully-qualified path representing IndexEndpoint resource.

Returns

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

matchLocationFromIndexName(indexName)

matchLocationFromIndexName(indexName: string): string | number;

Parse the location from Index resource.

Parameter

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

matchLocationFromMetadataSchemaName(metadataSchemaName)

matchLocationFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the location from MetadataSchema resource.

Parameter

Name	Description
metadataSchemaName	`string` A fully-qualified path representing MetadataSchema resource.

Returns

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

matchLocationFromMetadataStoreName(metadataStoreName)

matchLocationFromMetadataStoreName(metadataStoreName: string): string | number;

Parse the location from MetadataStore resource.

Parameter

Name	Description
metadataStoreName	`string` A fully-qualified path representing MetadataStore resource.

Returns

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

matchLocationFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName)

matchLocationFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number;

Parse the location from ModelDeploymentMonitoringJob resource.

Parameter

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

matchLocationFromPipelineJobName(pipelineJobName)

matchLocationFromPipelineJobName(pipelineJobName: string): string | number;

Parse the location from PipelineJob resource.

Parameter

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

matchLocationFromStudyName(studyName)

matchLocationFromStudyName(studyName: string): string | number;

Parse the location from Study resource.

Parameter

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

matchMetadataSchemaFromMetadataSchemaName(metadataSchemaName)

matchMetadataSchemaFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the metadata_schema from MetadataSchema resource.

Parameter

Name	Description
metadataSchemaName	`string` A fully-qualified path representing MetadataSchema resource.

Returns

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

matchMetadataStoreFromArtifactName(artifactName)

matchMetadataStoreFromArtifactName(artifactName: string): string | number;

Parse the metadata_store from Artifact resource.

Parameter

Name	Description
artifactName	`string` A fully-qualified path representing Artifact resource.

Returns

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

matchMetadataStoreFromContextName(contextName)

matchMetadataStoreFromContextName(contextName: string): string | number;

Parse the metadata_store from Context resource.

Parameter

Name	Description
contextName	`string` A fully-qualified path representing Context resource.

Returns

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

matchMetadataStoreFromExecutionName(executionName)

matchMetadataStoreFromExecutionName(executionName: string): string | number;

Parse the metadata_store from Execution resource.

Parameter

Name	Description
executionName	`string` A fully-qualified path representing Execution resource.

Returns

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

matchMetadataStoreFromMetadataSchemaName(metadataSchemaName)

matchMetadataStoreFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the metadata_store from MetadataSchema resource.

Parameter

Name	Description
metadataSchemaName	`string` A fully-qualified path representing MetadataSchema resource.

Returns

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

matchMetadataStoreFromMetadataStoreName(metadataStoreName)

matchMetadataStoreFromMetadataStoreName(metadataStoreName: string): string | number;

Parse the metadata_store from MetadataStore resource.

Parameter

Name	Description
metadataStoreName	`string` A fully-qualified path representing MetadataStore resource.

Returns

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

matchModelDeploymentMonitoringJobFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName)

matchModelDeploymentMonitoringJobFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number;

Parse the model_deployment_monitoring_job from ModelDeploymentMonitoringJob resource.

Parameter

Name	Description
modelDeploymentMonitoringJobName	`string` A fully-qualified path representing ModelDeploymentMonitoringJob resource.

Returns

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

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.

matchPipelineJobFromPipelineJobName(pipelineJobName)

matchPipelineJobFromPipelineJobName(pipelineJobName: string): string | number;

Parse the pipeline_job from PipelineJob resource.

Parameter

Name	Description
pipelineJobName	`string` A fully-qualified path representing PipelineJob resource.

Returns

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

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.

matchProjectFromArtifactName(artifactName)

matchProjectFromArtifactName(artifactName: string): string | number;

Parse the project from Artifact resource.

Parameter

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

matchProjectFromContextName(contextName)

matchProjectFromContextName(contextName: string): string | number;

Parse the project from Context resource.

Parameter

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

matchProjectFromEntityTypeName(entityTypeName)

matchProjectFromEntityTypeName(entityTypeName: string): string | number;

Parse the project from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

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

matchProjectFromExecutionName(executionName)

matchProjectFromExecutionName(executionName: string): string | number;

Parse the project from Execution resource.

Parameter

Name	Description
executionName	`string` A fully-qualified path representing Execution resource.

Returns

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

matchProjectFromFeatureName(featureName)

matchProjectFromFeatureName(featureName: string): string | number;

Parse the project from Feature resource.

Parameter

Name	Description
featureName	`string` A fully-qualified path representing Feature resource.

Returns

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

matchProjectFromFeaturestoreName(featurestoreName)

matchProjectFromFeaturestoreName(featurestoreName: string): string | number;

Parse the project from Featurestore resource.

Parameter

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

matchProjectFromIndexEndpointName(indexEndpointName)

matchProjectFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the project from IndexEndpoint resource.

Parameter

Name	Description
indexEndpointName	`string` A fully-qualified path representing IndexEndpoint resource.

Returns

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

matchProjectFromIndexName(indexName)

matchProjectFromIndexName(indexName: string): string | number;

Parse the project from Index resource.

Parameter

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

matchProjectFromMetadataSchemaName(metadataSchemaName)

matchProjectFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the project from MetadataSchema resource.

Parameter

Name	Description
metadataSchemaName	`string` A fully-qualified path representing MetadataSchema resource.

Returns

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

matchProjectFromMetadataStoreName(metadataStoreName)

matchProjectFromMetadataStoreName(metadataStoreName: string): string | number;

Parse the project from MetadataStore resource.

Parameter

Name	Description
metadataStoreName	`string` A fully-qualified path representing MetadataStore resource.

Returns

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

matchProjectFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName)

matchProjectFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number;

Parse the project from ModelDeploymentMonitoringJob resource.

Parameter

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

matchProjectFromPipelineJobName(pipelineJobName)

matchProjectFromPipelineJobName(pipelineJobName: string): string | number;

Parse the project from PipelineJob resource.

Parameter

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

matchProjectFromStudyName(studyName)

matchProjectFromStudyName(studyName: string): string | number;

Parse the project from Study resource.

Parameter

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

matchStudyFromStudyName(studyName)

matchStudyFromStudyName(studyName: string): string | number;

Parse the study from Study resource.

Parameter

Name	Description
studyName	`string` A fully-qualified path representing Study resource.

Returns

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

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.

metadataSchemaPath(project, location, metadataStore, metadataSchema)

metadataSchemaPath(project: string, location: string, metadataStore: string, metadataSchema: string): string;

Return a fully-qualified metadataSchema resource name string.

Parameters

Name	Description
project	`string`
location	`string`
metadataStore	`string`
metadataSchema	`string`

Returns

Type	Description
string	{string} Resource name string.

metadataStorePath(project, location, metadataStore)

metadataStorePath(project: string, location: string, metadataStore: string): string;

Return a fully-qualified metadataStore resource name string.

Parameters

Name	Description
project	`string`
location	`string`
metadataStore	`string`

Returns

Type	Description
string	{string} Resource name string.

modelDeploymentMonitoringJobPath(project, location, modelDeploymentMonitoringJob)

modelDeploymentMonitoringJobPath(project: string, location: string, modelDeploymentMonitoringJob: string): string;

Return a fully-qualified modelDeploymentMonitoringJob resource name string.

Parameters

Name	Description
project	`string`
location	`string`
modelDeploymentMonitoringJob	`string`

Returns

Type	Description
string	{string} Resource name string.

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.

pipelineJobPath(project, location, pipelineJob)

pipelineJobPath(project: string, location: string, pipelineJob: string): string;

Return a fully-qualified pipelineJob resource name string.

Parameters

Name	Description
project	`string`
location	`string`
pipelineJob	`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.

studyPath(project, location, study)

studyPath(project: string, location: string, study: string): string;

Return a fully-qualified study resource name string.

Parameters

Name	Description
project	`string`
location	`string`
study	`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.