Class v1beta1.JobServiceClient (2.3.0)

Stay organized with collections Save and categorize content based on your preferences.

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

Package

@google-cloud/aiplatform

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of JobServiceClient.

Parameters
NameDescription
opts ClientOptions
gaxInstance typeof gax | typeof gax.fallback

: loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new JobServiceClient({fallback: 'rest'}, gax); ```

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

jobServiceStub

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

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

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
NameDescription
project string
location string
dataset string
dataItem string
annotation string
Returns
TypeDescription
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
NameDescription
project string
location string
dataset string
annotationSpec string
Returns
TypeDescription
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
NameDescription
project string
location string
metadataStore string
artifact string
Returns
TypeDescription
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
NameDescription
project string
location string
batchPredictionJob string
Returns
TypeDescription
string

{string} Resource name string.

cancelBatchPredictionJob(request, options)

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

Cancels a BatchPredictionJob.

Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its is set to CANCELLED. Any files already outputted by the job are not deleted.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.ICancelBatchPredictionJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.aiplatform.v1beta1.ICancelBatchPredictionJobRequest | 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * 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 BatchPredictionJob to cancel.
   *  Format:
   *  `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callCancelBatchPredictionJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await aiplatformClient.cancelBatchPredictionJob(request);
    console.log(response);
  }

  callCancelBatchPredictionJob();

cancelBatchPredictionJob(request, options, callback)

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

cancelBatchPredictionJob(request, callback)

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

cancelCustomJob(request, options)

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

Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a value with a of 1, corresponding to Code.CANCELLED, and is set to CANCELLED.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.ICancelCustomJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.aiplatform.v1beta1.ICancelCustomJobRequest | 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * 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 CustomJob to cancel.
   *  Format:
   *  `projects/{project}/locations/{location}/customJobs/{custom_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callCancelCustomJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await aiplatformClient.cancelCustomJob(request);
    console.log(response);
  }

  callCancelCustomJob();

cancelCustomJob(request, options, callback)

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

cancelCustomJob(request, callback)

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

cancelDataLabelingJob(request, options)

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

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.ICancelDataLabelingJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.aiplatform.v1beta1.ICancelDataLabelingJobRequest | 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * 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 DataLabelingJob.
   *  Format:
   *  `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callCancelDataLabelingJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await aiplatformClient.cancelDataLabelingJob(request);
    console.log(response);
  }

  callCancelDataLabelingJob();

cancelDataLabelingJob(request, options, callback)

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

cancelDataLabelingJob(request, callback)

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

cancelHyperparameterTuningJob(request, options)

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

Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a value with a of 1, corresponding to Code.CANCELLED, and is set to CANCELLED.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.ICancelHyperparameterTuningJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.aiplatform.v1beta1.ICancelHyperparameterTuningJobRequest | 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * 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 HyperparameterTuningJob to cancel.
   *  Format:
   *  `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callCancelHyperparameterTuningJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await aiplatformClient.cancelHyperparameterTuningJob(request);
    console.log(response);
  }

  callCancelHyperparameterTuningJob();

cancelHyperparameterTuningJob(request, options, callback)

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

cancelHyperparameterTuningJob(request, callback)

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

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
NameDescription
request protos.google.longrunning.CancelOperationRequest

The request object that will be sent.

options gax.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]https://googleapis.github.io/gax-nodejs/global.html#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
TypeDescription
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkDeleteBatchPredictionJobProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>

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

Example

  /**
   * 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 BatchPredictionJob resource to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callDeleteBatchPredictionJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteBatchPredictionJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteBatchPredictionJob();

checkDeleteCustomJobProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>

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

Example

  /**
   * 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 CustomJob resource to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/customJobs/{custom_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callDeleteCustomJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteCustomJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteCustomJob();

checkDeleteDataLabelingJobProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>

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

Example

  /**
   * 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 DataLabelingJob to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callDeleteDataLabelingJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteDataLabelingJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteDataLabelingJob();

checkDeleteHyperparameterTuningJobProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>

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

Example

  /**
   * 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 HyperparameterTuningJob resource to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callDeleteHyperparameterTuningJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteHyperparameterTuningJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteHyperparameterTuningJob();

checkDeleteModelDeploymentMonitoringJobProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>

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

Example

  /**
   * 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 model monitoring job to delete.
   *  Format:
   *  `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callDeleteModelDeploymentMonitoringJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteModelDeploymentMonitoringJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteModelDeploymentMonitoringJob();

checkUpdateModelDeploymentMonitoringJobProgress(name)

checkUpdateModelDeploymentMonitoringJobProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob, protos.google.cloud.aiplatform.v1beta1.UpdateModelDeploymentMonitoringJobOperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob, protos.google.cloud.aiplatform.v1beta1.UpdateModelDeploymentMonitoringJobOperationMetadata>>

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

