import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, IamClient, IamProtos, LocationsClient, LocationProtos } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * A service for creating and managing Vertex AI's jobs. * @class * @memberof v1 */ export declare class JobServiceClient { private _terminated; private _opts; private _providedCustomServicePath; private _gaxModule; private _gaxGrpc; private _protos; private _defaults; private _universeDomain; private _servicePath; auth: gax.GoogleAuth; descriptors: Descriptors; warn: (code: string, message: string, warnType?: string) => void; innerApiCalls: { [name: string]: Function; }; iamClient: IamClient; locationsClient: LocationsClient; pathTemplates: { [name: string]: gax.PathTemplate; }; operationsClient: gax.OperationsClient; jobServiceStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of JobServiceClient. * * @param {object} [options] - The configuration object. * The options accepted by the constructor are described in detail * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance). * The common options are: * @param {object} [options.credentials] - Credentials object. * @param {string} [options.credentials.client_email] * @param {string} [options.credentials.private_key] * @param {string} [options.email] - Account email address. Required when * using a .pem or .p12 keyFilename. * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or * .p12 key downloaded from the Google Developers Console. If you provide * a path to a JSON file, the projectId option below is not necessary. * NOTE: .pem and .p12 require you to specify options.email as well. * @param {number} [options.port] - The port on which to connect to * the remote host. * @param {string} [options.projectId] - The project ID from the Google * Developer's Console, e.g. 'grape-spaceship-123'. We will also check * the environment variable GCLOUD_PROJECT for your project ID. If your * app is running in an environment which supports * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials}, * your project ID will be detected automatically. * @param {string} [options.apiEndpoint] - The domain name of the * API remote host. * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override. * Follows the structure of {@link gapicConfig}. * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode. * For more information, please check the * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}. * @param {gax} [gaxInstance]: 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: true}, gax); * ``` */ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback); /** * 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 {Promise} A promise that resolves to an authenticated service stub. */ initialize(): Promise<{ [name: string]: Function; }>; /** * The DNS address for this API service. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get apiEndpoint(): string; /** * The DNS address for this API service. * @returns {string} The DNS address for this service. */ get apiEndpoint(): string; get universeDomain(): string; /** * The port for this API service. * @returns {number} The default port for this service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. * @returns {string[]} List of default scopes. */ static get scopes(): string[]; getProjectId(): Promise; getProjectId(callback: Callback): void; /** * Creates a CustomJob. A created CustomJob right away * will be attempted to be run. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to create the CustomJob in. * Format: `projects/{project}/locations/{location}` * @param {google.cloud.aiplatform.v1.CustomJob} request.customJob * Required. The CustomJob to create. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.CustomJob|CustomJob}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.create_custom_job.js * region_tag:aiplatform_v1_generated_JobService_CreateCustomJob_async */ createCustomJob(request?: protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.ICustomJob, protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest | undefined, {} | undefined ]>; createCustomJob(request: protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest, options: CallOptions, callback: Callback): void; createCustomJob(request: protos.google.cloud.aiplatform.v1.ICreateCustomJobRequest, callback: Callback): void; /** * Gets a CustomJob. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the CustomJob resource. * Format: * `projects/{project}/locations/{location}/customJobs/{custom_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.CustomJob|CustomJob}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.get_custom_job.js * region_tag:aiplatform_v1_generated_JobService_GetCustomJob_async */ getCustomJob(request?: protos.google.cloud.aiplatform.v1.IGetCustomJobRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.ICustomJob, protos.google.cloud.aiplatform.v1.IGetCustomJobRequest | undefined, {} | undefined ]>; getCustomJob(request: protos.google.cloud.aiplatform.v1.IGetCustomJobRequest, options: CallOptions, callback: Callback): void; getCustomJob(request: protos.google.cloud.aiplatform.v1.IGetCustomJobRequest, callback: Callback): void; /** * 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 * {@link protos.google.cloud.aiplatform.v1.JobService.GetCustomJob|JobService.GetCustomJob} * 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 {@link protos.google.cloud.aiplatform.v1.CustomJob.error|CustomJob.error} value with * a {@link protos.google.rpc.Status.code|google.rpc.Status.code} of 1, corresponding to * `Code.CANCELLED`, and * {@link protos.google.cloud.aiplatform.v1.CustomJob.state|CustomJob.state} is set to * `CANCELLED`. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the CustomJob to cancel. * Format: * `projects/{project}/locations/{location}/customJobs/{custom_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.cancel_custom_job.js * region_tag:aiplatform_v1_generated_JobService_CancelCustomJob_async */ cancelCustomJob(request?: protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest | undefined, {} | undefined ]>; cancelCustomJob(request: protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest, options: CallOptions, callback: Callback): void; cancelCustomJob(request: protos.google.cloud.aiplatform.v1.ICancelCustomJobRequest, callback: Callback): void; /** * Creates a DataLabelingJob. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent of the DataLabelingJob. * Format: `projects/{project}/locations/{location}` * @param {google.cloud.aiplatform.v1.DataLabelingJob} request.dataLabelingJob * Required. The DataLabelingJob to create. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.DataLabelingJob|DataLabelingJob}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.create_data_labeling_job.js * region_tag:aiplatform_v1_generated_JobService_CreateDataLabelingJob_async */ createDataLabelingJob(request?: protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.IDataLabelingJob, (protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest | undefined), {} | undefined ]>; createDataLabelingJob(request: protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest, options: CallOptions, callback: Callback): void; createDataLabelingJob(request: protos.google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest, callback: Callback): void; /** * Gets a DataLabelingJob. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the DataLabelingJob. * Format: * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.DataLabelingJob|DataLabelingJob}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.get_data_labeling_job.js * region_tag:aiplatform_v1_generated_JobService_GetDataLabelingJob_async */ getDataLabelingJob(request?: protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.IDataLabelingJob, protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest | undefined, {} | undefined ]>; getDataLabelingJob(request: protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest, options: CallOptions, callback: Callback): void; getDataLabelingJob(request: protos.google.cloud.aiplatform.v1.IGetDataLabelingJobRequest, callback: Callback): void; /** * Cancels a DataLabelingJob. Success of cancellation is not guaranteed. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the DataLabelingJob. * Format: * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.cancel_data_labeling_job.js * region_tag:aiplatform_v1_generated_JobService_CancelDataLabelingJob_async */ cancelDataLabelingJob(request?: protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest | undefined), {} | undefined ]>; cancelDataLabelingJob(request: protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest, options: CallOptions, callback: Callback): void; cancelDataLabelingJob(request: protos.google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest, callback: Callback): void; /** * Creates a HyperparameterTuningJob * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to create the * HyperparameterTuningJob in. Format: * `projects/{project}/locations/{location}` * @param {google.cloud.aiplatform.v1.HyperparameterTuningJob} request.hyperparameterTuningJob * Required. The HyperparameterTuningJob to create. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.HyperparameterTuningJob|HyperparameterTuningJob}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.create_hyperparameter_tuning_job.js * region_tag:aiplatform_v1_generated_JobService_CreateHyperparameterTuningJob_async */ createHyperparameterTuningJob(request?: protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob, (protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest | undefined), {} | undefined ]>; createHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest, options: CallOptions, callback: Callback): void; createHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest, callback: Callback): void; /** * Gets a HyperparameterTuningJob * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the HyperparameterTuningJob resource. * Format: * `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.HyperparameterTuningJob|HyperparameterTuningJob}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.get_hyperparameter_tuning_job.js * region_tag:aiplatform_v1_generated_JobService_GetHyperparameterTuningJob_async */ getHyperparameterTuningJob(request?: protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob, (protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest | undefined), {} | undefined ]>; getHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest, options: CallOptions, callback: Callback): void; getHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest, callback: Callback): void; /** * 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 * {@link protos.google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob|JobService.GetHyperparameterTuningJob} * 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 * {@link protos.google.cloud.aiplatform.v1.HyperparameterTuningJob.error|HyperparameterTuningJob.error} * value with a {@link protos.google.rpc.Status.code|google.rpc.Status.code} of 1, * corresponding to `Code.CANCELLED`, and * {@link protos.google.cloud.aiplatform.v1.HyperparameterTuningJob.state|HyperparameterTuningJob.state} * is set to `CANCELLED`. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the HyperparameterTuningJob to cancel. * Format: * `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.cancel_hyperparameter_tuning_job.js * region_tag:aiplatform_v1_generated_JobService_CancelHyperparameterTuningJob_async */ cancelHyperparameterTuningJob(request?: protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest | undefined), {} | undefined ]>; cancelHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest, options: CallOptions, callback: Callback): void; cancelHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest, callback: Callback): void; /** * Creates a NasJob * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to create the NasJob in. * Format: `projects/{project}/locations/{location}` * @param {google.cloud.aiplatform.v1.NasJob} request.nasJob * Required. The NasJob to create. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.NasJob|NasJob}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.create_nas_job.js * region_tag:aiplatform_v1_generated_JobService_CreateNasJob_async */ createNasJob(request?: protos.google.cloud.aiplatform.v1.ICreateNasJobRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.INasJob, protos.google.cloud.aiplatform.v1.ICreateNasJobRequest | undefined, {} | undefined ]>; createNasJob(request: protos.google.cloud.aiplatform.v1.ICreateNasJobRequest, options: CallOptions, callback: Callback): void; createNasJob(request: protos.google.cloud.aiplatform.v1.ICreateNasJobRequest, callback: Callback): void; /** * Gets a NasJob * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the NasJob resource. * Format: * `projects/{project}/locations/{location}/nasJobs/{nas_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.NasJob|NasJob}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.get_nas_job.js * region_tag:aiplatform_v1_generated_JobService_GetNasJob_async */ getNasJob(request?: protos.google.cloud.aiplatform.v1.IGetNasJobRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.INasJob, protos.google.cloud.aiplatform.v1.IGetNasJobRequest | undefined, {} | undefined ]>; getNasJob(request: protos.google.cloud.aiplatform.v1.IGetNasJobRequest, options: CallOptions, callback: Callback): void; getNasJob(request: protos.google.cloud.aiplatform.v1.IGetNasJobRequest, callback: Callback): void; /** * Cancels a NasJob. * Starts asynchronous cancellation on the NasJob. The server * makes a best effort to cancel the job, but success is not * guaranteed. Clients can use * {@link protos.google.cloud.aiplatform.v1.JobService.GetNasJob|JobService.GetNasJob} or * other methods to check whether the cancellation succeeded or whether the * job completed despite cancellation. On successful cancellation, * the NasJob is not deleted; instead it becomes a job with * a {@link protos.google.cloud.aiplatform.v1.NasJob.error|NasJob.error} value with a * {@link protos.google.rpc.Status.code|google.rpc.Status.code} of 1, corresponding to * `Code.CANCELLED`, and * {@link protos.google.cloud.aiplatform.v1.NasJob.state|NasJob.state} is set to * `CANCELLED`. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the NasJob to cancel. * Format: * `projects/{project}/locations/{location}/nasJobs/{nas_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.cancel_nas_job.js * region_tag:aiplatform_v1_generated_JobService_CancelNasJob_async */ cancelNasJob(request?: protos.google.cloud.aiplatform.v1.ICancelNasJobRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.ICancelNasJobRequest | undefined, {} | undefined ]>; cancelNasJob(request: protos.google.cloud.aiplatform.v1.ICancelNasJobRequest, options: CallOptions, callback: Callback): void; cancelNasJob(request: protos.google.cloud.aiplatform.v1.ICancelNasJobRequest, callback: Callback): void; /** * Gets a NasTrialDetail. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the NasTrialDetail resource. * Format: * `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.NasTrialDetail|NasTrialDetail}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.get_nas_trial_detail.js * region_tag:aiplatform_v1_generated_JobService_GetNasTrialDetail_async */ getNasTrialDetail(request?: protos.google.cloud.aiplatform.v1.IGetNasTrialDetailRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.INasTrialDetail, protos.google.cloud.aiplatform.v1.IGetNasTrialDetailRequest | undefined, {} | undefined ]>; getNasTrialDetail(request: protos.google.cloud.aiplatform.v1.IGetNasTrialDetailRequest, options: CallOptions, callback: Callback): void; getNasTrialDetail(request: protos.google.cloud.aiplatform.v1.IGetNasTrialDetailRequest, callback: Callback): void; /** * Creates a BatchPredictionJob. A BatchPredictionJob once created will * right away be attempted to start. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to create the * BatchPredictionJob in. Format: `projects/{project}/locations/{location}` * @param {google.cloud.aiplatform.v1.BatchPredictionJob} request.batchPredictionJob * Required. The BatchPredictionJob to create. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.BatchPredictionJob|BatchPredictionJob}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.create_batch_prediction_job.js * region_tag:aiplatform_v1_generated_JobService_CreateBatchPredictionJob_async */ createBatchPredictionJob(request?: protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.IBatchPredictionJob, (protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest | undefined), {} | undefined ]>; createBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest, options: CallOptions, callback: Callback): void; createBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest, callback: Callback): void; /** * Gets a BatchPredictionJob * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the BatchPredictionJob resource. * Format: * `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.BatchPredictionJob|BatchPredictionJob}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.get_batch_prediction_job.js * region_tag:aiplatform_v1_generated_JobService_GetBatchPredictionJob_async */ getBatchPredictionJob(request?: protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.IBatchPredictionJob, (protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest | undefined), {} | undefined ]>; getBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest, options: CallOptions, callback: Callback): void; getBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest, callback: Callback): void; /** * 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 * {@link protos.google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob|JobService.GetBatchPredictionJob} * 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 * {@link protos.google.cloud.aiplatform.v1.BatchPredictionJob.state|BatchPredictionJob.state} * is set to `CANCELLED`. Any files already outputted by the job are not * deleted. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the BatchPredictionJob to cancel. * Format: * `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.cancel_batch_prediction_job.js * region_tag:aiplatform_v1_generated_JobService_CancelBatchPredictionJob_async */ cancelBatchPredictionJob(request?: protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest | undefined), {} | undefined ]>; cancelBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest, options: CallOptions, callback: Callback): void; cancelBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest, callback: Callback): void; /** * Creates a ModelDeploymentMonitoringJob. It will run periodically on a * configured interval. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent of the ModelDeploymentMonitoringJob. * Format: `projects/{project}/locations/{location}` * @param {google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob} request.modelDeploymentMonitoringJob * Required. The ModelDeploymentMonitoringJob to create * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob|ModelDeploymentMonitoringJob}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.create_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_CreateModelDeploymentMonitoringJob_async */ createModelDeploymentMonitoringJob(request?: protos.google.cloud.aiplatform.v1.ICreateModelDeploymentMonitoringJobRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.IModelDeploymentMonitoringJob, (protos.google.cloud.aiplatform.v1.ICreateModelDeploymentMonitoringJobRequest | undefined), {} | undefined ]>; createModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1.ICreateModelDeploymentMonitoringJobRequest, options: CallOptions, callback: Callback): void; createModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1.ICreateModelDeploymentMonitoringJobRequest, callback: Callback): void; /** * Gets a ModelDeploymentMonitoringJob. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the ModelDeploymentMonitoringJob. * Format: * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob|ModelDeploymentMonitoringJob}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.get_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_GetModelDeploymentMonitoringJob_async */ getModelDeploymentMonitoringJob(request?: protos.google.cloud.aiplatform.v1.IGetModelDeploymentMonitoringJobRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.IModelDeploymentMonitoringJob, (protos.google.cloud.aiplatform.v1.IGetModelDeploymentMonitoringJobRequest | undefined), {} | undefined ]>; getModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1.IGetModelDeploymentMonitoringJobRequest, options: CallOptions, callback: Callback): void; getModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1.IGetModelDeploymentMonitoringJobRequest, callback: Callback): void; /** * Pauses a ModelDeploymentMonitoringJob. If the job is running, the server * makes a best effort to cancel the job. Will mark * {@link protos.google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state|ModelDeploymentMonitoringJob.state} * to 'PAUSED'. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the ModelDeploymentMonitoringJob to pause. * Format: * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.pause_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_PauseModelDeploymentMonitoringJob_async */ pauseModelDeploymentMonitoringJob(request?: protos.google.cloud.aiplatform.v1.IPauseModelDeploymentMonitoringJobRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.aiplatform.v1.IPauseModelDeploymentMonitoringJobRequest | undefined), {} | undefined ]>; pauseModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1.IPauseModelDeploymentMonitoringJobRequest, options: CallOptions, callback: Callback): void; pauseModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1.IPauseModelDeploymentMonitoringJobRequest, callback: Callback): void; /** * Resumes a paused ModelDeploymentMonitoringJob. It will start to run from * next scheduled time. A deleted ModelDeploymentMonitoringJob can't be * resumed. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the ModelDeploymentMonitoringJob to resume. * Format: * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.resume_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_ResumeModelDeploymentMonitoringJob_async */ resumeModelDeploymentMonitoringJob(request?: protos.google.cloud.aiplatform.v1.IResumeModelDeploymentMonitoringJobRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.aiplatform.v1.IResumeModelDeploymentMonitoringJobRequest | undefined), {} | undefined ]>; resumeModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1.IResumeModelDeploymentMonitoringJobRequest, options: CallOptions, callback: Callback): void; resumeModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1.IResumeModelDeploymentMonitoringJobRequest, callback: Callback): void; /** * Deletes a CustomJob. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the CustomJob resource to be deleted. * Format: * `projects/{project}/locations/{location}/customJobs/{custom_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_custom_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteCustomJob_async */ deleteCustomJob(request?: protos.google.cloud.aiplatform.v1.IDeleteCustomJobRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteCustomJob(request: protos.google.cloud.aiplatform.v1.IDeleteCustomJobRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteCustomJob(request: protos.google.cloud.aiplatform.v1.IDeleteCustomJobRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteCustomJob()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_custom_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteCustomJob_async */ checkDeleteCustomJobProgress(name: string): Promise>; /** * Deletes a DataLabelingJob. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the DataLabelingJob to be deleted. * Format: * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_data_labeling_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteDataLabelingJob_async */ deleteDataLabelingJob(request?: protos.google.cloud.aiplatform.v1.IDeleteDataLabelingJobRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteDataLabelingJob(request: protos.google.cloud.aiplatform.v1.IDeleteDataLabelingJobRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteDataLabelingJob(request: protos.google.cloud.aiplatform.v1.IDeleteDataLabelingJobRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteDataLabelingJob()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_data_labeling_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteDataLabelingJob_async */ checkDeleteDataLabelingJobProgress(name: string): Promise>; /** * Deletes a HyperparameterTuningJob. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the HyperparameterTuningJob resource to be deleted. * Format: * `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_hyperparameter_tuning_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteHyperparameterTuningJob_async */ deleteHyperparameterTuningJob(request?: protos.google.cloud.aiplatform.v1.IDeleteHyperparameterTuningJobRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.IDeleteHyperparameterTuningJobRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1.IDeleteHyperparameterTuningJobRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteHyperparameterTuningJob()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_hyperparameter_tuning_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteHyperparameterTuningJob_async */ checkDeleteHyperparameterTuningJobProgress(name: string): Promise>; /** * Deletes a NasJob. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the NasJob resource to be deleted. * Format: * `projects/{project}/locations/{location}/nasJobs/{nas_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_nas_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteNasJob_async */ deleteNasJob(request?: protos.google.cloud.aiplatform.v1.IDeleteNasJobRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteNasJob(request: protos.google.cloud.aiplatform.v1.IDeleteNasJobRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteNasJob(request: protos.google.cloud.aiplatform.v1.IDeleteNasJobRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteNasJob()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_nas_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteNasJob_async */ checkDeleteNasJobProgress(name: string): Promise>; /** * Deletes a BatchPredictionJob. Can only be called on jobs that already * finished. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the BatchPredictionJob resource to be deleted. * Format: * `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_batch_prediction_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteBatchPredictionJob_async */ deleteBatchPredictionJob(request?: protos.google.cloud.aiplatform.v1.IDeleteBatchPredictionJobRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.IDeleteBatchPredictionJobRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteBatchPredictionJob(request: protos.google.cloud.aiplatform.v1.IDeleteBatchPredictionJobRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteBatchPredictionJob()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_batch_prediction_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteBatchPredictionJob_async */ checkDeleteBatchPredictionJobProgress(name: string): Promise>; /** * Updates a ModelDeploymentMonitoringJob. * * @param {Object} request * The request object that will be sent. * @param {google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob} request.modelDeploymentMonitoringJob * Required. The model monitoring configuration which replaces the resource on * the server. * @param {google.protobuf.FieldMask} request.updateMask * 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` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.update_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_UpdateModelDeploymentMonitoringJob_async */ updateModelDeploymentMonitoringJob(request?: protos.google.cloud.aiplatform.v1.IUpdateModelDeploymentMonitoringJobRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; updateModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1.IUpdateModelDeploymentMonitoringJobRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; updateModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1.IUpdateModelDeploymentMonitoringJobRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `updateModelDeploymentMonitoringJob()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.update_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_UpdateModelDeploymentMonitoringJob_async */ checkUpdateModelDeploymentMonitoringJobProgress(name: string): Promise>; /** * Deletes a ModelDeploymentMonitoringJob. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the model monitoring job to delete. * Format: * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteModelDeploymentMonitoringJob_async */ deleteModelDeploymentMonitoringJob(request?: protos.google.cloud.aiplatform.v1.IDeleteModelDeploymentMonitoringJobRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1.IDeleteModelDeploymentMonitoringJobRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1.IDeleteModelDeploymentMonitoringJobRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteModelDeploymentMonitoringJob()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteModelDeploymentMonitoringJob_async */ checkDeleteModelDeploymentMonitoringJobProgress(name: string): Promise>; /** * Lists CustomJobs in a Location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to list the CustomJobs from. * Format: `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * Typically obtained via * {@link protos.google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} * of the previous * {@link protos.google.cloud.aiplatform.v1.JobService.ListCustomJobs|JobService.ListCustomJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.CustomJob|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listCustomJobs(request?: protos.google.cloud.aiplatform.v1.IListCustomJobsRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.ICustomJob[], protos.google.cloud.aiplatform.v1.IListCustomJobsRequest | null, protos.google.cloud.aiplatform.v1.IListCustomJobsResponse ]>; listCustomJobs(request: protos.google.cloud.aiplatform.v1.IListCustomJobsRequest, options: CallOptions, callback: PaginationCallback): void; listCustomJobs(request: protos.google.cloud.aiplatform.v1.IListCustomJobsRequest, callback: PaginationCallback): void; /** * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to list the CustomJobs from. * Format: `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * Typically obtained via * {@link protos.google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} * of the previous * {@link protos.google.cloud.aiplatform.v1.JobService.ListCustomJobs|JobService.ListCustomJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.CustomJob|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listCustomJobsStream(request?: protos.google.cloud.aiplatform.v1.IListCustomJobsRequest, options?: CallOptions): Transform; /** * Equivalent to `listCustomJobs`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to list the CustomJobs from. * Format: `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * Typically obtained via * {@link protos.google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} * of the previous * {@link protos.google.cloud.aiplatform.v1.JobService.ListCustomJobs|JobService.ListCustomJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.aiplatform.v1.CustomJob|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.list_custom_jobs.js * region_tag:aiplatform_v1_generated_JobService_ListCustomJobs_async */ listCustomJobsAsync(request?: protos.google.cloud.aiplatform.v1.IListCustomJobsRequest, options?: CallOptions): AsyncIterable; /** * Lists DataLabelingJobs in a Location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent of the DataLabelingJob. * Format: `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * @param {google.protobuf.FieldMask} request.readMask * 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. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order by * default. * Use `desc` after a field name for descending. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.DataLabelingJob|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDataLabelingJobs(request?: protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.IDataLabelingJob[], protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest | null, protos.google.cloud.aiplatform.v1.IListDataLabelingJobsResponse ]>; listDataLabelingJobs(request: protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest, options: CallOptions, callback: PaginationCallback): void; listDataLabelingJobs(request: protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest, callback: PaginationCallback): void; /** * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent of the DataLabelingJob. * Format: `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * @param {google.protobuf.FieldMask} request.readMask * 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. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order by * default. * Use `desc` after a field name for descending. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.DataLabelingJob|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDataLabelingJobsStream(request?: protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest, options?: CallOptions): Transform; /** * Equivalent to `listDataLabelingJobs`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent of the DataLabelingJob. * Format: `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * @param {google.protobuf.FieldMask} request.readMask * 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. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order by * default. * Use `desc` after a field name for descending. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.aiplatform.v1.DataLabelingJob|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.list_data_labeling_jobs.js * region_tag:aiplatform_v1_generated_JobService_ListDataLabelingJobs_async */ listDataLabelingJobsAsync(request?: protos.google.cloud.aiplatform.v1.IListDataLabelingJobsRequest, options?: CallOptions): AsyncIterable; /** * Lists HyperparameterTuningJobs in a Location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to list the * HyperparameterTuningJobs from. Format: * `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * Typically obtained via * {@link protos.google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} * of the previous * {@link protos.google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.HyperparameterTuningJob|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listHyperparameterTuningJobs(request?: protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.IHyperparameterTuningJob[], protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest | null, protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsResponse ]>; listHyperparameterTuningJobs(request: protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest, options: CallOptions, callback: PaginationCallback): void; listHyperparameterTuningJobs(request: protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest, callback: PaginationCallback): void; /** * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to list the * HyperparameterTuningJobs from. Format: * `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * Typically obtained via * {@link protos.google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} * of the previous * {@link protos.google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.HyperparameterTuningJob|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listHyperparameterTuningJobsStream(request?: protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest, options?: CallOptions): Transform; /** * Equivalent to `listHyperparameterTuningJobs`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to list the * HyperparameterTuningJobs from. Format: * `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * Typically obtained via * {@link protos.google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} * of the previous * {@link protos.google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.aiplatform.v1.HyperparameterTuningJob|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.list_hyperparameter_tuning_jobs.js * region_tag:aiplatform_v1_generated_JobService_ListHyperparameterTuningJobs_async */ listHyperparameterTuningJobsAsync(request?: protos.google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest, options?: CallOptions): AsyncIterable; /** * Lists NasJobs in a Location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to list the NasJobs * from. Format: `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * Typically obtained via * {@link protos.google.cloud.aiplatform.v1.ListNasJobsResponse.next_page_token|ListNasJobsResponse.next_page_token} * of the previous * {@link protos.google.cloud.aiplatform.v1.JobService.ListNasJobs|JobService.ListNasJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.NasJob|NasJob}. * 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 `listNasJobsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNasJobs(request?: protos.google.cloud.aiplatform.v1.IListNasJobsRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.INasJob[], protos.google.cloud.aiplatform.v1.IListNasJobsRequest | null, protos.google.cloud.aiplatform.v1.IListNasJobsResponse ]>; listNasJobs(request: protos.google.cloud.aiplatform.v1.IListNasJobsRequest, options: CallOptions, callback: PaginationCallback): void; listNasJobs(request: protos.google.cloud.aiplatform.v1.IListNasJobsRequest, callback: PaginationCallback): void; /** * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to list the NasJobs * from. Format: `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * Typically obtained via * {@link protos.google.cloud.aiplatform.v1.ListNasJobsResponse.next_page_token|ListNasJobsResponse.next_page_token} * of the previous * {@link protos.google.cloud.aiplatform.v1.JobService.ListNasJobs|JobService.ListNasJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.NasJob|NasJob} 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 `listNasJobsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNasJobsStream(request?: protos.google.cloud.aiplatform.v1.IListNasJobsRequest, options?: CallOptions): Transform; /** * Equivalent to `listNasJobs`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to list the NasJobs * from. Format: `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * Typically obtained via * {@link protos.google.cloud.aiplatform.v1.ListNasJobsResponse.next_page_token|ListNasJobsResponse.next_page_token} * of the previous * {@link protos.google.cloud.aiplatform.v1.JobService.ListNasJobs|JobService.ListNasJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.aiplatform.v1.NasJob|NasJob}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.list_nas_jobs.js * region_tag:aiplatform_v1_generated_JobService_ListNasJobs_async */ listNasJobsAsync(request?: protos.google.cloud.aiplatform.v1.IListNasJobsRequest, options?: CallOptions): AsyncIterable; /** * List top NasTrialDetails of a NasJob. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The name of the NasJob resource. * Format: * `projects/{project}/locations/{location}/nasJobs/{nas_job}` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * Typically obtained via * {@link protos.google.cloud.aiplatform.v1.ListNasTrialDetailsResponse.next_page_token|ListNasTrialDetailsResponse.next_page_token} * of the previous * {@link protos.google.cloud.aiplatform.v1.JobService.ListNasTrialDetails|JobService.ListNasTrialDetails} * call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.NasTrialDetail|NasTrialDetail}. * 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 `listNasTrialDetailsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNasTrialDetails(request?: protos.google.cloud.aiplatform.v1.IListNasTrialDetailsRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.INasTrialDetail[], protos.google.cloud.aiplatform.v1.IListNasTrialDetailsRequest | null, protos.google.cloud.aiplatform.v1.IListNasTrialDetailsResponse ]>; listNasTrialDetails(request: protos.google.cloud.aiplatform.v1.IListNasTrialDetailsRequest, options: CallOptions, callback: PaginationCallback): void; listNasTrialDetails(request: protos.google.cloud.aiplatform.v1.IListNasTrialDetailsRequest, callback: PaginationCallback): void; /** * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The name of the NasJob resource. * Format: * `projects/{project}/locations/{location}/nasJobs/{nas_job}` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * Typically obtained via * {@link protos.google.cloud.aiplatform.v1.ListNasTrialDetailsResponse.next_page_token|ListNasTrialDetailsResponse.next_page_token} * of the previous * {@link protos.google.cloud.aiplatform.v1.JobService.ListNasTrialDetails|JobService.ListNasTrialDetails} * call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.NasTrialDetail|NasTrialDetail} 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 `listNasTrialDetailsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNasTrialDetailsStream(request?: protos.google.cloud.aiplatform.v1.IListNasTrialDetailsRequest, options?: CallOptions): Transform; /** * Equivalent to `listNasTrialDetails`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The name of the NasJob resource. * Format: * `projects/{project}/locations/{location}/nasJobs/{nas_job}` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * Typically obtained via * {@link protos.google.cloud.aiplatform.v1.ListNasTrialDetailsResponse.next_page_token|ListNasTrialDetailsResponse.next_page_token} * of the previous * {@link protos.google.cloud.aiplatform.v1.JobService.ListNasTrialDetails|JobService.ListNasTrialDetails} * call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.aiplatform.v1.NasTrialDetail|NasTrialDetail}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.list_nas_trial_details.js * region_tag:aiplatform_v1_generated_JobService_ListNasTrialDetails_async */ listNasTrialDetailsAsync(request?: protos.google.cloud.aiplatform.v1.IListNasTrialDetailsRequest, options?: CallOptions): AsyncIterable; /** * Lists BatchPredictionJobs in a Location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to list the BatchPredictionJobs * from. Format: `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * Typically obtained via * {@link protos.google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} * of the previous * {@link protos.google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.BatchPredictionJob|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listBatchPredictionJobs(request?: protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.IBatchPredictionJob[], protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest | null, protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsResponse ]>; listBatchPredictionJobs(request: protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest, options: CallOptions, callback: PaginationCallback): void; listBatchPredictionJobs(request: protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest, callback: PaginationCallback): void; /** * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to list the BatchPredictionJobs * from. Format: `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * Typically obtained via * {@link protos.google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} * of the previous * {@link protos.google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.BatchPredictionJob|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listBatchPredictionJobsStream(request?: protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest, options?: CallOptions): Transform; /** * Equivalent to `listBatchPredictionJobs`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the Location to list the BatchPredictionJobs * from. Format: `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * Typically obtained via * {@link protos.google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} * of the previous * {@link protos.google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.aiplatform.v1.BatchPredictionJob|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.list_batch_prediction_jobs.js * region_tag:aiplatform_v1_generated_JobService_ListBatchPredictionJobs_async */ listBatchPredictionJobsAsync(request?: protos.google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest, options?: CallOptions): AsyncIterable; /** * Searches Model Monitoring Statistics generated within a given time window. * * @param {Object} request * The request object that will be sent. * @param {string} request.modelDeploymentMonitoringJob * Required. ModelDeploymentMonitoring Job resource name. * Format: * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` * @param {string} request.deployedModelId * Required. The DeployedModel ID of the * [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id]. * @param {string} request.featureDisplayName * The feature display name. If specified, only return the stats belonging to * this feature. Format: * {@link protos.google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name|ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name}, * example: "user_destination". * @param {number[]} request.objectives * Required. Objectives of the stats to retrieve. * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * A page token received from a previous * {@link protos.google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies|JobService.SearchModelDeploymentMonitoringStatsAnomalies} * call. * @param {google.protobuf.Timestamp} request.startTime * The earliest timestamp of stats being generated. * If not set, indicates fetching stats till the earliest possible one. * @param {google.protobuf.Timestamp} request.endTime * The latest timestamp of stats being generated. * If not set, indicates feching stats till the latest possible one. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies|ModelMonitoringStatsAnomalies}. * 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 `searchModelDeploymentMonitoringStatsAnomaliesAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchModelDeploymentMonitoringStatsAnomalies(request?: protos.google.cloud.aiplatform.v1.ISearchModelDeploymentMonitoringStatsAnomaliesRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.IModelMonitoringStatsAnomalies[], protos.google.cloud.aiplatform.v1.ISearchModelDeploymentMonitoringStatsAnomaliesRequest | null, protos.google.cloud.aiplatform.v1.ISearchModelDeploymentMonitoringStatsAnomaliesResponse ]>; searchModelDeploymentMonitoringStatsAnomalies(request: protos.google.cloud.aiplatform.v1.ISearchModelDeploymentMonitoringStatsAnomaliesRequest, options: CallOptions, callback: PaginationCallback): void; searchModelDeploymentMonitoringStatsAnomalies(request: protos.google.cloud.aiplatform.v1.ISearchModelDeploymentMonitoringStatsAnomaliesRequest, callback: PaginationCallback): void; /** * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.modelDeploymentMonitoringJob * Required. ModelDeploymentMonitoring Job resource name. * Format: * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` * @param {string} request.deployedModelId * Required. The DeployedModel ID of the * [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id]. * @param {string} request.featureDisplayName * The feature display name. If specified, only return the stats belonging to * this feature. Format: * {@link protos.google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name|ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name}, * example: "user_destination". * @param {number[]} request.objectives * Required. Objectives of the stats to retrieve. * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * A page token received from a previous * {@link protos.google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies|JobService.SearchModelDeploymentMonitoringStatsAnomalies} * call. * @param {google.protobuf.Timestamp} request.startTime * The earliest timestamp of stats being generated. * If not set, indicates fetching stats till the earliest possible one. * @param {google.protobuf.Timestamp} request.endTime * The latest timestamp of stats being generated. * If not set, indicates feching stats till the latest possible one. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies|ModelMonitoringStatsAnomalies} 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 `searchModelDeploymentMonitoringStatsAnomaliesAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchModelDeploymentMonitoringStatsAnomaliesStream(request?: protos.google.cloud.aiplatform.v1.ISearchModelDeploymentMonitoringStatsAnomaliesRequest, options?: CallOptions): Transform; /** * Equivalent to `searchModelDeploymentMonitoringStatsAnomalies`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.modelDeploymentMonitoringJob * Required. ModelDeploymentMonitoring Job resource name. * Format: * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` * @param {string} request.deployedModelId * Required. The DeployedModel ID of the * [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id]. * @param {string} request.featureDisplayName * The feature display name. If specified, only return the stats belonging to * this feature. Format: * {@link protos.google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name|ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name}, * example: "user_destination". * @param {number[]} request.objectives * Required. Objectives of the stats to retrieve. * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * A page token received from a previous * {@link protos.google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies|JobService.SearchModelDeploymentMonitoringStatsAnomalies} * call. * @param {google.protobuf.Timestamp} request.startTime * The earliest timestamp of stats being generated. * If not set, indicates fetching stats till the earliest possible one. * @param {google.protobuf.Timestamp} request.endTime * The latest timestamp of stats being generated. * If not set, indicates feching stats till the latest possible one. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies|ModelMonitoringStatsAnomalies}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.search_model_deployment_monitoring_stats_anomalies.js * region_tag:aiplatform_v1_generated_JobService_SearchModelDeploymentMonitoringStatsAnomalies_async */ searchModelDeploymentMonitoringStatsAnomaliesAsync(request?: protos.google.cloud.aiplatform.v1.ISearchModelDeploymentMonitoringStatsAnomaliesRequest, options?: CallOptions): AsyncIterable; /** * Lists ModelDeploymentMonitoringJobs in a Location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent of the ModelDeploymentMonitoringJob. * Format: `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelDeploymentMonitoringJobs(request?: protos.google.cloud.aiplatform.v1.IListModelDeploymentMonitoringJobsRequest, options?: CallOptions): Promise<[ protos.google.cloud.aiplatform.v1.IModelDeploymentMonitoringJob[], protos.google.cloud.aiplatform.v1.IListModelDeploymentMonitoringJobsRequest | null, protos.google.cloud.aiplatform.v1.IListModelDeploymentMonitoringJobsResponse ]>; listModelDeploymentMonitoringJobs(request: protos.google.cloud.aiplatform.v1.IListModelDeploymentMonitoringJobsRequest, options: CallOptions, callback: PaginationCallback): void; listModelDeploymentMonitoringJobs(request: protos.google.cloud.aiplatform.v1.IListModelDeploymentMonitoringJobsRequest, callback: PaginationCallback): void; /** * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent of the ModelDeploymentMonitoringJob. * Format: `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelDeploymentMonitoringJobsStream(request?: protos.google.cloud.aiplatform.v1.IListModelDeploymentMonitoringJobsRequest, options?: CallOptions): Transform; /** * Equivalent to `listModelDeploymentMonitoringJobs`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent of the ModelDeploymentMonitoringJob. * Format: `projects/{project}/locations/{location}` * @param {string} request.filter * 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:*` * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.list_model_deployment_monitoring_jobs.js * region_tag:aiplatform_v1_generated_JobService_ListModelDeploymentMonitoringJobs_async */ listModelDeploymentMonitoringJobsAsync(request?: protos.google.cloud.aiplatform.v1.IListModelDeploymentMonitoringJobsRequest, options?: CallOptions): AsyncIterable; /** * Gets the access control policy for a resource. Returns an empty policy * if the resource exists and does not have a policy set. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy is being requested. * See the operation documentation for the appropriate value for this field. * @param {Object} [request.options] * OPTIONAL: A `GetPolicyOptions` object for specifying options to * `GetIamPolicy`. This field is only used by Cloud IAM. * * This object should have the same structure as {@link google.iam.v1.GetPolicyOptions | GetPolicyOptions}. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * * The second parameter to the callback is an object representing {@link google.iam.v1.Policy | Policy}. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.iam.v1.Policy | Policy}. * The promise has a method named "cancel" which cancels the ongoing API call. */ getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise<[IamProtos.google.iam.v1.Policy]>; /** * Returns permissions that a caller has on the specified resource. If the * resource does not exist, this will return an empty set of * permissions, not a NOT_FOUND error. * * Note: This operation is designed to be used for building * permission-aware UIs and command-line tools, not for authorization * checking. This operation may "fail open" without warning. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. */ setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise<[IamProtos.google.iam.v1.Policy]>; /** * Returns permissions that a caller has on the specified resource. If the * resource does not exist, this will return an empty set of * permissions, not a NOT_FOUND error. * * Note: This operation is designed to be used for building * permission-aware UIs and command-line tools, not for authorization * checking. This operation may "fail open" without warning. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. * */ testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>; /** * Gets information about a location. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Resource name for the location. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` * const [response] = await client.getLocation(request); * ``` */ getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * 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. * @param {Object} request * The request object that will be sent. * @param {string} request.name * The resource that owns the locations collection, if applicable. * @param {string} request.filter * The standard list filter. * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` * const iterable = client.listLocationsAsync(request); * for await (const response of iterable) { * // process response * } * ``` */ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable; /** * 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. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} * for the details. * @param {function(?Error, ?Object)=} callback * The function which will be called with the result of the API call. * * The second parameter to the callback is an object representing * {@link google.longrunning.Operation | google.longrunning.Operation}. * @return {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * {@link google.longrunning.Operation | google.longrunning.Operation}. * The promise has a method named "cancel" which cancels the ongoing API call. * * @example * ``` * const client = longrunning.operationsClient(); * const name = ''; * const [response] = await client.getOperation({name}); * // doThingsWith(response) * ``` */ getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise<[protos.google.longrunning.Operation]>; /** * 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. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation collection. * @param {string} request.filter - The standard list filter. * @param {number=} request.pageSize - * The maximum number of resources contained in the underlying API * response. If page streaming is performed per-resource, this * parameter does not affect the return value. If page streaming is * performed per-page, this determines the maximum number of * resources in a page. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the * details. * @returns {Object} * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}. * * @example * ``` * const client = longrunning.operationsClient(); * for await (const response of client.listOperationsAsync(request)); * // doThingsWith(response) * ``` */ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable; /** * 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 * {@link Operations.GetOperation} 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 {@link Operation.error} value with a {@link google.rpc.Status.code} of * 1, corresponding to `Code.CANCELLED`. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource to be cancelled. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the * details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. * @return {Promise} - The promise which resolves when API call finishes. * The promise has a method named "cancel" which cancels the ongoing API * call. * * @example * ``` * const client = longrunning.operationsClient(); * await client.cancelOperation({name: ''}); * ``` */ cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * 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`. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource to be deleted. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} * for the details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. * @return {Promise} - The promise which resolves when API call finishes. * The promise has a method named "cancel" which cancels the ongoing API * call. * * @example * ``` * const client = longrunning.operationsClient(); * await client.deleteOperation({name: ''}); * ``` */ deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * Return a fully-qualified annotation resource name string. * * @param {string} project * @param {string} location * @param {string} dataset * @param {string} data_item * @param {string} annotation * @returns {string} Resource name string. */ annotationPath(project: string, location: string, dataset: string, dataItem: string, annotation: string): string; /** * Parse the project from Annotation resource. * * @param {string} annotationName * A fully-qualified path representing Annotation resource. * @returns {string} A string representing the project. */ matchProjectFromAnnotationName(annotationName: string): string | number; /** * Parse the location from Annotation resource. * * @param {string} annotationName * A fully-qualified path representing Annotation resource. * @returns {string} A string representing the location. */ matchLocationFromAnnotationName(annotationName: string): string | number; /** * Parse the dataset from Annotation resource. * * @param {string} annotationName * A fully-qualified path representing Annotation resource. * @returns {string} A string representing the dataset. */ matchDatasetFromAnnotationName(annotationName: string): string | number; /** * Parse the data_item from Annotation resource. * * @param {string} annotationName * A fully-qualified path representing Annotation resource. * @returns {string} A string representing the data_item. */ matchDataItemFromAnnotationName(annotationName: string): string | number; /** * Parse the annotation from Annotation resource. * * @param {string} annotationName * A fully-qualified path representing Annotation resource. * @returns {string} A string representing the annotation. */ matchAnnotationFromAnnotationName(annotationName: string): string | number; /** * Return a fully-qualified annotationSpec resource name string. * * @param {string} project * @param {string} location * @param {string} dataset * @param {string} annotation_spec * @returns {string} Resource name string. */ annotationSpecPath(project: string, location: string, dataset: string, annotationSpec: string): string; /** * Parse the project from AnnotationSpec resource. * * @param {string} annotationSpecName * A fully-qualified path representing AnnotationSpec resource. * @returns {string} A string representing the project. */ matchProjectFromAnnotationSpecName(annotationSpecName: string): string | number; /** * Parse the location from AnnotationSpec resource. * * @param {string} annotationSpecName * A fully-qualified path representing AnnotationSpec resource. * @returns {string} A string representing the location. */ matchLocationFromAnnotationSpecName(annotationSpecName: string): string | number; /** * Parse the dataset from AnnotationSpec resource. * * @param {string} annotationSpecName * A fully-qualified path representing AnnotationSpec resource. * @returns {string} A string representing the dataset. */ matchDatasetFromAnnotationSpecName(annotationSpecName: string): string | number; /** * Parse the annotation_spec from AnnotationSpec resource. * * @param {string} annotationSpecName * A fully-qualified path representing AnnotationSpec resource. * @returns {string} A string representing the annotation_spec. */ matchAnnotationSpecFromAnnotationSpecName(annotationSpecName: string): string | number; /** * Return a fully-qualified artifact resource name string. * * @param {string} project * @param {string} location * @param {string} metadata_store * @param {string} artifact * @returns {string} Resource name string. */ artifactPath(project: string, location: string, metadataStore: string, artifact: string): string; /** * Parse the project from Artifact resource. * * @param {string} artifactName * A fully-qualified path representing Artifact resource. * @returns {string} A string representing the project. */ matchProjectFromArtifactName(artifactName: string): string | number; /** * Parse the location from Artifact resource. * * @param {string} artifactName * A fully-qualified path representing Artifact resource. * @returns {string} A string representing the location. */ matchLocationFromArtifactName(artifactName: string): string | number; /** * Parse the metadata_store from Artifact resource. * * @param {string} artifactName * A fully-qualified path representing Artifact resource. * @returns {string} A string representing the metadata_store. */ matchMetadataStoreFromArtifactName(artifactName: string): string | number; /** * Parse the artifact from Artifact resource. * * @param {string} artifactName * A fully-qualified path representing Artifact resource. * @returns {string} A string representing the artifact. */ matchArtifactFromArtifactName(artifactName: string): string | number; /** * Return a fully-qualified batchPredictionJob resource name string. * * @param {string} project * @param {string} location * @param {string} batch_prediction_job * @returns {string} Resource name string. */ batchPredictionJobPath(project: string, location: string, batchPredictionJob: string): string; /** * Parse the project from BatchPredictionJob resource. * * @param {string} batchPredictionJobName * A fully-qualified path representing BatchPredictionJob resource. * @returns {string} A string representing the project. */ matchProjectFromBatchPredictionJobName(batchPredictionJobName: string): string | number; /** * Parse the location from BatchPredictionJob resource. * * @param {string} batchPredictionJobName * A fully-qualified path representing BatchPredictionJob resource. * @returns {string} A string representing the location. */ matchLocationFromBatchPredictionJobName(batchPredictionJobName: string): string | number; /** * Parse the batch_prediction_job from BatchPredictionJob resource. * * @param {string} batchPredictionJobName * A fully-qualified path representing BatchPredictionJob resource. * @returns {string} A string representing the batch_prediction_job. */ matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName: string): string | number; /** * Return a fully-qualified context resource name string. * * @param {string} project * @param {string} location * @param {string} metadata_store * @param {string} context * @returns {string} Resource name string. */ contextPath(project: string, location: string, metadataStore: string, context: string): string; /** * Parse the project from Context resource. * * @param {string} contextName * A fully-qualified path representing Context resource. * @returns {string} A string representing the project. */ matchProjectFromContextName(contextName: string): string | number; /** * Parse the location from Context resource. * * @param {string} contextName * A fully-qualified path representing Context resource. * @returns {string} A string representing the location. */ matchLocationFromContextName(contextName: string): string | number; /** * Parse the metadata_store from Context resource. * * @param {string} contextName * A fully-qualified path representing Context resource. * @returns {string} A string representing the metadata_store. */ matchMetadataStoreFromContextName(contextName: string): string | number; /** * Parse the context from Context resource. * * @param {string} contextName * A fully-qualified path representing Context resource. * @returns {string} A string representing the context. */ matchContextFromContextName(contextName: string): string | number; /** * Return a fully-qualified customJob resource name string. * * @param {string} project * @param {string} location * @param {string} custom_job * @returns {string} Resource name string. */ customJobPath(project: string, location: string, customJob: string): string; /** * Parse the project from CustomJob resource. * * @param {string} customJobName * A fully-qualified path representing CustomJob resource. * @returns {string} A string representing the project. */ matchProjectFromCustomJobName(customJobName: string): string | number; /** * Parse the location from CustomJob resource. * * @param {string} customJobName * A fully-qualified path representing CustomJob resource. * @returns {string} A string representing the location. */ matchLocationFromCustomJobName(customJobName: string): string | number; /** * Parse the custom_job from CustomJob resource. * * @param {string} customJobName * A fully-qualified path representing CustomJob resource. * @returns {string} A string representing the custom_job. */ matchCustomJobFromCustomJobName(customJobName: string): string | number; /** * Return a fully-qualified dataItem resource name string. * * @param {string} project * @param {string} location * @param {string} dataset * @param {string} data_item * @returns {string} Resource name string. */ dataItemPath(project: string, location: string, dataset: string, dataItem: string): string; /** * Parse the project from DataItem resource. * * @param {string} dataItemName * A fully-qualified path representing DataItem resource. * @returns {string} A string representing the project. */ matchProjectFromDataItemName(dataItemName: string): string | number; /** * Parse the location from DataItem resource. * * @param {string} dataItemName * A fully-qualified path representing DataItem resource. * @returns {string} A string representing the location. */ matchLocationFromDataItemName(dataItemName: string): string | number; /** * Parse the dataset from DataItem resource. * * @param {string} dataItemName * A fully-qualified path representing DataItem resource. * @returns {string} A string representing the dataset. */ matchDatasetFromDataItemName(dataItemName: string): string | number; /** * Parse the data_item from DataItem resource. * * @param {string} dataItemName * A fully-qualified path representing DataItem resource. * @returns {string} A string representing the data_item. */ matchDataItemFromDataItemName(dataItemName: string): string | number; /** * Return a fully-qualified dataLabelingJob resource name string. * * @param {string} project * @param {string} location * @param {string} data_labeling_job * @returns {string} Resource name string. */ dataLabelingJobPath(project: string, location: string, dataLabelingJob: string): string; /** * Parse the project from DataLabelingJob resource. * * @param {string} dataLabelingJobName * A fully-qualified path representing DataLabelingJob resource. * @returns {string} A string representing the project. */ matchProjectFromDataLabelingJobName(dataLabelingJobName: string): string | number; /** * Parse the location from DataLabelingJob resource. * * @param {string} dataLabelingJobName * A fully-qualified path representing DataLabelingJob resource. * @returns {string} A string representing the location. */ matchLocationFromDataLabelingJobName(dataLabelingJobName: string): string | number; /** * Parse the data_labeling_job from DataLabelingJob resource. * * @param {string} dataLabelingJobName * A fully-qualified path representing DataLabelingJob resource. * @returns {string} A string representing the data_labeling_job. */ matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName: string): string | number; /** * Return a fully-qualified dataset resource name string. * * @param {string} project * @param {string} location * @param {string} dataset * @returns {string} Resource name string. */ datasetPath(project: string, location: string, dataset: string): string; /** * Parse the project from Dataset resource. * * @param {string} datasetName * A fully-qualified path representing Dataset resource. * @returns {string} A string representing the project. */ matchProjectFromDatasetName(datasetName: string): string | number; /** * Parse the location from Dataset resource. * * @param {string} datasetName * A fully-qualified path representing Dataset resource. * @returns {string} A string representing the location. */ matchLocationFromDatasetName(datasetName: string): string | number; /** * Parse the dataset from Dataset resource. * * @param {string} datasetName * A fully-qualified path representing Dataset resource. * @returns {string} A string representing the dataset. */ matchDatasetFromDatasetName(datasetName: string): string | number; /** * Return a fully-qualified datasetVersion resource name string. * * @param {string} project * @param {string} location * @param {string} dataset * @param {string} dataset_version * @returns {string} Resource name string. */ datasetVersionPath(project: string, location: string, dataset: string, datasetVersion: string): string; /** * Parse the project from DatasetVersion resource. * * @param {string} datasetVersionName * A fully-qualified path representing DatasetVersion resource. * @returns {string} A string representing the project. */ matchProjectFromDatasetVersionName(datasetVersionName: string): string | number; /** * Parse the location from DatasetVersion resource. * * @param {string} datasetVersionName * A fully-qualified path representing DatasetVersion resource. * @returns {string} A string representing the location. */ matchLocationFromDatasetVersionName(datasetVersionName: string): string | number; /** * Parse the dataset from DatasetVersion resource. * * @param {string} datasetVersionName * A fully-qualified path representing DatasetVersion resource. * @returns {string} A string representing the dataset. */ matchDatasetFromDatasetVersionName(datasetVersionName: string): string | number; /** * Parse the dataset_version from DatasetVersion resource. * * @param {string} datasetVersionName * A fully-qualified path representing DatasetVersion resource. * @returns {string} A string representing the dataset_version. */ matchDatasetVersionFromDatasetVersionName(datasetVersionName: string): string | number; /** * Return a fully-qualified deploymentResourcePool resource name string. * * @param {string} project * @param {string} location * @param {string} deployment_resource_pool * @returns {string} Resource name string. */ deploymentResourcePoolPath(project: string, location: string, deploymentResourcePool: string): string; /** * Parse the project from DeploymentResourcePool resource. * * @param {string} deploymentResourcePoolName * A fully-qualified path representing DeploymentResourcePool resource. * @returns {string} A string representing the project. */ matchProjectFromDeploymentResourcePoolName(deploymentResourcePoolName: string): string | number; /** * Parse the location from DeploymentResourcePool resource. * * @param {string} deploymentResourcePoolName * A fully-qualified path representing DeploymentResourcePool resource. * @returns {string} A string representing the location. */ matchLocationFromDeploymentResourcePoolName(deploymentResourcePoolName: string): string | number; /** * Parse the deployment_resource_pool from DeploymentResourcePool resource. * * @param {string} deploymentResourcePoolName * A fully-qualified path representing DeploymentResourcePool resource. * @returns {string} A string representing the deployment_resource_pool. */ matchDeploymentResourcePoolFromDeploymentResourcePoolName(deploymentResourcePoolName: string): string | number; /** * Return a fully-qualified entityType resource name string. * * @param {string} project * @param {string} location * @param {string} featurestore * @param {string} entity_type * @returns {string} Resource name string. */ entityTypePath(project: string, location: string, featurestore: string, entityType: string): string; /** * Parse the project from EntityType resource. * * @param {string} entityTypeName * A fully-qualified path representing EntityType resource. * @returns {string} A string representing the project. */ matchProjectFromEntityTypeName(entityTypeName: string): string | number; /** * Parse the location from EntityType resource. * * @param {string} entityTypeName * A fully-qualified path representing EntityType resource. * @returns {string} A string representing the location. */ matchLocationFromEntityTypeName(entityTypeName: string): string | number; /** * Parse the featurestore from EntityType resource. * * @param {string} entityTypeName * A fully-qualified path representing EntityType resource. * @returns {string} A string representing the featurestore. */ matchFeaturestoreFromEntityTypeName(entityTypeName: string): string | number; /** * Parse the entity_type from EntityType resource. * * @param {string} entityTypeName * A fully-qualified path representing EntityType resource. * @returns {string} A string representing the entity_type. */ matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number; /** * Return a fully-qualified execution resource name string. * * @param {string} project * @param {string} location * @param {string} metadata_store * @param {string} execution * @returns {string} Resource name string. */ executionPath(project: string, location: string, metadataStore: string, execution: string): string; /** * Parse the project from Execution resource. * * @param {string} executionName * A fully-qualified path representing Execution resource. * @returns {string} A string representing the project. */ matchProjectFromExecutionName(executionName: string): string | number; /** * Parse the location from Execution resource. * * @param {string} executionName * A fully-qualified path representing Execution resource. * @returns {string} A string representing the location. */ matchLocationFromExecutionName(executionName: string): string | number; /** * Parse the metadata_store from Execution resource. * * @param {string} executionName * A fully-qualified path representing Execution resource. * @returns {string} A string representing the metadata_store. */ matchMetadataStoreFromExecutionName(executionName: string): string | number; /** * Parse the execution from Execution resource. * * @param {string} executionName * A fully-qualified path representing Execution resource. * @returns {string} A string representing the execution. */ matchExecutionFromExecutionName(executionName: string): string | number; /** * Return a fully-qualified featureGroup resource name string. * * @param {string} project * @param {string} location * @param {string} feature_group * @returns {string} Resource name string. */ featureGroupPath(project: string, location: string, featureGroup: string): string; /** * Parse the project from FeatureGroup resource. * * @param {string} featureGroupName * A fully-qualified path representing FeatureGroup resource. * @returns {string} A string representing the project. */ matchProjectFromFeatureGroupName(featureGroupName: string): string | number; /** * Parse the location from FeatureGroup resource. * * @param {string} featureGroupName * A fully-qualified path representing FeatureGroup resource. * @returns {string} A string representing the location. */ matchLocationFromFeatureGroupName(featureGroupName: string): string | number; /** * Parse the feature_group from FeatureGroup resource. * * @param {string} featureGroupName * A fully-qualified path representing FeatureGroup resource. * @returns {string} A string representing the feature_group. */ matchFeatureGroupFromFeatureGroupName(featureGroupName: string): string | number; /** * Return a fully-qualified featureOnlineStore resource name string. * * @param {string} project * @param {string} location * @param {string} feature_online_store * @returns {string} Resource name string. */ featureOnlineStorePath(project: string, location: string, featureOnlineStore: string): string; /** * Parse the project from FeatureOnlineStore resource. * * @param {string} featureOnlineStoreName * A fully-qualified path representing FeatureOnlineStore resource. * @returns {string} A string representing the project. */ matchProjectFromFeatureOnlineStoreName(featureOnlineStoreName: string): string | number; /** * Parse the location from FeatureOnlineStore resource. * * @param {string} featureOnlineStoreName * A fully-qualified path representing FeatureOnlineStore resource. * @returns {string} A string representing the location. */ matchLocationFromFeatureOnlineStoreName(featureOnlineStoreName: string): string | number; /** * Parse the feature_online_store from FeatureOnlineStore resource. * * @param {string} featureOnlineStoreName * A fully-qualified path representing FeatureOnlineStore resource. * @returns {string} A string representing the feature_online_store. */ matchFeatureOnlineStoreFromFeatureOnlineStoreName(featureOnlineStoreName: string): string | number; /** * Return a fully-qualified featureView resource name string. * * @param {string} project * @param {string} location * @param {string} feature_online_store * @param {string} feature_view * @returns {string} Resource name string. */ featureViewPath(project: string, location: string, featureOnlineStore: string, featureView: string): string; /** * Parse the project from FeatureView resource. * * @param {string} featureViewName * A fully-qualified path representing FeatureView resource. * @returns {string} A string representing the project. */ matchProjectFromFeatureViewName(featureViewName: string): string | number; /** * Parse the location from FeatureView resource. * * @param {string} featureViewName * A fully-qualified path representing FeatureView resource. * @returns {string} A string representing the location. */ matchLocationFromFeatureViewName(featureViewName: string): string | number; /** * Parse the feature_online_store from FeatureView resource. * * @param {string} featureViewName * A fully-qualified path representing FeatureView resource. * @returns {string} A string representing the feature_online_store. */ matchFeatureOnlineStoreFromFeatureViewName(featureViewName: string): string | number; /** * Parse the feature_view from FeatureView resource. * * @param {string} featureViewName * A fully-qualified path representing FeatureView resource. * @returns {string} A string representing the feature_view. */ matchFeatureViewFromFeatureViewName(featureViewName: string): string | number; /** * Return a fully-qualified featureViewSync resource name string. * * @param {string} project * @param {string} location * @param {string} feature_online_store * @param {string} feature_view * @returns {string} Resource name string. */ featureViewSyncPath(project: string, location: string, featureOnlineStore: string, featureView: string): string; /** * Parse the project from FeatureViewSync resource. * * @param {string} featureViewSyncName * A fully-qualified path representing FeatureViewSync resource. * @returns {string} A string representing the project. */ matchProjectFromFeatureViewSyncName(featureViewSyncName: string): string | number; /** * Parse the location from FeatureViewSync resource. * * @param {string} featureViewSyncName * A fully-qualified path representing FeatureViewSync resource. * @returns {string} A string representing the location. */ matchLocationFromFeatureViewSyncName(featureViewSyncName: string): string | number; /** * Parse the feature_online_store from FeatureViewSync resource. * * @param {string} featureViewSyncName * A fully-qualified path representing FeatureViewSync resource. * @returns {string} A string representing the feature_online_store. */ matchFeatureOnlineStoreFromFeatureViewSyncName(featureViewSyncName: string): string | number; /** * Parse the feature_view from FeatureViewSync resource. * * @param {string} featureViewSyncName * A fully-qualified path representing FeatureViewSync resource. * @returns {string} A string representing the feature_view. */ matchFeatureViewFromFeatureViewSyncName(featureViewSyncName: string): string | number; /** * Return a fully-qualified featurestore resource name string. * * @param {string} project * @param {string} location * @param {string} featurestore * @returns {string} Resource name string. */ featurestorePath(project: string, location: string, featurestore: string): string; /** * Parse the project from Featurestore resource. * * @param {string} featurestoreName * A fully-qualified path representing Featurestore resource. * @returns {string} A string representing the project. */ matchProjectFromFeaturestoreName(featurestoreName: string): string | number; /** * Parse the location from Featurestore resource. * * @param {string} featurestoreName * A fully-qualified path representing Featurestore resource. * @returns {string} A string representing the location. */ matchLocationFromFeaturestoreName(featurestoreName: string): string | number; /** * Parse the featurestore from Featurestore resource. * * @param {string} featurestoreName * A fully-qualified path representing Featurestore resource. * @returns {string} A string representing the featurestore. */ matchFeaturestoreFromFeaturestoreName(featurestoreName: string): string | number; /** * Return a fully-qualified hyperparameterTuningJob resource name string. * * @param {string} project * @param {string} location * @param {string} hyperparameter_tuning_job * @returns {string} Resource name string. */ hyperparameterTuningJobPath(project: string, location: string, hyperparameterTuningJob: string): string; /** * Parse the project from HyperparameterTuningJob resource. * * @param {string} hyperparameterTuningJobName * A fully-qualified path representing HyperparameterTuningJob resource. * @returns {string} A string representing the project. */ matchProjectFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number; /** * Parse the location from HyperparameterTuningJob resource. * * @param {string} hyperparameterTuningJobName * A fully-qualified path representing HyperparameterTuningJob resource. * @returns {string} A string representing the location. */ matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number; /** * Parse the hyperparameter_tuning_job from HyperparameterTuningJob resource. * * @param {string} hyperparameterTuningJobName * A fully-qualified path representing HyperparameterTuningJob resource. * @returns {string} A string representing the hyperparameter_tuning_job. */ matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number; /** * Return a fully-qualified index resource name string. * * @param {string} project * @param {string} location * @param {string} index * @returns {string} Resource name string. */ indexPath(project: string, location: string, index: string): string; /** * Parse the project from Index resource. * * @param {string} indexName * A fully-qualified path representing Index resource. * @returns {string} A string representing the project. */ matchProjectFromIndexName(indexName: string): string | number; /** * Parse the location from Index resource. * * @param {string} indexName * A fully-qualified path representing Index resource. * @returns {string} A string representing the location. */ matchLocationFromIndexName(indexName: string): string | number; /** * Parse the index from Index resource. * * @param {string} indexName * A fully-qualified path representing Index resource. * @returns {string} A string representing the index. */ matchIndexFromIndexName(indexName: string): string | number; /** * Return a fully-qualified indexEndpoint resource name string. * * @param {string} project * @param {string} location * @param {string} index_endpoint * @returns {string} Resource name string. */ indexEndpointPath(project: string, location: string, indexEndpoint: string): string; /** * Parse the project from IndexEndpoint resource. * * @param {string} indexEndpointName * A fully-qualified path representing IndexEndpoint resource. * @returns {string} A string representing the project. */ matchProjectFromIndexEndpointName(indexEndpointName: string): string | number; /** * Parse the location from IndexEndpoint resource. * * @param {string} indexEndpointName * A fully-qualified path representing IndexEndpoint resource. * @returns {string} A string representing the location. */ matchLocationFromIndexEndpointName(indexEndpointName: string): string | number; /** * Parse the index_endpoint from IndexEndpoint resource. * * @param {string} indexEndpointName * A fully-qualified path representing IndexEndpoint resource. * @returns {string} A string representing the index_endpoint. */ matchIndexEndpointFromIndexEndpointName(indexEndpointName: string): string | number; /** * Return a fully-qualified location resource name string. * * @param {string} project * @param {string} location * @returns {string} Resource name string. */ locationPath(project: string, location: string): string; /** * Parse the project from Location resource. * * @param {string} locationName * A fully-qualified path representing Location resource. * @returns {string} A string representing the project. */ matchProjectFromLocationName(locationName: string): string | number; /** * Parse the location from Location resource. * * @param {string} locationName * A fully-qualified path representing Location resource. * @returns {string} A string representing the location. */ matchLocationFromLocationName(locationName: string): string | number; /** * Return a fully-qualified metadataSchema resource name string. * * @param {string} project * @param {string} location * @param {string} metadata_store * @param {string} metadata_schema * @returns {string} Resource name string. */ metadataSchemaPath(project: string, location: string, metadataStore: string, metadataSchema: string): string; /** * Parse the project from MetadataSchema resource. * * @param {string} metadataSchemaName * A fully-qualified path representing MetadataSchema resource. * @returns {string} A string representing the project. */ matchProjectFromMetadataSchemaName(metadataSchemaName: string): string | number; /** * Parse the location from MetadataSchema resource. * * @param {string} metadataSchemaName * A fully-qualified path representing MetadataSchema resource. * @returns {string} A string representing the location. */ matchLocationFromMetadataSchemaName(metadataSchemaName: string): string | number; /** * Parse the metadata_store from MetadataSchema resource. * * @param {string} metadataSchemaName * A fully-qualified path representing MetadataSchema resource. * @returns {string} A string representing the metadata_store. */ matchMetadataStoreFromMetadataSchemaName(metadataSchemaName: string): string | number; /** * Parse the metadata_schema from MetadataSchema resource. * * @param {string} metadataSchemaName * A fully-qualified path representing MetadataSchema resource. * @returns {string} A string representing the metadata_schema. */ matchMetadataSchemaFromMetadataSchemaName(metadataSchemaName: string): string | number; /** * Return a fully-qualified metadataStore resource name string. * * @param {string} project * @param {string} location * @param {string} metadata_store * @returns {string} Resource name string. */ metadataStorePath(project: string, location: string, metadataStore: string): string; /** * Parse the project from MetadataStore resource. * * @param {string} metadataStoreName * A fully-qualified path representing MetadataStore resource. * @returns {string} A string representing the project. */ matchProjectFromMetadataStoreName(metadataStoreName: string): string | number; /** * Parse the location from MetadataStore resource. * * @param {string} metadataStoreName * A fully-qualified path representing MetadataStore resource. * @returns {string} A string representing the location. */ matchLocationFromMetadataStoreName(metadataStoreName: string): string | number; /** * Parse the metadata_store from MetadataStore resource. * * @param {string} metadataStoreName * A fully-qualified path representing MetadataStore resource. * @returns {string} A string representing the metadata_store. */ matchMetadataStoreFromMetadataStoreName(metadataStoreName: string): string | number; /** * Return a fully-qualified model resource name string. * * @param {string} project * @param {string} location * @param {string} model * @returns {string} Resource name string. */ modelPath(project: string, location: string, model: string): string; /** * Parse the project from Model resource. * * @param {string} modelName * A fully-qualified path representing Model resource. * @returns {string} A string representing the project. */ matchProjectFromModelName(modelName: string): string | number; /** * Parse the location from Model resource. * * @param {string} modelName * A fully-qualified path representing Model resource. * @returns {string} A string representing the location. */ matchLocationFromModelName(modelName: string): string | number; /** * Parse the model from Model resource. * * @param {string} modelName * A fully-qualified path representing Model resource. * @returns {string} A string representing the model. */ matchModelFromModelName(modelName: string): string | number; /** * Return a fully-qualified modelDeploymentMonitoringJob resource name string. * * @param {string} project * @param {string} location * @param {string} model_deployment_monitoring_job * @returns {string} Resource name string. */ modelDeploymentMonitoringJobPath(project: string, location: string, modelDeploymentMonitoringJob: string): string; /** * Parse the project from ModelDeploymentMonitoringJob resource. * * @param {string} modelDeploymentMonitoringJobName * A fully-qualified path representing ModelDeploymentMonitoringJob resource. * @returns {string} A string representing the project. */ matchProjectFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number; /** * Parse the location from ModelDeploymentMonitoringJob resource. * * @param {string} modelDeploymentMonitoringJobName * A fully-qualified path representing ModelDeploymentMonitoringJob resource. * @returns {string} A string representing the location. */ matchLocationFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number; /** * Parse the model_deployment_monitoring_job from ModelDeploymentMonitoringJob resource. * * @param {string} modelDeploymentMonitoringJobName * A fully-qualified path representing ModelDeploymentMonitoringJob resource. * @returns {string} A string representing the model_deployment_monitoring_job. */ matchModelDeploymentMonitoringJobFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number; /** * Return a fully-qualified modelEvaluation resource name string. * * @param {string} project * @param {string} location * @param {string} model * @param {string} evaluation * @returns {string} Resource name string. */ modelEvaluationPath(project: string, location: string, model: string, evaluation: string): string; /** * Parse the project from ModelEvaluation resource. * * @param {string} modelEvaluationName * A fully-qualified path representing ModelEvaluation resource. * @returns {string} A string representing the project. */ matchProjectFromModelEvaluationName(modelEvaluationName: string): string | number; /** * Parse the location from ModelEvaluation resource. * * @param {string} modelEvaluationName * A fully-qualified path representing ModelEvaluation resource. * @returns {string} A string representing the location. */ matchLocationFromModelEvaluationName(modelEvaluationName: string): string | number; /** * Parse the model from ModelEvaluation resource. * * @param {string} modelEvaluationName * A fully-qualified path representing ModelEvaluation resource. * @returns {string} A string representing the model. */ matchModelFromModelEvaluationName(modelEvaluationName: string): string | number; /** * Parse the evaluation from ModelEvaluation resource. * * @param {string} modelEvaluationName * A fully-qualified path representing ModelEvaluation resource. * @returns {string} A string representing the evaluation. */ matchEvaluationFromModelEvaluationName(modelEvaluationName: string): string | number; /** * Return a fully-qualified modelEvaluationSlice resource name string. * * @param {string} project * @param {string} location * @param {string} model * @param {string} evaluation * @param {string} slice * @returns {string} Resource name string. */ modelEvaluationSlicePath(project: string, location: string, model: string, evaluation: string, slice: string): string; /** * Parse the project from ModelEvaluationSlice resource. * * @param {string} modelEvaluationSliceName * A fully-qualified path representing ModelEvaluationSlice resource. * @returns {string} A string representing the project. */ matchProjectFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number; /** * Parse the location from ModelEvaluationSlice resource. * * @param {string} modelEvaluationSliceName * A fully-qualified path representing ModelEvaluationSlice resource. * @returns {string} A string representing the location. */ matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number; /** * Parse the model from ModelEvaluationSlice resource. * * @param {string} modelEvaluationSliceName * A fully-qualified path representing ModelEvaluationSlice resource. * @returns {string} A string representing the model. */ matchModelFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number; /** * Parse the evaluation from ModelEvaluationSlice resource. * * @param {string} modelEvaluationSliceName * A fully-qualified path representing ModelEvaluationSlice resource. * @returns {string} A string representing the evaluation. */ matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number; /** * Parse the slice from ModelEvaluationSlice resource. * * @param {string} modelEvaluationSliceName * A fully-qualified path representing ModelEvaluationSlice resource. * @returns {string} A string representing the slice. */ matchSliceFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number; /** * Return a fully-qualified nasJob resource name string. * * @param {string} project * @param {string} location * @param {string} nas_job * @returns {string} Resource name string. */ nasJobPath(project: string, location: string, nasJob: string): string; /** * Parse the project from NasJob resource. * * @param {string} nasJobName * A fully-qualified path representing NasJob resource. * @returns {string} A string representing the project. */ matchProjectFromNasJobName(nasJobName: string): string | number; /** * Parse the location from NasJob resource. * * @param {string} nasJobName * A fully-qualified path representing NasJob resource. * @returns {string} A string representing the location. */ matchLocationFromNasJobName(nasJobName: string): string | number; /** * Parse the nas_job from NasJob resource. * * @param {string} nasJobName * A fully-qualified path representing NasJob resource. * @returns {string} A string representing the nas_job. */ matchNasJobFromNasJobName(nasJobName: string): string | number; /** * Return a fully-qualified nasTrialDetail resource name string. * * @param {string} project * @param {string} location * @param {string} nas_job * @param {string} nas_trial_detail * @returns {string} Resource name string. */ nasTrialDetailPath(project: string, location: string, nasJob: string, nasTrialDetail: string): string; /** * Parse the project from NasTrialDetail resource. * * @param {string} nasTrialDetailName * A fully-qualified path representing NasTrialDetail resource. * @returns {string} A string representing the project. */ matchProjectFromNasTrialDetailName(nasTrialDetailName: string): string | number; /** * Parse the location from NasTrialDetail resource. * * @param {string} nasTrialDetailName * A fully-qualified path representing NasTrialDetail resource. * @returns {string} A string representing the location. */ matchLocationFromNasTrialDetailName(nasTrialDetailName: string): string | number; /** * Parse the nas_job from NasTrialDetail resource. * * @param {string} nasTrialDetailName * A fully-qualified path representing NasTrialDetail resource. * @returns {string} A string representing the nas_job. */ matchNasJobFromNasTrialDetailName(nasTrialDetailName: string): string | number; /** * Parse the nas_trial_detail from NasTrialDetail resource. * * @param {string} nasTrialDetailName * A fully-qualified path representing NasTrialDetail resource. * @returns {string} A string representing the nas_trial_detail. */ matchNasTrialDetailFromNasTrialDetailName(nasTrialDetailName: string): string | number; /** * Return a fully-qualified notebookExecutionJob resource name string. * * @param {string} project * @param {string} location * @param {string} notebook_execution_job * @returns {string} Resource name string. */ notebookExecutionJobPath(project: string, location: string, notebookExecutionJob: string): string; /** * Parse the project from NotebookExecutionJob resource. * * @param {string} notebookExecutionJobName * A fully-qualified path representing NotebookExecutionJob resource. * @returns {string} A string representing the project. */ matchProjectFromNotebookExecutionJobName(notebookExecutionJobName: string): string | number; /** * Parse the location from NotebookExecutionJob resource. * * @param {string} notebookExecutionJobName * A fully-qualified path representing NotebookExecutionJob resource. * @returns {string} A string representing the location. */ matchLocationFromNotebookExecutionJobName(notebookExecutionJobName: string): string | number; /** * Parse the notebook_execution_job from NotebookExecutionJob resource. * * @param {string} notebookExecutionJobName * A fully-qualified path representing NotebookExecutionJob resource. * @returns {string} A string representing the notebook_execution_job. */ matchNotebookExecutionJobFromNotebookExecutionJobName(notebookExecutionJobName: string): string | number; /** * Return a fully-qualified notebookRuntime resource name string. * * @param {string} project * @param {string} location * @param {string} notebook_runtime * @returns {string} Resource name string. */ notebookRuntimePath(project: string, location: string, notebookRuntime: string): string; /** * Parse the project from NotebookRuntime resource. * * @param {string} notebookRuntimeName * A fully-qualified path representing NotebookRuntime resource. * @returns {string} A string representing the project. */ matchProjectFromNotebookRuntimeName(notebookRuntimeName: string): string | number; /** * Parse the location from NotebookRuntime resource. * * @param {string} notebookRuntimeName * A fully-qualified path representing NotebookRuntime resource. * @returns {string} A string representing the location. */ matchLocationFromNotebookRuntimeName(notebookRuntimeName: string): string | number; /** * Parse the notebook_runtime from NotebookRuntime resource. * * @param {string} notebookRuntimeName * A fully-qualified path representing NotebookRuntime resource. * @returns {string} A string representing the notebook_runtime. */ matchNotebookRuntimeFromNotebookRuntimeName(notebookRuntimeName: string): string | number; /** * Return a fully-qualified notebookRuntimeTemplate resource name string. * * @param {string} project * @param {string} location * @param {string} notebook_runtime_template * @returns {string} Resource name string. */ notebookRuntimeTemplatePath(project: string, location: string, notebookRuntimeTemplate: string): string; /** * Parse the project from NotebookRuntimeTemplate resource. * * @param {string} notebookRuntimeTemplateName * A fully-qualified path representing NotebookRuntimeTemplate resource. * @returns {string} A string representing the project. */ matchProjectFromNotebookRuntimeTemplateName(notebookRuntimeTemplateName: string): string | number; /** * Parse the location from NotebookRuntimeTemplate resource. * * @param {string} notebookRuntimeTemplateName * A fully-qualified path representing NotebookRuntimeTemplate resource. * @returns {string} A string representing the location. */ matchLocationFromNotebookRuntimeTemplateName(notebookRuntimeTemplateName: string): string | number; /** * Parse the notebook_runtime_template from NotebookRuntimeTemplate resource. * * @param {string} notebookRuntimeTemplateName * A fully-qualified path representing NotebookRuntimeTemplate resource. * @returns {string} A string representing the notebook_runtime_template. */ matchNotebookRuntimeTemplateFromNotebookRuntimeTemplateName(notebookRuntimeTemplateName: string): string | number; /** * Return a fully-qualified persistentResource resource name string. * * @param {string} project * @param {string} location * @param {string} persistent_resource * @returns {string} Resource name string. */ persistentResourcePath(project: string, location: string, persistentResource: string): string; /** * Parse the project from PersistentResource resource. * * @param {string} persistentResourceName * A fully-qualified path representing PersistentResource resource. * @returns {string} A string representing the project. */ matchProjectFromPersistentResourceName(persistentResourceName: string): string | number; /** * Parse the location from PersistentResource resource. * * @param {string} persistentResourceName * A fully-qualified path representing PersistentResource resource. * @returns {string} A string representing the location. */ matchLocationFromPersistentResourceName(persistentResourceName: string): string | number; /** * Parse the persistent_resource from PersistentResource resource. * * @param {string} persistentResourceName * A fully-qualified path representing PersistentResource resource. * @returns {string} A string representing the persistent_resource. */ matchPersistentResourceFromPersistentResourceName(persistentResourceName: string): string | number; /** * Return a fully-qualified pipelineJob resource name string. * * @param {string} project * @param {string} location * @param {string} pipeline_job * @returns {string} Resource name string. */ pipelineJobPath(project: string, location: string, pipelineJob: string): string; /** * Parse the project from PipelineJob resource. * * @param {string} pipelineJobName * A fully-qualified path representing PipelineJob resource. * @returns {string} A string representing the project. */ matchProjectFromPipelineJobName(pipelineJobName: string): string | number; /** * Parse the location from PipelineJob resource. * * @param {string} pipelineJobName * A fully-qualified path representing PipelineJob resource. * @returns {string} A string representing the location. */ matchLocationFromPipelineJobName(pipelineJobName: string): string | number; /** * Parse the pipeline_job from PipelineJob resource. * * @param {string} pipelineJobName * A fully-qualified path representing PipelineJob resource. * @returns {string} A string representing the pipeline_job. */ matchPipelineJobFromPipelineJobName(pipelineJobName: string): string | number; /** * Return a fully-qualified projectLocationEndpoint resource name string. * * @param {string} project * @param {string} location * @param {string} endpoint * @returns {string} Resource name string. */ projectLocationEndpointPath(project: string, location: string, endpoint: string): string; /** * Parse the project from ProjectLocationEndpoint resource. * * @param {string} projectLocationEndpointName * A fully-qualified path representing project_location_endpoint resource. * @returns {string} A string representing the project. */ matchProjectFromProjectLocationEndpointName(projectLocationEndpointName: string): string | number; /** * Parse the location from ProjectLocationEndpoint resource. * * @param {string} projectLocationEndpointName * A fully-qualified path representing project_location_endpoint resource. * @returns {string} A string representing the location. */ matchLocationFromProjectLocationEndpointName(projectLocationEndpointName: string): string | number; /** * Parse the endpoint from ProjectLocationEndpoint resource. * * @param {string} projectLocationEndpointName * A fully-qualified path representing project_location_endpoint resource. * @returns {string} A string representing the endpoint. */ matchEndpointFromProjectLocationEndpointName(projectLocationEndpointName: string): string | number; /** * Return a fully-qualified projectLocationFeatureGroupFeature resource name string. * * @param {string} project * @param {string} location * @param {string} feature_group * @param {string} feature * @returns {string} Resource name string. */ projectLocationFeatureGroupFeaturePath(project: string, location: string, featureGroup: string, feature: string): string; /** * Parse the project from ProjectLocationFeatureGroupFeature resource. * * @param {string} projectLocationFeatureGroupFeatureName * A fully-qualified path representing project_location_feature_group_feature resource. * @returns {string} A string representing the project. */ matchProjectFromProjectLocationFeatureGroupFeatureName(projectLocationFeatureGroupFeatureName: string): string | number; /** * Parse the location from ProjectLocationFeatureGroupFeature resource. * * @param {string} projectLocationFeatureGroupFeatureName * A fully-qualified path representing project_location_feature_group_feature resource. * @returns {string} A string representing the location. */ matchLocationFromProjectLocationFeatureGroupFeatureName(projectLocationFeatureGroupFeatureName: string): string | number; /** * Parse the feature_group from ProjectLocationFeatureGroupFeature resource. * * @param {string} projectLocationFeatureGroupFeatureName * A fully-qualified path representing project_location_feature_group_feature resource. * @returns {string} A string representing the feature_group. */ matchFeatureGroupFromProjectLocationFeatureGroupFeatureName(projectLocationFeatureGroupFeatureName: string): string | number; /** * Parse the feature from ProjectLocationFeatureGroupFeature resource. * * @param {string} projectLocationFeatureGroupFeatureName * A fully-qualified path representing project_location_feature_group_feature resource. * @returns {string} A string representing the feature. */ matchFeatureFromProjectLocationFeatureGroupFeatureName(projectLocationFeatureGroupFeatureName: string): string | number; /** * Return a fully-qualified projectLocationFeaturestoreEntityTypeFeature resource name string. * * @param {string} project * @param {string} location * @param {string} featurestore * @param {string} entity_type * @param {string} feature * @returns {string} Resource name string. */ projectLocationFeaturestoreEntityTypeFeaturePath(project: string, location: string, featurestore: string, entityType: string, feature: string): string; /** * Parse the project from ProjectLocationFeaturestoreEntityTypeFeature resource. * * @param {string} projectLocationFeaturestoreEntityTypeFeatureName * A fully-qualified path representing project_location_featurestore_entity_type_feature resource. * @returns {string} A string representing the project. */ matchProjectFromProjectLocationFeaturestoreEntityTypeFeatureName(projectLocationFeaturestoreEntityTypeFeatureName: string): string | number; /** * Parse the location from ProjectLocationFeaturestoreEntityTypeFeature resource. * * @param {string} projectLocationFeaturestoreEntityTypeFeatureName * A fully-qualified path representing project_location_featurestore_entity_type_feature resource. * @returns {string} A string representing the location. */ matchLocationFromProjectLocationFeaturestoreEntityTypeFeatureName(projectLocationFeaturestoreEntityTypeFeatureName: string): string | number; /** * Parse the featurestore from ProjectLocationFeaturestoreEntityTypeFeature resource. * * @param {string} projectLocationFeaturestoreEntityTypeFeatureName * A fully-qualified path representing project_location_featurestore_entity_type_feature resource. * @returns {string} A string representing the featurestore. */ matchFeaturestoreFromProjectLocationFeaturestoreEntityTypeFeatureName(projectLocationFeaturestoreEntityTypeFeatureName: string): string | number; /** * Parse the entity_type from ProjectLocationFeaturestoreEntityTypeFeature resource. * * @param {string} projectLocationFeaturestoreEntityTypeFeatureName * A fully-qualified path representing project_location_featurestore_entity_type_feature resource. * @returns {string} A string representing the entity_type. */ matchEntityTypeFromProjectLocationFeaturestoreEntityTypeFeatureName(projectLocationFeaturestoreEntityTypeFeatureName: string): string | number; /** * Parse the feature from ProjectLocationFeaturestoreEntityTypeFeature resource. * * @param {string} projectLocationFeaturestoreEntityTypeFeatureName * A fully-qualified path representing project_location_featurestore_entity_type_feature resource. * @returns {string} A string representing the feature. */ matchFeatureFromProjectLocationFeaturestoreEntityTypeFeatureName(projectLocationFeaturestoreEntityTypeFeatureName: string): string | number; /** * Return a fully-qualified projectLocationPublisherModel resource name string. * * @param {string} project * @param {string} location * @param {string} publisher * @param {string} model * @returns {string} Resource name string. */ projectLocationPublisherModelPath(project: string, location: string, publisher: string, model: string): string; /** * Parse the project from ProjectLocationPublisherModel resource. * * @param {string} projectLocationPublisherModelName * A fully-qualified path representing project_location_publisher_model resource. * @returns {string} A string representing the project. */ matchProjectFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number; /** * Parse the location from ProjectLocationPublisherModel resource. * * @param {string} projectLocationPublisherModelName * A fully-qualified path representing project_location_publisher_model resource. * @returns {string} A string representing the location. */ matchLocationFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number; /** * Parse the publisher from ProjectLocationPublisherModel resource. * * @param {string} projectLocationPublisherModelName * A fully-qualified path representing project_location_publisher_model resource. * @returns {string} A string representing the publisher. */ matchPublisherFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number; /** * Parse the model from ProjectLocationPublisherModel resource. * * @param {string} projectLocationPublisherModelName * A fully-qualified path representing project_location_publisher_model resource. * @returns {string} A string representing the model. */ matchModelFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number; /** * Return a fully-qualified publisherModel resource name string. * * @param {string} publisher * @param {string} model * @returns {string} Resource name string. */ publisherModelPath(publisher: string, model: string): string; /** * Parse the publisher from PublisherModel resource. * * @param {string} publisherModelName * A fully-qualified path representing PublisherModel resource. * @returns {string} A string representing the publisher. */ matchPublisherFromPublisherModelName(publisherModelName: string): string | number; /** * Parse the model from PublisherModel resource. * * @param {string} publisherModelName * A fully-qualified path representing PublisherModel resource. * @returns {string} A string representing the model. */ matchModelFromPublisherModelName(publisherModelName: string): string | number; /** * Return a fully-qualified savedQuery resource name string. * * @param {string} project * @param {string} location * @param {string} dataset * @param {string} saved_query * @returns {string} Resource name string. */ savedQueryPath(project: string, location: string, dataset: string, savedQuery: string): string; /** * Parse the project from SavedQuery resource. * * @param {string} savedQueryName * A fully-qualified path representing SavedQuery resource. * @returns {string} A string representing the project. */ matchProjectFromSavedQueryName(savedQueryName: string): string | number; /** * Parse the location from SavedQuery resource. * * @param {string} savedQueryName * A fully-qualified path representing SavedQuery resource. * @returns {string} A string representing the location. */ matchLocationFromSavedQueryName(savedQueryName: string): string | number; /** * Parse the dataset from SavedQuery resource. * * @param {string} savedQueryName * A fully-qualified path representing SavedQuery resource. * @returns {string} A string representing the dataset. */ matchDatasetFromSavedQueryName(savedQueryName: string): string | number; /** * Parse the saved_query from SavedQuery resource. * * @param {string} savedQueryName * A fully-qualified path representing SavedQuery resource. * @returns {string} A string representing the saved_query. */ matchSavedQueryFromSavedQueryName(savedQueryName: string): string | number; /** * Return a fully-qualified schedule resource name string. * * @param {string} project * @param {string} location * @param {string} schedule * @returns {string} Resource name string. */ schedulePath(project: string, location: string, schedule: string): string; /** * Parse the project from Schedule resource. * * @param {string} scheduleName * A fully-qualified path representing Schedule resource. * @returns {string} A string representing the project. */ matchProjectFromScheduleName(scheduleName: string): string | number; /** * Parse the location from Schedule resource. * * @param {string} scheduleName * A fully-qualified path representing Schedule resource. * @returns {string} A string representing the location. */ matchLocationFromScheduleName(scheduleName: string): string | number; /** * Parse the schedule from Schedule resource. * * @param {string} scheduleName * A fully-qualified path representing Schedule resource. * @returns {string} A string representing the schedule. */ matchScheduleFromScheduleName(scheduleName: string): string | number; /** * Return a fully-qualified specialistPool resource name string. * * @param {string} project * @param {string} location * @param {string} specialist_pool * @returns {string} Resource name string. */ specialistPoolPath(project: string, location: string, specialistPool: string): string; /** * Parse the project from SpecialistPool resource. * * @param {string} specialistPoolName * A fully-qualified path representing SpecialistPool resource. * @returns {string} A string representing the project. */ matchProjectFromSpecialistPoolName(specialistPoolName: string): string | number; /** * Parse the location from SpecialistPool resource. * * @param {string} specialistPoolName * A fully-qualified path representing SpecialistPool resource. * @returns {string} A string representing the location. */ matchLocationFromSpecialistPoolName(specialistPoolName: string): string | number; /** * Parse the specialist_pool from SpecialistPool resource. * * @param {string} specialistPoolName * A fully-qualified path representing SpecialistPool resource. * @returns {string} A string representing the specialist_pool. */ matchSpecialistPoolFromSpecialistPoolName(specialistPoolName: string): string | number; /** * Return a fully-qualified study resource name string. * * @param {string} project * @param {string} location * @param {string} study * @returns {string} Resource name string. */ studyPath(project: string, location: string, study: string): string; /** * Parse the project from Study resource. * * @param {string} studyName * A fully-qualified path representing Study resource. * @returns {string} A string representing the project. */ matchProjectFromStudyName(studyName: string): string | number; /** * Parse the location from Study resource. * * @param {string} studyName * A fully-qualified path representing Study resource. * @returns {string} A string representing the location. */ matchLocationFromStudyName(studyName: string): string | number; /** * Parse the study from Study resource. * * @param {string} studyName * A fully-qualified path representing Study resource. * @returns {string} A string representing the study. */ matchStudyFromStudyName(studyName: string): string | number; /** * Return a fully-qualified tensorboard resource name string. * * @param {string} project * @param {string} location * @param {string} tensorboard * @returns {string} Resource name string. */ tensorboardPath(project: string, location: string, tensorboard: string): string; /** * Parse the project from Tensorboard resource. * * @param {string} tensorboardName * A fully-qualified path representing Tensorboard resource. * @returns {string} A string representing the project. */ matchProjectFromTensorboardName(tensorboardName: string): string | number; /** * Parse the location from Tensorboard resource. * * @param {string} tensorboardName * A fully-qualified path representing Tensorboard resource. * @returns {string} A string representing the location. */ matchLocationFromTensorboardName(tensorboardName: string): string | number; /** * Parse the tensorboard from Tensorboard resource. * * @param {string} tensorboardName * A fully-qualified path representing Tensorboard resource. * @returns {string} A string representing the tensorboard. */ matchTensorboardFromTensorboardName(tensorboardName: string): string | number; /** * Return a fully-qualified tensorboardExperiment resource name string. * * @param {string} project * @param {string} location * @param {string} tensorboard * @param {string} experiment * @returns {string} Resource name string. */ tensorboardExperimentPath(project: string, location: string, tensorboard: string, experiment: string): string; /** * Parse the project from TensorboardExperiment resource. * * @param {string} tensorboardExperimentName * A fully-qualified path representing TensorboardExperiment resource. * @returns {string} A string representing the project. */ matchProjectFromTensorboardExperimentName(tensorboardExperimentName: string): string | number; /** * Parse the location from TensorboardExperiment resource. * * @param {string} tensorboardExperimentName * A fully-qualified path representing TensorboardExperiment resource. * @returns {string} A string representing the location. */ matchLocationFromTensorboardExperimentName(tensorboardExperimentName: string): string | number; /** * Parse the tensorboard from TensorboardExperiment resource. * * @param {string} tensorboardExperimentName * A fully-qualified path representing TensorboardExperiment resource. * @returns {string} A string representing the tensorboard. */ matchTensorboardFromTensorboardExperimentName(tensorboardExperimentName: string): string | number; /** * Parse the experiment from TensorboardExperiment resource. * * @param {string} tensorboardExperimentName * A fully-qualified path representing TensorboardExperiment resource. * @returns {string} A string representing the experiment. */ matchExperimentFromTensorboardExperimentName(tensorboardExperimentName: string): string | number; /** * Return a fully-qualified tensorboardRun resource name string. * * @param {string} project * @param {string} location * @param {string} tensorboard * @param {string} experiment * @param {string} run * @returns {string} Resource name string. */ tensorboardRunPath(project: string, location: string, tensorboard: string, experiment: string, run: string): string; /** * Parse the project from TensorboardRun resource. * * @param {string} tensorboardRunName * A fully-qualified path representing TensorboardRun resource. * @returns {string} A string representing the project. */ matchProjectFromTensorboardRunName(tensorboardRunName: string): string | number; /** * Parse the location from TensorboardRun resource. * * @param {string} tensorboardRunName * A fully-qualified path representing TensorboardRun resource. * @returns {string} A string representing the location. */ matchLocationFromTensorboardRunName(tensorboardRunName: string): string | number; /** * Parse the tensorboard from TensorboardRun resource. * * @param {string} tensorboardRunName * A fully-qualified path representing TensorboardRun resource. * @returns {string} A string representing the tensorboard. */ matchTensorboardFromTensorboardRunName(tensorboardRunName: string): string | number; /** * Parse the experiment from TensorboardRun resource. * * @param {string} tensorboardRunName * A fully-qualified path representing TensorboardRun resource. * @returns {string} A string representing the experiment. */ matchExperimentFromTensorboardRunName(tensorboardRunName: string): string | number; /** * Parse the run from TensorboardRun resource. * * @param {string} tensorboardRunName * A fully-qualified path representing TensorboardRun resource. * @returns {string} A string representing the run. */ matchRunFromTensorboardRunName(tensorboardRunName: string): string | number; /** * Return a fully-qualified tensorboardTimeSeries resource name string. * * @param {string} project * @param {string} location * @param {string} tensorboard * @param {string} experiment * @param {string} run * @param {string} time_series * @returns {string} Resource name string. */ tensorboardTimeSeriesPath(project: string, location: string, tensorboard: string, experiment: string, run: string, timeSeries: string): string; /** * Parse the project from TensorboardTimeSeries resource. * * @param {string} tensorboardTimeSeriesName * A fully-qualified path representing TensorboardTimeSeries resource. * @returns {string} A string representing the project. */ matchProjectFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number; /** * Parse the location from TensorboardTimeSeries resource. * * @param {string} tensorboardTimeSeriesName * A fully-qualified path representing TensorboardTimeSeries resource. * @returns {string} A string representing the location. */ matchLocationFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number; /** * Parse the tensorboard from TensorboardTimeSeries resource. * * @param {string} tensorboardTimeSeriesName * A fully-qualified path representing TensorboardTimeSeries resource. * @returns {string} A string representing the tensorboard. */ matchTensorboardFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number; /** * Parse the experiment from TensorboardTimeSeries resource. * * @param {string} tensorboardTimeSeriesName * A fully-qualified path representing TensorboardTimeSeries resource. * @returns {string} A string representing the experiment. */ matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number; /** * Parse the run from TensorboardTimeSeries resource. * * @param {string} tensorboardTimeSeriesName * A fully-qualified path representing TensorboardTimeSeries resource. * @returns {string} A string representing the run. */ matchRunFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number; /** * Parse the time_series from TensorboardTimeSeries resource. * * @param {string} tensorboardTimeSeriesName * A fully-qualified path representing TensorboardTimeSeries resource. * @returns {string} A string representing the time_series. */ matchTimeSeriesFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number; /** * Return a fully-qualified trainingPipeline resource name string. * * @param {string} project * @param {string} location * @param {string} training_pipeline * @returns {string} Resource name string. */ trainingPipelinePath(project: string, location: string, trainingPipeline: string): string; /** * Parse the project from TrainingPipeline resource. * * @param {string} trainingPipelineName * A fully-qualified path representing TrainingPipeline resource. * @returns {string} A string representing the project. */ matchProjectFromTrainingPipelineName(trainingPipelineName: string): string | number; /** * Parse the location from TrainingPipeline resource. * * @param {string} trainingPipelineName * A fully-qualified path representing TrainingPipeline resource. * @returns {string} A string representing the location. */ matchLocationFromTrainingPipelineName(trainingPipelineName: string): string | number; /** * Parse the training_pipeline from TrainingPipeline resource. * * @param {string} trainingPipelineName * A fully-qualified path representing TrainingPipeline resource. * @returns {string} A string representing the training_pipeline. */ matchTrainingPipelineFromTrainingPipelineName(trainingPipelineName: string): string | number; /** * Return a fully-qualified trial resource name string. * * @param {string} project * @param {string} location * @param {string} study * @param {string} trial * @returns {string} Resource name string. */ trialPath(project: string, location: string, study: string, trial: string): string; /** * Parse the project from Trial resource. * * @param {string} trialName * A fully-qualified path representing Trial resource. * @returns {string} A string representing the project. */ matchProjectFromTrialName(trialName: string): string | number; /** * Parse the location from Trial resource. * * @param {string} trialName * A fully-qualified path representing Trial resource. * @returns {string} A string representing the location. */ matchLocationFromTrialName(trialName: string): string | number; /** * Parse the study from Trial resource. * * @param {string} trialName * A fully-qualified path representing Trial resource. * @returns {string} A string representing the study. */ matchStudyFromTrialName(trialName: string): string | number; /** * Parse the trial from Trial resource. * * @param {string} trialName * A fully-qualified path representing Trial resource. * @returns {string} A string representing the trial. */ matchTrialFromTrialName(trialName: string): string | number; /** * Return a fully-qualified tuningJob resource name string. * * @param {string} project * @param {string} location * @param {string} tuning_job * @returns {string} Resource name string. */ tuningJobPath(project: string, location: string, tuningJob: string): string; /** * Parse the project from TuningJob resource. * * @param {string} tuningJobName * A fully-qualified path representing TuningJob resource. * @returns {string} A string representing the project. */ matchProjectFromTuningJobName(tuningJobName: string): string | number; /** * Parse the location from TuningJob resource. * * @param {string} tuningJobName * A fully-qualified path representing TuningJob resource. * @returns {string} A string representing the location. */ matchLocationFromTuningJobName(tuningJobName: string): string | number; /** * Parse the tuning_job from TuningJob resource. * * @param {string} tuningJobName * A fully-qualified path representing TuningJob resource. * @returns {string} A string representing the tuning_job. */ matchTuningJobFromTuningJobName(tuningJobName: string): string | number; /** * Terminate the gRPC channel and close the client. * * The client will no longer be usable and all future behavior is undefined. * @returns {Promise} A promise that resolves when the client is closed. */ close(): Promise; }