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 AI Pipelines). v1
Package
@google-cloud/aiplatformConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of PipelineServiceClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
iamClient
iamClient: IamClient;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
locationsClient
locationsClient: LocationsClient;
operationsClient
operationsClient: gax.OperationsClient;
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
pipelineServiceStub
pipelineServiceStub?: Promise<{
[name: string]: Function;
}>;
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
warn
warn: (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. |
cancelOperation(request, options, callback)
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
CancelOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
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
]>;
Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
, and is set to CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
ICancelPipelineJobRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.aiplatform.v1.ICancelPipelineJobRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the PipelineJob to cancel.
* Format:
* `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1;
// Instantiates a client
const aiplatformClient = new PipelineServiceClient();
async function callCancelPipelineJob() {
// Construct request
const request = {
name,
};
// Run request
const response = await aiplatformClient.cancelPipelineJob(request);
console.log(response);
}
callCancelPipelineJob();
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 |
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 |
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
]>;
Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
, and TrainingPipeline.state is set to CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
ICancelTrainingPipelineRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.aiplatform.v1.ICancelTrainingPipelineRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the TrainingPipeline to cancel.
* Format:
* `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1;
// Instantiates a client
const aiplatformClient = new PipelineServiceClient();
async function callCancelTrainingPipeline() {
// Construct request
const request = {
name,
};
// Run request
const response = await aiplatformClient.cancelTrainingPipeline(request);
console.log(response);
}
callCancelTrainingPipeline();
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 |
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 |
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the PipelineJob resource to be deleted.
* Format:
* `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1;
// Instantiates a client
const aiplatformClient = new PipelineServiceClient();
async function callDeletePipelineJob() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deletePipelineJob(request);
const [response] = await operation.promise();
console.log(response);
}
callDeletePipelineJob();
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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the TrainingPipeline resource to be deleted.
* Format:
* `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1;
// Instantiates a client
const aiplatformClient = new PipelineServiceClient();
async function callDeleteTrainingPipeline() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteTrainingPipeline(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteTrainingPipeline();
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
]>;
Creates a PipelineJob. A PipelineJob will run immediately when created.
Parameters | |
---|---|
Name | Description |
request |
ICreatePipelineJobRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1.IPipelineJob,
protos.google.cloud.aiplatform.v1.ICreatePipelineJobRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the Location to create the PipelineJob in.
* Format: `projects/{project}/locations/{location}`
*/
// const parent = 'abc123'
/**
* Required. The PipelineJob to create.
*/
// const pipelineJob = {}
/**
* The ID to use for the PipelineJob, which will become the final component of
* the PipelineJob name. If not provided, an ID will be automatically
* generated.
* This value should be less than 128 characters, and valid characters
* are /[a-z][0-9]-/.
*/
// const pipelineJobId = 'abc123'
// Imports the Aiplatform library
const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1;
// Instantiates a client
const aiplatformClient = new PipelineServiceClient();
async function callCreatePipelineJob() {
// Construct request
const request = {
parent,
pipelineJob,
};
// Run request
const response = await aiplatformClient.createPipelineJob(request);
console.log(response);
}
callCreatePipelineJob();
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 |
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 |
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
]>;
Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.
Parameters | |
---|---|
Name | Description |
request |
ICreateTrainingPipelineRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1.ITrainingPipeline,
(protos.google.cloud.aiplatform.v1.ICreateTrainingPipelineRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing TrainingPipeline. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the Location to create the TrainingPipeline
* in. Format: `projects/{project}/locations/{location}`
*/
// const parent = 'abc123'
/**
* Required. The TrainingPipeline to create.
*/
// const trainingPipeline = {}
// Imports the Aiplatform library
const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1;
// Instantiates a client
const aiplatformClient = new PipelineServiceClient();
async function callCreateTrainingPipeline() {
// Construct request
const request = {
parent,
trainingPipeline,
};
// Run request
const response = await aiplatformClient.createTrainingPipeline(request);
console.log(response);
}
callCreateTrainingPipeline();
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 |
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 |
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. |
deleteOperation(request, options, callback)
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
DeleteOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
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
]>;
Deletes a PipelineJob.
Parameters | |
---|---|
Name | Description |
request |
IDeletePipelineJobRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the PipelineJob resource to be deleted.
* Format:
* `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1;
// Instantiates a client
const aiplatformClient = new PipelineServiceClient();
async function callDeletePipelineJob() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deletePipelineJob(request);
const [response] = await operation.promise();
console.log(response);
}
callDeletePipelineJob();
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 |
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 |
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
]>;
Deletes a TrainingPipeline.
Parameters | |
---|---|
Name | Description |
request |
IDeleteTrainingPipelineRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the TrainingPipeline resource to be deleted.
* Format:
* `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1;
// Instantiates a client
const aiplatformClient = new PipelineServiceClient();
async function callDeleteTrainingPipeline() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteTrainingPipeline(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteTrainingPipeline();
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 |
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 |
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 |
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. |
getIamPolicy(request, options, callback)
getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters | |
---|---|
Name | Description |
request |
IamProtos.google.iam.v1.GetIamPolicyRequest
The request object that will be sent. |
options |
CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . |
Returns | |
---|---|
Type | Description |
Promise<[google.iam.v1.Policy]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
getLocation(request, options, callback)
getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent. |
options |
CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Call options. See CallOptions for more details. |
callback |
Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
Promise<google.cloud.location.ILocation> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
const [response] = await client.getLocation(request);
getOperation(request, options, callback)
getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
GetOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<[protos.google.longrunning.Operation]> |
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
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
]>;
Gets a PipelineJob.
Parameters | |
---|---|
Name | Description |
request |
IGetPipelineJobRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1.IPipelineJob,
protos.google.cloud.aiplatform.v1.IGetPipelineJobRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the PipelineJob resource.
* Format:
* `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1;
// Instantiates a client
const aiplatformClient = new PipelineServiceClient();
async function callGetPipelineJob() {
// Construct request
const request = {
name,
};
// Run request
const response = await aiplatformClient.getPipelineJob(request);
console.log(response);
}
callGetPipelineJob();
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 |
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 |
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
]>;
Gets a TrainingPipeline.
Parameters | |
---|---|
Name | Description |
request |
IGetTrainingPipelineRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1.ITrainingPipeline,
protos.google.cloud.aiplatform.v1.IGetTrainingPipelineRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing TrainingPipeline. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the TrainingPipeline resource.
* Format:
* `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1;
// Instantiates a client
const aiplatformClient = new PipelineServiceClient();
async function callGetTrainingPipeline() {
// Construct request
const request = {
name,
};
// Run request
const response = await aiplatformClient.getTrainingPipeline(request);
console.log(response);
}
callGetTrainingPipeline();
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 |
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 |
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. |
listLocationsAsync(request, options)
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
Lists information about the supported locations for this service. Returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<google.cloud.location.ILocation> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 for more details and examples. |
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
// process response
}
listOperationsAsync(request, options)
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
Parameters | |
---|---|
Name | Description |
request |
ListOperationsRequest
The request object that will be sent. |
options |
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.longrunning.ListOperationsResponse> | {Object} An iterable Object that conforms to iteration protocols. |
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
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
]>;
Lists PipelineJobs in a Location.
Parameters | |
---|---|
Name | Description |
request |
IListPipelineJobsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1.IPipelineJob[],
protos.google.cloud.aiplatform.v1.IListPipelineJobsRequest | null,
protos.google.cloud.aiplatform.v1.IListPipelineJobsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
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 |
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 |
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 |
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. When you iterate the returned iterable, each element will be an object representing . 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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the Location to list the PipelineJobs from.
* Format: `projects/{project}/locations/{location}`
*/
// const parent = 'abc123'
/**
* Lists the PipelineJobs that match the filter expression. The following
* fields are supported:
* * `pipeline_name`: Supports `=` and `!=` comparisons.
* * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard.
* * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard.
* for example, can check if pipeline's display_name contains *step* by
* doing display_name:\"*step*\"
* * `state`: Supports `=` and `!=` comparisons.
* * `create_time`: Supports `=`, `!=`, `<`, `="">`, `<=`, and="" `="">=` comparisons.
* Values must be in RFC 3339 format.
* * `update_time`: Supports `=`, `!=`, `<`, `="">`, `<=`, and="" `="">=` comparisons.
* Values must be in RFC 3339 format.
* * `end_time`: Supports `=`, `!=`, `<`, `="">`, `<=`, and="" `="">=` comparisons.
* Values must be in RFC 3339 format.
* * `labels`: Supports key-value equality and key presence.
* * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard.
* * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:`
* wildcard.
* Filter expressions can be combined together using logical operators
* (`AND` & `OR`).
* For example: `pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z"`.
* The syntax to define filter expression is based on
* https://google.aip.dev/160.
* Examples:
* * `create_time>"2021-05-18T00:00:00Z" OR
* update_time>"2020-05-18T00:00:00Z"` PipelineJobs created or updated
* after 2020-05-18 00:00:00 UTC.
* * `labels.env = "prod"`
* PipelineJobs with label "env" set to "prod".
*/
// const filter = 'abc123'
/**
* The standard list page size.
*/
// const pageSize = 1234
/**
* The standard list page token.
* Typically obtained via
* ListPipelineJobsResponse.next_page_token google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token
* of the previous
* PipelineService.ListPipelineJobs google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs
* call.
*/
// const pageToken = 'abc123'
/**
* A comma-separated list of fields to order by. The default sort order is in
* ascending order. Use "desc" after a field name for descending. You can have
* multiple order_by fields provided e.g. "create_time desc, end_time",
* "end_time, start_time, update_time" For example, using "create_time desc,
* end_time" will order results by create time in descending order, and if
* there are multiple jobs having the same create time, order them by the end
* time in ascending order. if order_by is not specified, it will order by
* default order is create time in descending order. Supported fields:
* * `create_time`
* * `update_time`
* * `end_time`
* * `start_time`
*/
// const orderBy = 'abc123'
/**
* Mask specifying which fields to read.
*/
// const readMask = {}
// Imports the Aiplatform library
const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1;
// Instantiates a client
const aiplatformClient = new PipelineServiceClient();
async function callListPipelineJobs() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await aiplatformClient.listPipelineJobsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListPipelineJobs();
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 |
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 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 |
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
]>;
Lists TrainingPipelines in a Location.
Parameters | |
---|---|
Name | Description |
request |
IListTrainingPipelinesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1.ITrainingPipeline[],
protos.google.cloud.aiplatform.v1.IListTrainingPipelinesRequest | null,
protos.google.cloud.aiplatform.v1.IListTrainingPipelinesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of TrainingPipeline. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
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 |
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 |
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 |
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. 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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the Location to list the TrainingPipelines
* from. Format: `projects/{project}/locations/{location}`
*/
// const parent = 'abc123'
/**
* The standard list filter.
* Supported fields:
* * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
* * `state` supports `=`, `!=` comparisons.
* * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard.
* * `create_time` supports `=`, `!=`,`<`,><=`,`>`, `>=` comparisons.
* `create_time` must be in RFC 3339 format.
* * `labels` supports general map functions that is:
* `labels.key=value` - key:value equality
* `labels.key:* - key existence
* Some examples of using the filter are:
* * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"`
* * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"`
* * `NOT display_name="my_pipeline"`
* * `create_time>"2021-05-18T00:00:00Z"`
* * `training_task_definition:"*automl_text_classification*"`
*/
// const filter = 'abc123'
/**
* The standard list page size.
*/
// const pageSize = 1234
/**
* The standard list page token.
* Typically obtained via
* ListTrainingPipelinesResponse.next_page_token google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token
* of the previous
* PipelineService.ListTrainingPipelines google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines
* call.
*/
// const pageToken = 'abc123'
/**
* Mask specifying which fields to read.
*/
// const readMask = {}
// Imports the Aiplatform library
const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1;
// Instantiates a client
const aiplatformClient = new PipelineServiceClient();
async function callListTrainingPipelines() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await aiplatformClient.listTrainingPipelinesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListTrainingPipelines();
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 |
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 |
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. |
matchDatasetFromSavedQueryName(savedQueryName)
matchDatasetFromSavedQueryName(savedQueryName: string): string | number;
Parse the dataset from SavedQuery resource.
Parameter | |
---|---|
Name | Description |
savedQueryName |
string
A fully-qualified path representing SavedQuery resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the dataset. |
matchEndpointFromProjectLocationEndpointName(projectLocationEndpointName)
matchEndpointFromProjectLocationEndpointName(projectLocationEndpointName: string): string | number;
Parse the endpoint from ProjectLocationEndpoint resource.
Parameter | |
---|---|
Name | Description |
projectLocationEndpointName |
string
A fully-qualified path representing project_location_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. |
matchExperimentFromTensorboardExperimentName(tensorboardExperimentName)
matchExperimentFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;
Parse the experiment from TensorboardExperiment resource.
Parameter | |
---|---|
Name | Description |
tensorboardExperimentName |
string
A fully-qualified path representing TensorboardExperiment resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the experiment. |
matchExperimentFromTensorboardRunName(tensorboardRunName)
matchExperimentFromTensorboardRunName(tensorboardRunName: string): string | number;
Parse the experiment from TensorboardRun resource.
Parameter | |
---|---|
Name | Description |
tensorboardRunName |
string
A fully-qualified path representing TensorboardRun resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the experiment. |
matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)
matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;
Parse the experiment from TensorboardTimeSeries resource.
Parameter | |
---|---|
Name | Description |
tensorboardTimeSeriesName |
string
A fully-qualified path representing TensorboardTimeSeries resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the experiment. |
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. |
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. |
matchLocationFromNasJobName(nasJobName)
matchLocationFromNasJobName(nasJobName: string): string | number;
Parse the location from NasJob resource.
Parameter | |
---|---|
Name | Description |
nasJobName |
string
A fully-qualified path representing NasJob resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromNasTrialDetailName(nasTrialDetailName)
matchLocationFromNasTrialDetailName(nasTrialDetailName: string): string | number;
Parse the location from NasTrialDetail resource.
Parameter | |
---|---|
Name | Description |
nasTrialDetailName |
string
A fully-qualified path representing NasTrialDetail 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. |
matchLocationFromProjectLocationEndpointName(projectLocationEndpointName)
matchLocationFromProjectLocationEndpointName(projectLocationEndpointName: string): string | number;
Parse the location from ProjectLocationEndpoint resource.
Parameter | |
---|---|
Name | Description |
projectLocationEndpointName |
string
A fully-qualified path representing project_location_endpoint resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationPublisherModelName(projectLocationPublisherModelName)
matchLocationFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number;
Parse the location from ProjectLocationPublisherModel resource.
Parameter | |
---|---|
Name | Description |
projectLocationPublisherModelName |
string
A fully-qualified path representing project_location_publisher_model resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromSavedQueryName(savedQueryName)
matchLocationFromSavedQueryName(savedQueryName: string): string | number;
Parse the location from SavedQuery resource.
Parameter | |
---|---|
Name | Description |
savedQueryName |
string
A fully-qualified path representing SavedQuery resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromScheduleName(scheduleName)
matchLocationFromScheduleName(scheduleName: string): string | number;
Parse the location from Schedule resource.
Parameter | |
---|---|
Name | Description |
scheduleName |
string
A fully-qualified path representing Schedule 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. |
matchLocationFromTensorboardExperimentName(tensorboardExperimentName)
matchLocationFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;
Parse the location from TensorboardExperiment resource.
Parameter | |
---|---|
Name | Description |
tensorboardExperimentName |
string
A fully-qualified path representing TensorboardExperiment resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromTensorboardName(tensorboardName)
matchLocationFromTensorboardName(tensorboardName: string): string | number;
Parse the location from Tensorboard resource.
Parameter | |
---|---|
Name | Description |
tensorboardName |
string
A fully-qualified path representing Tensorboard resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromTensorboardRunName(tensorboardRunName)
matchLocationFromTensorboardRunName(tensorboardRunName: string): string | number;
Parse the location from TensorboardRun resource.
Parameter | |
---|---|
Name | Description |
tensorboardRunName |
string
A fully-qualified path representing TensorboardRun resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)
matchLocationFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;
Parse the location from TensorboardTimeSeries resource.
Parameter | |
---|---|
Name | Description |
tensorboardTimeSeriesName |
string
A fully-qualified path representing TensorboardTimeSeries 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. |
matchModelFromProjectLocationPublisherModelName(projectLocationPublisherModelName)
matchModelFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number;
Parse the model from ProjectLocationPublisherModel resource.
Parameter | |
---|---|
Name | Description |
projectLocationPublisherModelName |
string
A fully-qualified path representing project_location_publisher_model resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the model. |
matchModelFromPublisherModelName(publisherModelName)
matchModelFromPublisherModelName(publisherModelName: string): string | number;
Parse the model from PublisherModel resource.
Parameter | |
---|---|
Name | Description |
publisherModelName |
string
A fully-qualified path representing PublisherModel resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the model. |
matchNasJobFromNasJobName(nasJobName)
matchNasJobFromNasJobName(nasJobName: string): string | number;
Parse the nas_job from NasJob resource.
Parameter | |
---|---|
Name | Description |
nasJobName |
string
A fully-qualified path representing NasJob resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the nas_job. |
matchNasJobFromNasTrialDetailName(nasTrialDetailName)
matchNasJobFromNasTrialDetailName(nasTrialDetailName: string): string | number;
Parse the nas_job from NasTrialDetail resource.
Parameter | |
---|---|
Name | Description |
nasTrialDetailName |
string
A fully-qualified path representing NasTrialDetail resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the nas_job. |
matchNasTrialDetailFromNasTrialDetailName(nasTrialDetailName)
matchNasTrialDetailFromNasTrialDetailName(nasTrialDetailName: string): string | number;
Parse the nas_trial_detail from NasTrialDetail resource.
Parameter | |
---|---|
Name | Description |
nasTrialDetailName |
string
A fully-qualified path representing NasTrialDetail resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the nas_trial_detail. |
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. |
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. |
matchProjectFromNasJobName(nasJobName)
matchProjectFromNasJobName(nasJobName: string): string | number;
Parse the project from NasJob resource.
Parameter | |
---|---|
Name | Description |
nasJobName |
string
A fully-qualified path representing NasJob resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromNasTrialDetailName(nasTrialDetailName)
matchProjectFromNasTrialDetailName(nasTrialDetailName: string): string | number;
Parse the project from NasTrialDetail resource.
Parameter | |
---|---|
Name | Description |
nasTrialDetailName |
string
A fully-qualified path representing NasTrialDetail 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. |
matchProjectFromProjectLocationEndpointName(projectLocationEndpointName)
matchProjectFromProjectLocationEndpointName(projectLocationEndpointName: string): string | number;
Parse the project from ProjectLocationEndpoint resource.
Parameter | |
---|---|
Name | Description |
projectLocationEndpointName |
string
A fully-qualified path representing project_location_endpoint resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationPublisherModelName(projectLocationPublisherModelName)
matchProjectFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number;
Parse the project from ProjectLocationPublisherModel resource.
Parameter | |
---|---|
Name | Description |
projectLocationPublisherModelName |
string
A fully-qualified path representing project_location_publisher_model resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromSavedQueryName(savedQueryName)
matchProjectFromSavedQueryName(savedQueryName: string): string | number;
Parse the project from SavedQuery resource.
Parameter | |
---|---|
Name | Description |
savedQueryName |
string
A fully-qualified path representing SavedQuery resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromScheduleName(scheduleName)
matchProjectFromScheduleName(scheduleName: string): string | number;
Parse the project from Schedule resource.
Parameter | |
---|---|
Name | Description |
scheduleName |
string
A fully-qualified path representing Schedule 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. |
matchProjectFromTensorboardExperimentName(tensorboardExperimentName)
matchProjectFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;
Parse the project from TensorboardExperiment resource.
Parameter | |
---|---|
Name | Description |
tensorboardExperimentName |
string
A fully-qualified path representing TensorboardExperiment resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromTensorboardName(tensorboardName)
matchProjectFromTensorboardName(tensorboardName: string): string | number;
Parse the project from Tensorboard resource.
Parameter | |
---|---|
Name | Description |
tensorboardName |
string
A fully-qualified path representing Tensorboard resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromTensorboardRunName(tensorboardRunName)
matchProjectFromTensorboardRunName(tensorboardRunName: string): string | number;
Parse the project from TensorboardRun resource.
Parameter | |
---|---|
Name | Description |
tensorboardRunName |
string
A fully-qualified path representing TensorboardRun resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)
matchProjectFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;
Parse the project from TensorboardTimeSeries resource.
Parameter | |
---|---|
Name | Description |
tensorboardTimeSeriesName |
string
A fully-qualified path representing TensorboardTimeSeries 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. |
matchPublisherFromProjectLocationPublisherModelName(projectLocationPublisherModelName)
matchPublisherFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number;
Parse the publisher from ProjectLocationPublisherModel resource.
Parameter | |
---|---|
Name | Description |
projectLocationPublisherModelName |
string
A fully-qualified path representing project_location_publisher_model resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the publisher. |
matchPublisherFromPublisherModelName(publisherModelName)
matchPublisherFromPublisherModelName(publisherModelName: string): string | number;
Parse the publisher from PublisherModel resource.
Parameter | |
---|---|
Name | Description |
publisherModelName |
string
A fully-qualified path representing PublisherModel resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the publisher. |
matchRunFromTensorboardRunName(tensorboardRunName)
matchRunFromTensorboardRunName(tensorboardRunName: string): string | number;
Parse the run from TensorboardRun resource.
Parameter | |
---|---|
Name | Description |
tensorboardRunName |
string
A fully-qualified path representing TensorboardRun resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the run. |
matchRunFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)
matchRunFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;
Parse the run from TensorboardTimeSeries resource.
Parameter | |
---|---|
Name | Description |
tensorboardTimeSeriesName |
string
A fully-qualified path representing TensorboardTimeSeries resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the run. |
matchSavedQueryFromSavedQueryName(savedQueryName)
matchSavedQueryFromSavedQueryName(savedQueryName: string): string | number;
Parse the saved_query from SavedQuery resource.
Parameter | |
---|---|
Name | Description |
savedQueryName |
string
A fully-qualified path representing SavedQuery resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the saved_query. |
matchScheduleFromScheduleName(scheduleName)
matchScheduleFromScheduleName(scheduleName: string): string | number;
Parse the schedule from Schedule resource.
Parameter | |
---|---|
Name | Description |
scheduleName |
string
A fully-qualified path representing Schedule resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the schedule. |
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. |
matchTensorboardFromTensorboardExperimentName(tensorboardExperimentName)
matchTensorboardFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;
Parse the tensorboard from TensorboardExperiment resource.
Parameter | |
---|---|
Name | Description |
tensorboardExperimentName |
string
A fully-qualified path representing TensorboardExperiment resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the tensorboard. |
matchTensorboardFromTensorboardName(tensorboardName)
matchTensorboardFromTensorboardName(tensorboardName: string): string | number;
Parse the tensorboard from Tensorboard resource.
Parameter | |
---|---|
Name | Description |
tensorboardName |
string
A fully-qualified path representing Tensorboard resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the tensorboard. |
matchTensorboardFromTensorboardRunName(tensorboardRunName)
matchTensorboardFromTensorboardRunName(tensorboardRunName: string): string | number;
Parse the tensorboard from TensorboardRun resource.
Parameter | |
---|---|
Name | Description |
tensorboardRunName |
string
A fully-qualified path representing TensorboardRun resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the tensorboard. |
matchTensorboardFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)
matchTensorboardFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;
Parse the tensorboard from TensorboardTimeSeries resource.
Parameter | |
---|---|
Name | Description |
tensorboardTimeSeriesName |
string
A fully-qualified path representing TensorboardTimeSeries resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the tensorboard. |
matchTimeSeriesFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)
matchTimeSeriesFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;
Parse the time_series from TensorboardTimeSeries resource.
Parameter | |
---|---|
Name | Description |
tensorboardTimeSeriesName |
string
A fully-qualified path representing TensorboardTimeSeries resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the time_series. |
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. |
nasJobPath(project, location, nasJob)
nasJobPath(project: string, location: string, nasJob: string): string;
Return a fully-qualified nasJob resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
nasJob |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
nasTrialDetailPath(project, location, nasJob, nasTrialDetail)
nasTrialDetailPath(project: string, location: string, nasJob: string, nasTrialDetail: string): string;
Return a fully-qualified nasTrialDetail resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
nasJob |
string
|
nasTrialDetail |
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. |
projectLocationEndpointPath(project, location, endpoint)
projectLocationEndpointPath(project: string, location: string, endpoint: string): string;
Return a fully-qualified projectLocationEndpoint resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
endpoint |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectLocationPublisherModelPath(project, location, publisher, model)
projectLocationPublisherModelPath(project: string, location: string, publisher: string, model: string): string;
Return a fully-qualified projectLocationPublisherModel resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
publisher |
string
|
model |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
publisherModelPath(publisher, model)
publisherModelPath(publisher: string, model: string): string;
Return a fully-qualified publisherModel resource name string.
Parameters | |
---|---|
Name | Description |
publisher |
string
|
model |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
savedQueryPath(project, location, dataset, savedQuery)
savedQueryPath(project: string, location: string, dataset: string, savedQuery: string): string;
Return a fully-qualified savedQuery resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dataset |
string
|
savedQuery |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
schedulePath(project, location, schedule)
schedulePath(project: string, location: string, schedule: string): string;
Return a fully-qualified schedule resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
schedule |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
setIamPolicy(request, options, callback)
setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters | |
---|---|
Name | Description |
request |
IamProtos.google.iam.v1.SetIamPolicyRequest
The request object that will be sent. |
options |
CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . |
Returns | |
---|---|
Type | Description |
Promise<[google.iam.v1.Policy]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
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. |
tensorboardExperimentPath(project, location, tensorboard, experiment)
tensorboardExperimentPath(project: string, location: string, tensorboard: string, experiment: string): string;
Return a fully-qualified tensorboardExperiment resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
tensorboard |
string
|
experiment |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
tensorboardPath(project, location, tensorboard)
tensorboardPath(project: string, location: string, tensorboard: string): string;
Return a fully-qualified tensorboard resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
tensorboard |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
tensorboardRunPath(project, location, tensorboard, experiment, run)
tensorboardRunPath(project: string, location: string, tensorboard: string, experiment: string, run: string): string;
Return a fully-qualified tensorboardRun resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
tensorboard |
string
|
experiment |
string
|
run |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
tensorboardTimeSeriesPath(project, location, tensorboard, experiment, run, timeSeries)
tensorboardTimeSeriesPath(project: string, location: string, tensorboard: string, experiment: string, run: string, timeSeries: string): string;
Return a fully-qualified tensorboardTimeSeries resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
tensorboard |
string
|
experiment |
string
|
run |
string
|
timeSeries |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
testIamPermissions(request, options, callback)
testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters | |
---|---|
Name | Description |
request |
IamProtos.google.iam.v1.TestIamPermissionsRequest
The request object that will be sent. |
options |
CallOptions | Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . |
Returns | |
---|---|
Type | Description |
Promise<[google.iam.v1.TestIamPermissionsResponse]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
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. |