Example

  /**
   * 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 model monitoring configuration which replaces the resource on the
   *  server.
   */
  // const modelDeploymentMonitoringJob = {}
  /**
   *  Required. The update mask is used to specify the fields to be overwritten in the
   *  ModelDeploymentMonitoringJob resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then only the non-empty fields present in the
   *  request will be overwritten. Set the update_mask to `*` to override all
   *  fields.
   *  For the objective config, the user can either provide the update mask for
   *  model_deployment_monitoring_objective_configs or any combination of its
   *  nested fields, such as:
   *  model_deployment_monitoring_objective_configs.objective_config.training_dataset.
   *  Updatable fields:
   *    * `display_name`
   *    * `model_deployment_monitoring_schedule_config`
   *    * `model_monitoring_alert_config`
   *    * `logging_sampling_strategy`
   *    * `labels`
   *    * `log_ttl`
   *    * `enable_monitoring_pipeline_logs`
   *  .  and
   *    * `model_deployment_monitoring_objective_configs`
   *  .  or
   *    * `model_deployment_monitoring_objective_configs.objective_config.training_dataset`
   *    * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config`
   *    * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`
   */
  // const updateMask = {}

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callUpdateModelDeploymentMonitoringJob() {
    // Construct request
    const request = {
      modelDeploymentMonitoringJob,
      updateMask,
    };

    // Run request
    const [operation] = await aiplatformClient.updateModelDeploymentMonitoringJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateModelDeploymentMonitoringJob();

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
TypeDescription
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
NameDescription
project string
location string
metadataStore string
context string
Returns
TypeDescription
string

{string} Resource name string.

createBatchPredictionJob(request, options)

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

Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.ICreateBatchPredictionJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IBatchPredictionJob, (protos.google.cloud.aiplatform.v1beta1.ICreateBatchPredictionJobRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [BatchPredictionJob]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * 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 BatchPredictionJob in.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The BatchPredictionJob to create.
   */
  // const batchPredictionJob = {}

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callCreateBatchPredictionJob() {
    // Construct request
    const request = {
      parent,
      batchPredictionJob,
    };

    // Run request
    const response = await aiplatformClient.createBatchPredictionJob(request);
    console.log(response);
  }

  callCreateBatchPredictionJob();

createBatchPredictionJob(request, options, callback)

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

createBatchPredictionJob(request, callback)

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

createCustomJob(request, options)

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

Creates a CustomJob. A created CustomJob right away will be attempted to be run.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.ICreateCustomJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.ICustomJob, (protos.google.cloud.aiplatform.v1beta1.ICreateCustomJobRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [CustomJob]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * 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 CustomJob in.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The CustomJob to create.
   */
  // const customJob = {}

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callCreateCustomJob() {
    // Construct request
    const request = {
      parent,
      customJob,
    };

    // Run request
    const response = await aiplatformClient.createCustomJob(request);
    console.log(response);
  }

  callCreateCustomJob();

createCustomJob(request, options, callback)

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

createCustomJob(request, callback)

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

createDataLabelingJob(request, options)

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

Creates a DataLabelingJob.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.ICreateDataLabelingJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IDataLabelingJob, (protos.google.cloud.aiplatform.v1beta1.ICreateDataLabelingJobRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [DataLabelingJob]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * 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 parent of the DataLabelingJob.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The DataLabelingJob to create.
   */
  // const dataLabelingJob = {}

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callCreateDataLabelingJob() {
    // Construct request
    const request = {
      parent,
      dataLabelingJob,
    };

    // Run request
    const response = await aiplatformClient.createDataLabelingJob(request);
    console.log(response);
  }

  callCreateDataLabelingJob();

createDataLabelingJob(request, options, callback)

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

createDataLabelingJob(request, callback)

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

createHyperparameterTuningJob(request, options)

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

Creates a HyperparameterTuningJob

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.ICreateHyperparameterTuningJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IHyperparameterTuningJob, (protos.google.cloud.aiplatform.v1beta1.ICreateHyperparameterTuningJobRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [HyperparameterTuningJob]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * 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 HyperparameterTuningJob in.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The HyperparameterTuningJob to create.
   */
  // const hyperparameterTuningJob = {}

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callCreateHyperparameterTuningJob() {
    // Construct request
    const request = {
      parent,
      hyperparameterTuningJob,
    };

    // Run request
    const response = await aiplatformClient.createHyperparameterTuningJob(request);
    console.log(response);
  }

  callCreateHyperparameterTuningJob();

createHyperparameterTuningJob(request, options, callback)

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

createHyperparameterTuningJob(request, callback)

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

createModelDeploymentMonitoringJob(request, options)

createModelDeploymentMonitoringJob(request?: protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob,
        (protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest | undefined),
        {} | undefined
    ]>;

Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob, (protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ModelDeploymentMonitoringJob]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * 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 parent of the ModelDeploymentMonitoringJob.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The ModelDeploymentMonitoringJob to create
   */
  // const modelDeploymentMonitoringJob = {}

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callCreateModelDeploymentMonitoringJob() {
    // Construct request
    const request = {
      parent,
      modelDeploymentMonitoringJob,
    };

    // Run request
    const response = await aiplatformClient.createModelDeploymentMonitoringJob(request);
    console.log(response);
  }

  callCreateModelDeploymentMonitoringJob();

createModelDeploymentMonitoringJob(request, options, callback)

createModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob, protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob, protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createModelDeploymentMonitoringJob(request, callback)

createModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob, protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest
callback Callback<protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob, protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

customJobPath(project, location, customJob)

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

Return a fully-qualified customJob resource name string.

Parameters
NameDescription
project string
location string
customJob string
Returns
TypeDescription
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
NameDescription
project string
location string
dataset string
dataItem string
Returns
TypeDescription
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
NameDescription
project string
location string
dataLabelingJob string
Returns
TypeDescription
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
NameDescription
project string
location string
dataset string
Returns
TypeDescription
string

{string} Resource name string.

deleteBatchPredictionJob(request, options)

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

Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IDeleteBatchPredictionJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.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 promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * 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 BatchPredictionJob resource to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callDeleteBatchPredictionJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteBatchPredictionJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteBatchPredictionJob();

deleteBatchPredictionJob(request, options, callback)

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

deleteBatchPredictionJob(request, callback)

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

deleteCustomJob(request, options)

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

Deletes a CustomJob.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IDeleteCustomJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.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 promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * 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 CustomJob resource to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/customJobs/{custom_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callDeleteCustomJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteCustomJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteCustomJob();

deleteCustomJob(request, options, callback)

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

deleteCustomJob(request, callback)

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

deleteDataLabelingJob(request, options)

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

Deletes a DataLabelingJob.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IDeleteDataLabelingJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.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 promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * 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 DataLabelingJob to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callDeleteDataLabelingJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteDataLabelingJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteDataLabelingJob();

deleteDataLabelingJob(request, options, callback)

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

deleteDataLabelingJob(request, callback)

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

deleteHyperparameterTuningJob(request, options)

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

Deletes a HyperparameterTuningJob.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IDeleteHyperparameterTuningJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.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 promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * 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 HyperparameterTuningJob resource to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callDeleteHyperparameterTuningJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteHyperparameterTuningJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteHyperparameterTuningJob();

deleteHyperparameterTuningJob(request, options, callback)

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

deleteHyperparameterTuningJob(request, callback)

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

deleteModelDeploymentMonitoringJob(request, options)

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

Deletes a ModelDeploymentMonitoringJob.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IDeleteModelDeploymentMonitoringJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.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 promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * 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 model monitoring job to delete.
   *  Format:
   *  `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callDeleteModelDeploymentMonitoringJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteModelDeploymentMonitoringJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteModelDeploymentMonitoringJob();

deleteModelDeploymentMonitoringJob(request, options, callback)

deleteModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1beta1.IDeleteModelDeploymentMonitoringJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IDeleteModelDeploymentMonitoringJobRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteModelDeploymentMonitoringJob(request, callback)

deleteModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1beta1.IDeleteModelDeploymentMonitoringJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IDeleteModelDeploymentMonitoringJobRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

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
NameDescription
request protos.google.longrunning.DeleteOperationRequest

The request object that will be sent.

options gax.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]https://googleapis.github.io/gax-nodejs/global.html#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
TypeDescription
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

deploymentResourcePoolPath(project, location, deploymentResourcePool)

deploymentResourcePoolPath(project: string, location: string, deploymentResourcePool: string): string;

Return a fully-qualified deploymentResourcePool resource name string.

Parameters
NameDescription
project string
location string
deploymentResourcePool string
Returns
TypeDescription
string

{string} Resource name string.

endpointPath(project, location, endpoint)

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

Return a fully-qualified endpoint resource name string.

Parameters
NameDescription
project string
location string
endpoint string
Returns
TypeDescription
string

{string} Resource name string.

entityTypePath(project, location, featurestore, entityType)

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

Return a fully-qualified entityType resource name string.

Parameters
NameDescription
project string
location string
featurestore string
entityType string
Returns
TypeDescription
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
NameDescription
project string
location string
metadataStore string
execution string
Returns
TypeDescription
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
NameDescription
project string
location string
featurestore string
entityType string
feature string
Returns
TypeDescription
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
NameDescription
project string
location string
featurestore string
Returns
TypeDescription
string

{string} Resource name string.

getBatchPredictionJob(request, options)

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

Gets a BatchPredictionJob

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IGetBatchPredictionJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IBatchPredictionJob, (protos.google.cloud.aiplatform.v1beta1.IGetBatchPredictionJobRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [BatchPredictionJob]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * 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 BatchPredictionJob resource.
   *  Format:
   *  `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callGetBatchPredictionJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await aiplatformClient.getBatchPredictionJob(request);
    console.log(response);
  }

  callGetBatchPredictionJob();

getBatchPredictionJob(request, options, callback)

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

getBatchPredictionJob(request, callback)

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

getCustomJob(request, options)

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

Gets a CustomJob.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IGetCustomJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.ICustomJob, protos.google.cloud.aiplatform.v1beta1.IGetCustomJobRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [CustomJob]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * 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 CustomJob resource.
   *  Format:
   *  `projects/{project}/locations/{location}/customJobs/{custom_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callGetCustomJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await aiplatformClient.getCustomJob(request);
    console.log(response);
  }

  callGetCustomJob();

getCustomJob(request, options, callback)

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

getCustomJob(request, callback)

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

getDataLabelingJob(request, options)

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

Gets a DataLabelingJob.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IGetDataLabelingJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IDataLabelingJob, (protos.google.cloud.aiplatform.v1beta1.IGetDataLabelingJobRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [DataLabelingJob]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * 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 DataLabelingJob.
   *  Format:
   *  `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callGetDataLabelingJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await aiplatformClient.getDataLabelingJob(request);
    console.log(response);
  }

  callGetDataLabelingJob();

getDataLabelingJob(request, options, callback)

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

getDataLabelingJob(request, callback)

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

getHyperparameterTuningJob(request, options)

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

Gets a HyperparameterTuningJob

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IGetHyperparameterTuningJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IHyperparameterTuningJob, (protos.google.cloud.aiplatform.v1beta1.IGetHyperparameterTuningJobRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [HyperparameterTuningJob]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * 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 HyperparameterTuningJob resource.
   *  Format:
   *  `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callGetHyperparameterTuningJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await aiplatformClient.getHyperparameterTuningJob(request);
    console.log(response);
  }

  callGetHyperparameterTuningJob();

getHyperparameterTuningJob(request, options, callback)

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

getHyperparameterTuningJob(request, callback)

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

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
NameDescription
request IamProtos.google.iam.v1.GetIamPolicyRequest

The request object that will be sent.

options gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.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]https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html for the details.

callback Callback<IamProtos.google.iam.v1.Policy, IamProtos.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 [Policy].

Returns
TypeDescription
Promise<IamProtos.google.iam.v1.Policy>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. 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
NameDescription
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

options gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.

callback Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
Promise<LocationProtos.google.cloud.location.ILocation>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Location]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

const [response] = await client.getLocation(request);

getModelDeploymentMonitoringJob(request, options)

getModelDeploymentMonitoringJob(request?: protos.google.cloud.aiplatform.v1beta1.IGetModelDeploymentMonitoringJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob,
        (protos.google.cloud.aiplatform.v1beta1.IGetModelDeploymentMonitoringJobRequest | undefined),
        {} | undefined
    ]>;

Gets a ModelDeploymentMonitoringJob.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IGetModelDeploymentMonitoringJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob, (protos.google.cloud.aiplatform.v1beta1.IGetModelDeploymentMonitoringJobRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ModelDeploymentMonitoringJob]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * 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 ModelDeploymentMonitoringJob.
   *  Format:
   *  `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callGetModelDeploymentMonitoringJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await aiplatformClient.getModelDeploymentMonitoringJob(request);
    console.log(response);
  }

  callGetModelDeploymentMonitoringJob();

getModelDeploymentMonitoringJob(request, options, callback)

getModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1beta1.IGetModelDeploymentMonitoringJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob, protos.google.cloud.aiplatform.v1beta1.IGetModelDeploymentMonitoringJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IGetModelDeploymentMonitoringJobRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob, protos.google.cloud.aiplatform.v1beta1.IGetModelDeploymentMonitoringJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getModelDeploymentMonitoringJob(request, callback)

getModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1beta1.IGetModelDeploymentMonitoringJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob, protos.google.cloud.aiplatform.v1beta1.IGetModelDeploymentMonitoringJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IGetModelDeploymentMonitoringJobRequest
callback Callback<protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob, protos.google.cloud.aiplatform.v1beta1.IGetModelDeploymentMonitoringJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

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
NameDescription
request protos.google.longrunning.GetOperationRequest

The request object that will be sent.

options gax.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]https://googleapis.github.io/gax-nodejs/global.html#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 [google.longrunning.Operation]. {Promise} - The promise which resolves to an array. The first element of the array is an object representing [google.longrunning.Operation]. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<[protos.google.longrunning.Operation]>
Example

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

hyperparameterTuningJobPath(project, location, hyperparameterTuningJob)

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

Return a fully-qualified hyperparameterTuningJob resource name string.

Parameters
NameDescription
project string
location string
hyperparameterTuningJob string
Returns
TypeDescription
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
NameDescription
project string
location string
indexEndpoint string
Returns
TypeDescription
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
NameDescription
project string
location string
index string
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

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

listBatchPredictionJobs(request, options)

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

Lists BatchPredictionJobs in a Location.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListBatchPredictionJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IBatchPredictionJob[], protos.google.cloud.aiplatform.v1beta1.IListBatchPredictionJobsRequest | null, protos.google.cloud.aiplatform.v1beta1.IListBatchPredictionJobsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [BatchPredictionJob]. 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 listBatchPredictionJobsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listBatchPredictionJobs(request, options, callback)

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

listBatchPredictionJobs(request, callback)

listBatchPredictionJobs(request: protos.google.cloud.aiplatform.v1beta1.IListBatchPredictionJobsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListBatchPredictionJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListBatchPredictionJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IBatchPredictionJob>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListBatchPredictionJobsRequest
callback PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListBatchPredictionJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListBatchPredictionJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IBatchPredictionJob>
Returns
TypeDescription
void

listBatchPredictionJobsAsync(request, options)

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

Equivalent to listBatchPredictionJobs, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListBatchPredictionJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IBatchPredictionJob>

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

Example

  /**
   * 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 BatchPredictionJobs
   *  from. Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  The standard list filter.
   *  Supported fields:
   *    * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   *    * `model_display_name` supports `=`, `!=` comparisons.
   *    * `state` supports `=`, `!=` comparisons.
   *    * `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="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
   *    * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
   *    * `NOT display_name="my_job"`
   *    * `create_time>"2021-05-18T00:00:00Z"`
   *    * `labels.keyA=valueA`
   *    * `labels.keyB:*`
   */
  // const filter = 'abc123'
  /**
   *  The standard list page size.
   */
  // const pageSize = 1234
  /**
   *  The standard list page token.
   *  Typically obtained via
   *  ListBatchPredictionJobsResponse.next_page_token google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token  of the previous
   *  JobService.ListBatchPredictionJobs google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs  call.
   */
  // const pageToken = 'abc123'
  /**
   *  Mask specifying which fields to read.
   */
  // const readMask = {}

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callListBatchPredictionJobs() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await aiplatformClient.listBatchPredictionJobsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListBatchPredictionJobs();

listBatchPredictionJobsStream(request, options)

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

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

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListBatchPredictionJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

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

listCustomJobs(request, options)

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

Lists CustomJobs in a Location.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListCustomJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.ICustomJob[], protos.google.cloud.aiplatform.v1beta1.IListCustomJobsRequest | null, protos.google.cloud.aiplatform.v1beta1.IListCustomJobsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [CustomJob]. 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 listCustomJobsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCustomJobs(request, options, callback)

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

listCustomJobs(request, callback)

listCustomJobs(request: protos.google.cloud.aiplatform.v1beta1.IListCustomJobsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListCustomJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListCustomJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ICustomJob>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListCustomJobsRequest
callback PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListCustomJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListCustomJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ICustomJob>
Returns
TypeDescription
void

listCustomJobsAsync(request, options)

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

Equivalent to listCustomJobs, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListCustomJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.aiplatform.v1beta1.ICustomJob>

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

Example

  /**
   * 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 CustomJobs from.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  The standard list filter.
   *  Supported fields:
   *    * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   *    * `state` supports `=`, `!=` comparisons.
   *    * `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="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
   *    * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
   *    * `NOT display_name="my_job"`
   *    * `create_time>"2021-05-18T00:00:00Z"`
   *    * `labels.keyA=valueA`
   *    * `labels.keyB:*`
   */
  // const filter = 'abc123'
  /**
   *  The standard list page size.
   */
  // const pageSize = 1234
  /**
   *  The standard list page token.
   *  Typically obtained via
   *  ListCustomJobsResponse.next_page_token google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token  of the previous
   *  JobService.ListCustomJobs google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs  call.
   */
  // const pageToken = 'abc123'
  /**
   *  Mask specifying which fields to read.
   */
  // const readMask = {}

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callListCustomJobs() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await aiplatformClient.listCustomJobsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListCustomJobs();

listCustomJobsStream(request, options)

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

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

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListCustomJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

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

listDataLabelingJobs(request, options)

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

Lists DataLabelingJobs in a Location.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListDataLabelingJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IDataLabelingJob[], protos.google.cloud.aiplatform.v1beta1.IListDataLabelingJobsRequest | null, protos.google.cloud.aiplatform.v1beta1.IListDataLabelingJobsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [DataLabelingJob]. 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 listDataLabelingJobsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDataLabelingJobs(request, options, callback)

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

listDataLabelingJobs(request, callback)

listDataLabelingJobs(request: protos.google.cloud.aiplatform.v1beta1.IListDataLabelingJobsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListDataLabelingJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListDataLabelingJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IDataLabelingJob>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListDataLabelingJobsRequest
callback PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListDataLabelingJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListDataLabelingJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IDataLabelingJob>
Returns
TypeDescription
void

listDataLabelingJobsAsync(request, options)

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

Equivalent to listDataLabelingJobs, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListDataLabelingJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IDataLabelingJob>

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

Example

  /**
   * 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 parent of the DataLabelingJob.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  The standard list filter.
   *  Supported fields:
   *    * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   *    * `state` supports `=`, `!=` comparisons.
   *    * `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="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
   *    * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
   *    * `NOT display_name="my_job"`
   *    * `create_time>"2021-05-18T00:00:00Z"`
   *    * `labels.keyA=valueA`
   *    * `labels.keyB:*`
   */
  // const filter = 'abc123'
  /**
   *  The standard list page size.
   */
  // const pageSize = 1234
  /**
   *  The standard list page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Mask specifying which fields to read. FieldMask represents a set of
   *  symbolic field paths. For example, the mask can be `paths: "name"`. The
   *  "name" here is a field in DataLabelingJob.
   *  If this field is not set, all fields of the DataLabelingJob are returned.
   */
  // const readMask = {}
  /**
   *  A comma-separated list of fields to order by, sorted in ascending order by
   *  default.
   *  Use `desc` after a field name for descending.
   */
  // const orderBy = 'abc123'

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callListDataLabelingJobs() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await aiplatformClient.listDataLabelingJobsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListDataLabelingJobs();

listDataLabelingJobsStream(request, options)

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

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

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListDataLabelingJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

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

listHyperparameterTuningJobs(request, options)

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

Lists HyperparameterTuningJobs in a Location.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListHyperparameterTuningJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IHyperparameterTuningJob[], protos.google.cloud.aiplatform.v1beta1.IListHyperparameterTuningJobsRequest | null, protos.google.cloud.aiplatform.v1beta1.IListHyperparameterTuningJobsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [HyperparameterTuningJob]. 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 listHyperparameterTuningJobsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listHyperparameterTuningJobs(request, options, callback)

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

listHyperparameterTuningJobs(request, callback)

listHyperparameterTuningJobs(request: protos.google.cloud.aiplatform.v1beta1.IListHyperparameterTuningJobsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListHyperparameterTuningJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListHyperparameterTuningJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IHyperparameterTuningJob>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListHyperparameterTuningJobsRequest
callback PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListHyperparameterTuningJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListHyperparameterTuningJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IHyperparameterTuningJob>
Returns
TypeDescription
void

listHyperparameterTuningJobsAsync(request, options)

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

Equivalent to listHyperparameterTuningJobs, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListHyperparameterTuningJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IHyperparameterTuningJob>

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

Example

  /**
   * 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 HyperparameterTuningJobs
   *  from. Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  The standard list filter.
   *  Supported fields:
   *    * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   *    * `state` supports `=`, `!=` comparisons.
   *    * `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="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
   *    * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
   *    * `NOT display_name="my_job"`
   *    * `create_time>"2021-05-18T00:00:00Z"`
   *    * `labels.keyA=valueA`
   *    * `labels.keyB:*`
   */
  // const filter = 'abc123'
  /**
   *  The standard list page size.
   */
  // const pageSize = 1234
  /**
   *  The standard list page token.
   *  Typically obtained via
   *  ListHyperparameterTuningJobsResponse.next_page_token google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token  of the previous
   *  JobService.ListHyperparameterTuningJobs google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs  call.
   */
  // const pageToken = 'abc123'
  /**
   *  Mask specifying which fields to read.
   */
  // const readMask = {}

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callListHyperparameterTuningJobs() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await aiplatformClient.listHyperparameterTuningJobsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListHyperparameterTuningJobs();

listHyperparameterTuningJobsStream(request, options)

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

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

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListHyperparameterTuningJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

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

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
NameDescription
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<LocationProtos.google.cloud.location.ILocation>

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

Example

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

listModelDeploymentMonitoringJobs(request, options)

listModelDeploymentMonitoringJobs(request?: protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob[],
        protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest | null,
        protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsResponse
    ]>;

Lists ModelDeploymentMonitoringJobs in a Location.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob[], protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest | null, protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [ModelDeploymentMonitoringJob]. 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 listModelDeploymentMonitoringJobsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listModelDeploymentMonitoringJobs(request, options, callback)

listModelDeploymentMonitoringJobs(request: protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob>
Returns
TypeDescription
void

listModelDeploymentMonitoringJobs(request, callback)

listModelDeploymentMonitoringJobs(request: protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest
callback PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob>
Returns
TypeDescription
void

listModelDeploymentMonitoringJobsAsync(request, options)

listModelDeploymentMonitoringJobsAsync(request?: protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob>;

Equivalent to listModelDeploymentMonitoringJobs, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob>

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

Example

  /**
   * 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 parent of the ModelDeploymentMonitoringJob.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  The standard list filter.
   *  Supported fields:
   *    * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   *    * `state` supports `=`, `!=` comparisons.
   *    * `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="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
   *    * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
   *    * `NOT display_name="my_job"`
   *    * `create_time>"2021-05-18T00:00:00Z"`
   *    * `labels.keyA=valueA`
   *    * `labels.keyB:*`
   */
  // const filter = 'abc123'
  /**
   *  The standard list page size.
   */
  // const pageSize = 1234
  /**
   *  The standard list page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Mask specifying which fields to read
   */
  // const readMask = {}

  // Imports the Aiplatform library
  const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;

  // Instantiates a client
  const aiplatformClient = new JobServiceClient();

  async function callListModelDeploymentMonitoringJobs() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await aiplatformClient.listModelDeploymentMonitoringJobsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListModelDeploymentMonitoringJobs();

listModelDeploymentMonitoringJobsStream(request, options)

listModelDeploymentMonitoringJobsStream(request?: protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListModelDeploymentMonitoringJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [ModelDeploymentMonitoringJob] 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 listModelDeploymentMonitoringJobsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

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
NameDescription
request protos.google.longrunning.ListOperationsRequest

The request object that will be sent.

options gax.CallOptions

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/global.html#CallOptions for the details.

Returns
TypeDescription
AsyncIterable<protos.google.longrunning.ListOperationsResponse>

{Object} An iterable Object that conforms to https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.

Example

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchAnnotationFromAnnotationName(annotationName)

matchAnnotationFromAnnotationName(annotationName: string): string | number;

Parse the annotation from Annotation resource.

Parameter
NameDescription
annotationName string

A fully-qualified path representing Annotation resource.

Returns
TypeDescription
string | number

{string} A string representing the annotation.

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName)

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the annotation_spec from AnnotationSpec resource.

Parameter
NameDescription
annotationSpecName string

A fully-qualified path representing AnnotationSpec resource.

Returns
TypeDescription
string | number

{string} A string representing the annotation_spec.

matchArtifactFromArtifactName(artifactName)

matchArtifactFromArtifactName(artifactName: string): string | number;

Parse the artifact from Artifact resource.

Parameter
NameDescription
artifactName string

A fully-qualified path representing Artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the artifact.

matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName)

matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the batch_prediction_job from BatchPredictionJob resource.

Parameter
NameDescription
batchPredictionJobName string

A fully-qualified path representing BatchPredictionJob resource.

Returns
TypeDescription
string | number

{string} A string representing the batch_prediction_job.

matchContextFromContextName(contextName)

matchContextFromContextName(contextName: string): string | number;

Parse the context from Context resource.

Parameter
NameDescription
contextName string

A fully-qualified path representing Context resource.

Returns
TypeDescription
string | number

{string} A string representing the context.

matchCustomJobFromCustomJobName(customJobName)

matchCustomJobFromCustomJobName(customJobName: string): string | number;

Parse the custom_job from CustomJob resource.

Parameter
NameDescription
customJobName string

A fully-qualified path representing CustomJob resource.

Returns
TypeDescription
string | number

{string} A string representing the custom_job.

matchDataItemFromAnnotationName(annotationName)

matchDataItemFromAnnotationName(annotationName: string): string | number;

Parse the data_item from Annotation resource.

Parameter
NameDescription
annotationName string

A fully-qualified path representing Annotation resource.

Returns
TypeDescription
string | number

{string} A string representing the data_item.

matchDataItemFromDataItemName(dataItemName)

matchDataItemFromDataItemName(dataItemName: string): string | number;

Parse the data_item from DataItem resource.

Parameter
NameDescription
dataItemName string

A fully-qualified path representing DataItem resource.

Returns
TypeDescription
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
NameDescription
dataLabelingJobName string

A fully-qualified path representing DataLabelingJob resource.

Returns
TypeDescription
string | number

{string} A string representing the data_labeling_job.

matchDatasetFromAnnotationName(annotationName)

matchDatasetFromAnnotationName(annotationName: string): string | number;

Parse the dataset from Annotation resource.

Parameter
NameDescription
annotationName string

A fully-qualified path representing Annotation resource.

Returns
TypeDescription
string | number

{string} A string representing the dataset.

matchDatasetFromAnnotationSpecName(annotationSpecName)

matchDatasetFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the dataset from AnnotationSpec resource.

Parameter
NameDescription
annotationSpecName string

A fully-qualified path representing AnnotationSpec resource.

Returns
TypeDescription
string | number

{string} A string representing the dataset.

matchDatasetFromDataItemName(dataItemName)

matchDatasetFromDataItemName(dataItemName: string): string | number;

Parse the dataset from DataItem resource.

Parameter
NameDescription
dataItemName string

A fully-qualified path representing DataItem resource.

Returns
TypeDescription
string | number

{string} A string representing the dataset.

matchDatasetFromDatasetName(datasetName)

matchDatasetFromDatasetName(datasetName: string): string | number;

Parse the dataset from Dataset resource.

Parameter
NameDescription
datasetName string

A fully-qualified path representing Dataset resource.

Returns
TypeDescription
string | number

{string} A string representing the dataset.

matchDatasetFromSavedQueryName(savedQueryName)

matchDatasetFromSavedQueryName(savedQueryName: string): string | number;

Parse the dataset from SavedQuery resource.

Parameter
NameDescription
savedQueryName string

A fully-qualified path representing SavedQuery resource.

Returns
TypeDescription
string | number

{string} A string representing the dataset.

matchDeploymentResourcePoolFromDeploymentResourcePoolName(deploymentResourcePoolName)

matchDeploymentResourcePoolFromDeploymentResourcePoolName(deploymentResourcePoolName: string): string | number;

Parse the deployment_resource_pool from DeploymentResourcePool resource.

Parameter
NameDescription
deploymentResourcePoolName string

A fully-qualified path representing DeploymentResourcePool resource.

Returns
TypeDescription
string | number

{string} A string representing the deployment_resource_pool.

matchEndpointFromEndpointName(endpointName)

matchEndpointFromEndpointName(endpointName: string): string | number;

Parse the endpoint from Endpoint resource.

Parameter
NameDescription
endpointName string

A fully-qualified path representing Endpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the endpoint.

matchEntityTypeFromEntityTypeName(entityTypeName)

matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;

Parse the entity_type from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEntityTypeFromFeatureName(featureName)

matchEntityTypeFromFeatureName(featureName: string): string | number;

Parse the entity_type from Feature resource.

Parameter
NameDescription
featureName string

A fully-qualified path representing Feature resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEvaluationFromModelEvaluationName(modelEvaluationName)

matchEvaluationFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the evaluation from ModelEvaluation resource.

Parameter
NameDescription
modelEvaluationName string

A fully-qualified path representing ModelEvaluation resource.

Returns
TypeDescription
string | number

{string} A string representing the evaluation.

matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName)

matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the evaluation from ModelEvaluationSlice resource.

Parameter
NameDescription
modelEvaluationSliceName string

A fully-qualified path representing ModelEvaluationSlice resource.

Returns
TypeDescription
string | number

{string} A string representing the evaluation.

matchExecutionFromExecutionName(executionName)

matchExecutionFromExecutionName(executionName: string): string | number;

Parse the execution from Execution resource.

Parameter
NameDescription
executionName string

A fully-qualified path representing Execution resource.

Returns
TypeDescription
string | number

{string} A string representing the execution.

matchExperimentFromTensorboardExperimentName(tensorboardExperimentName)

matchExperimentFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the experiment from TensorboardExperiment resource.

Parameter
NameDescription
tensorboardExperimentName string

A fully-qualified path representing TensorboardExperiment resource.

Returns
TypeDescription
string | number

{string} A string representing the experiment.

matchExperimentFromTensorboardRunName(tensorboardRunName)

matchExperimentFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the experiment from TensorboardRun resource.

Parameter
NameDescription
tensorboardRunName string

A fully-qualified path representing TensorboardRun resource.

Returns
TypeDescription
string | number

{string} A string representing the experiment.

matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the experiment from TensorboardTimeSeries resource.

Parameter
NameDescription
tensorboardTimeSeriesName string

A fully-qualified path representing TensorboardTimeSeries resource.

Returns
TypeDescription
string | number

{string} A string representing the experiment.

matchFeatureFromFeatureName(featureName)

matchFeatureFromFeatureName(featureName: string): string | number;

Parse the feature from Feature resource.

Parameter
NameDescription
featureName string

A fully-qualified path representing Feature resource.

Returns
TypeDescription
string | number

{string} A string representing the feature.

matchFeaturestoreFromEntityTypeName(entityTypeName)

matchFeaturestoreFromEntityTypeName(entityTypeName: string): string | number;

Parse the featurestore from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the featurestore.

matchFeaturestoreFromFeatureName(featureName)

matchFeaturestoreFromFeatureName(featureName: string): string | number;

Parse the featurestore from Feature resource.

Parameter
NameDescription
featureName string

A fully-qualified path representing Feature resource.

Returns
TypeDescription
string | number

{string} A string representing the featurestore.

matchFeaturestoreFromFeaturestoreName(featurestoreName)

matchFeaturestoreFromFeaturestoreName(featurestoreName: string): string | number;

Parse the featurestore from Featurestore resource.

Parameter
NameDescription
featurestoreName string

A fully-qualified path representing Featurestore resource.

Returns
TypeDescription
string | number

{string} A string representing the featurestore.

matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName)

matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;

Parse the hyperparameter_tuning_job from HyperparameterTuningJob resource.

Parameter
NameDescription
hyperparameterTuningJobName string

A fully-qualified path representing HyperparameterTuningJob resource.

Returns
TypeDescription
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
NameDescription
indexEndpointName string

A fully-qualified path representing IndexEndpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the index_endpoint.

matchIndexFromIndexName(indexName)

matchIndexFromIndexName(indexName: string): string | number;

Parse the index from Index resource.

Parameter
NameDescription
indexName string

A fully-qualified path representing Index resource.

Returns
TypeDescription
string | number

{string} A string representing the index.

matchLocationFromAnnotationName(annotationName)

matchLocationFromAnnotationName(annotationName: string): string | number;

Parse the location from Annotation resource.

Parameter
NameDescription
annotationName string

A fully-qualified path representing Annotation resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromAnnotationSpecName(annotationSpecName)

matchLocationFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the location from AnnotationSpec resource.

Parameter
NameDescription
annotationSpecName string

A fully-qualified path representing AnnotationSpec resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromArtifactName(artifactName)

matchLocationFromArtifactName(artifactName: string): string | number;

Parse the location from Artifact resource.

Parameter
NameDescription
artifactName string

A fully-qualified path representing Artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromBatchPredictionJobName(batchPredictionJobName)

matchLocationFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the location from BatchPredictionJob resource.

Parameter
NameDescription
batchPredictionJobName string

A fully-qualified path representing BatchPredictionJob resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromContextName(contextName)

matchLocationFromContextName(contextName: string): string | number;

Parse the location from Context resource.

Parameter
NameDescription
contextName string

A fully-qualified path representing Context resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromCustomJobName(customJobName)

matchLocationFromCustomJobName(customJobName: string): string | number;

Parse the location from CustomJob resource.

Parameter
NameDescription
customJobName string

A fully-qualified path representing CustomJob resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDataItemName(dataItemName)

matchLocationFromDataItemName(dataItemName: string): string | number;

Parse the location from DataItem resource.

Parameter
NameDescription
dataItemName string

A fully-qualified path representing DataItem resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDataLabelingJobName(dataLabelingJobName)

matchLocationFromDataLabelingJobName(dataLabelingJobName: string): string | number;

Parse the location from DataLabelingJob resource.

Parameter
NameDescription
dataLabelingJobName string

A fully-qualified path representing DataLabelingJob resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDatasetName(datasetName)

matchLocationFromDatasetName(datasetName: string): string | number;

Parse the location from Dataset resource.

Parameter
NameDescription
datasetName string

A fully-qualified path representing Dataset resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDeploymentResourcePoolName(deploymentResourcePoolName)

matchLocationFromDeploymentResourcePoolName(deploymentResourcePoolName: string): string | number;

Parse the location from DeploymentResourcePool resource.

Parameter
NameDescription
deploymentResourcePoolName string

A fully-qualified path representing DeploymentResourcePool resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromEndpointName(endpointName)

matchLocationFromEndpointName(endpointName: string): string | number;

Parse the location from Endpoint resource.

Parameter
NameDescription
endpointName string

A fully-qualified path representing Endpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromEntityTypeName(entityTypeName)

matchLocationFromEntityTypeName(entityTypeName: string): string | number;

Parse the location from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromExecutionName(executionName)

matchLocationFromExecutionName(executionName: string): string | number;

Parse the location from Execution resource.

Parameter
NameDescription
executionName string

A fully-qualified path representing Execution resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromFeatureName(featureName)

matchLocationFromFeatureName(featureName: string): string | number;

Parse the location from Feature resource.

Parameter
NameDescription
featureName string

A fully-qualified path representing Feature resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromFeaturestoreName(featurestoreName)

matchLocationFromFeaturestoreName(featurestoreName: string): string | number;

Parse the location from Featurestore resource.

Parameter
NameDescription
featurestoreName string

A fully-qualified path representing Featurestore resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName)

matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;

Parse the location from HyperparameterTuningJob resource.

Parameter
NameDescription
hyperparameterTuningJobName string

A fully-qualified path representing HyperparameterTuningJob resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromIndexEndpointName(indexEndpointName)

matchLocationFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the location from IndexEndpoint resource.

Parameter
NameDescription
indexEndpointName string

A fully-qualified path representing IndexEndpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromIndexName(indexName)

matchLocationFromIndexName(indexName: string): string | number;

Parse the location from Index resource.

Parameter
NameDescription
indexName string

A fully-qualified path representing Index resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromMetadataSchemaName(metadataSchemaName)

matchLocationFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the location from MetadataSchema resource.

Parameter
NameDescription
metadataSchemaName string

A fully-qualified path representing MetadataSchema resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromMetadataStoreName(metadataStoreName)

matchLocationFromMetadataStoreName(metadataStoreName: string): string | number;

Parse the location from MetadataStore resource.

Parameter
NameDescription
metadataStoreName string

A fully-qualified path representing MetadataStore resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName)

matchLocationFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number;

Parse the location from ModelDeploymentMonitoringJob resource.

Parameter
NameDescription
modelDeploymentMonitoringJobName string

A fully-qualified path representing ModelDeploymentMonitoringJob resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromModelEvaluationName(modelEvaluationName)

matchLocationFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the location from ModelEvaluation resource.

Parameter
NameDescription
modelEvaluationName string

A fully-qualified path representing ModelEvaluation resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName)

matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the location from ModelEvaluationSlice resource.

Parameter
NameDescription
modelEvaluationSliceName string

A fully-qualified path representing ModelEvaluationSlice resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromModelName(modelName)

matchLocationFromModelName(modelName: string): string | number;

Parse the location from Model resource.

Parameter
NameDescription
modelName string

A fully-qualified path representing Model resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromPipelineJobName(pipelineJobName)

matchLocationFromPipelineJobName(pipelineJobName: string): string | number;

Parse the location from PipelineJob resource.

Parameter
NameDescription
pipelineJobName string

A fully-qualified path representing PipelineJob resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromSavedQueryName(savedQueryName)

matchLocationFromSavedQueryName(savedQueryName: string): string | number;

Parse the location from SavedQuery resource.

Parameter
NameDescription
savedQueryName string

A fully-qualified path representing SavedQuery resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromSpecialistPoolName(specialistPoolName)

matchLocationFromSpecialistPoolName(specialistPoolName: string): string | number;

Parse the location from SpecialistPool resource.

Parameter
NameDescription
specialistPoolName string

A fully-qualified path representing SpecialistPool resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromStudyName(studyName)

matchLocationFromStudyName(studyName: string): string | number;

Parse the location from Study resource.

Parameter
NameDescription
studyName string

A fully-qualified path representing Study resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTensorboardExperimentName(tensorboardExperimentName)

matchLocationFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the location from TensorboardExperiment resource.

Parameter
NameDescription
tensorboardExperimentName string

A fully-qualified path representing TensorboardExperiment resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTensorboardName(tensorboardName)

matchLocationFromTensorboardName(tensorboardName: string): string | number;

Parse the location from Tensorboard resource.

Parameter
NameDescription
tensorboardName string

A fully-qualified path representing Tensorboard resource.

Returns
TypeDescription