A service for creating and managing Vertex AI's jobs. v1beta1
Package
@google-cloud/aiplatform
Constructors
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of JobServiceClient.
| Parameters |
| Name |
Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new JobServiceClient({fallback: true}, gax); ```
|
Properties
get apiEndpoint(): string;
The DNS address for this API service.
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
descriptors: Descriptors;
innerApiCalls: {
[name: string]: Function;
};
jobServiceStub?: Promise<{
[name: string]: Function;
}>;
locationsClient: LocationsClient;
operationsClient: gax.OperationsClient;
pathTemplates: {
[name: string]: gax.PathTemplate;
};
static get port(): number;
The port for this API service.
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
static get servicePath(): string;
The DNS address for this API service.
universeDomain
get universeDomain(): string;
warn: (code: string, message: string, warnType?: string) => void;
Methods
annotationPath(project: string, location: string, dataset: string, dataItem: string, annotation: string): string;
Return a fully-qualified annotation resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
dataset |
string
|
dataItem |
string
|
annotation |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
annotationSpecPath(project: string, location: string, dataset: string, annotationSpec: string): string;
Return a fully-qualified annotationSpec resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
dataset |
string
|
annotationSpec |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
artifactPath(project: string, location: string, metadataStore: string, artifact: string): string;
Return a fully-qualified artifact resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
metadataStore |
string
|
artifact |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
batchPredictionJobPath(project: string, location: string, batchPredictionJob: string): string;
Return a fully-qualified batchPredictionJob resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
batchPredictionJob |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
cachedContentPath(project, location, cachedContent)
cachedContentPath(project: string, location: string, cachedContent: string): string;
Return a fully-qualified cachedContent resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
cachedContent |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
cancelBatchPredictionJob(request?: protos.google.cloud.aiplatform.v1beta1.ICancelBatchPredictionJobRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.aiplatform.v1beta1.ICancelBatchPredictionJobRequest | undefined,
{} | undefined
]>;
Cancels a BatchPredictionJob.
Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its is set to CANCELLED. Any files already outputted by the job are not deleted.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the BatchPredictionJob to cancel.
* Format:
* `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callCancelBatchPredictionJob() {
// Construct request
const request = {
name,
};
// Run request
const response = await aiplatformClient.cancelBatchPredictionJob(request);
console.log(response);
}
callCancelBatchPredictionJob();
cancelBatchPredictionJob(request: protos.google.cloud.aiplatform.v1beta1.ICancelBatchPredictionJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.ICancelBatchPredictionJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
cancelBatchPredictionJob(request: protos.google.cloud.aiplatform.v1beta1.ICancelBatchPredictionJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.ICancelBatchPredictionJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
cancelCustomJob(request?: protos.google.cloud.aiplatform.v1beta1.ICancelCustomJobRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.aiplatform.v1beta1.ICancelCustomJobRequest | undefined,
{} | undefined
]>;
Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and CustomJob.state is set to CANCELLED.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the CustomJob to cancel.
* Format:
* `projects/{project}/locations/{location}/customJobs/{custom_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callCancelCustomJob() {
// Construct request
const request = {
name,
};
// Run request
const response = await aiplatformClient.cancelCustomJob(request);
console.log(response);
}
callCancelCustomJob();
cancelCustomJob(request: protos.google.cloud.aiplatform.v1beta1.ICancelCustomJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.ICancelCustomJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
cancelCustomJob(request: protos.google.cloud.aiplatform.v1beta1.ICancelCustomJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.ICancelCustomJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
cancelDataLabelingJob(request?: protos.google.cloud.aiplatform.v1beta1.ICancelDataLabelingJobRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.aiplatform.v1beta1.ICancelDataLabelingJobRequest | undefined,
{} | undefined
]>;
Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the DataLabelingJob.
* Format:
* `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callCancelDataLabelingJob() {
// Construct request
const request = {
name,
};
// Run request
const response = await aiplatformClient.cancelDataLabelingJob(request);
console.log(response);
}
callCancelDataLabelingJob();
cancelDataLabelingJob(request: protos.google.cloud.aiplatform.v1beta1.ICancelDataLabelingJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.ICancelDataLabelingJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
cancelDataLabelingJob(request: protos.google.cloud.aiplatform.v1beta1.ICancelDataLabelingJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.ICancelDataLabelingJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
cancelHyperparameterTuningJob(request?: protos.google.cloud.aiplatform.v1beta1.ICancelHyperparameterTuningJobRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.aiplatform.v1beta1.ICancelHyperparameterTuningJobRequest | undefined,
{} | undefined
]>;
Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and HyperparameterTuningJob.state is set to CANCELLED.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the HyperparameterTuningJob to cancel.
* Format:
* `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callCancelHyperparameterTuningJob() {
// Construct request
const request = {
name,
};
// Run request
const response = await aiplatformClient.cancelHyperparameterTuningJob(request);
console.log(response);
}
callCancelHyperparameterTuningJob();
cancelHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1beta1.ICancelHyperparameterTuningJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.ICancelHyperparameterTuningJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
cancelHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1beta1.ICancelHyperparameterTuningJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.ICancelHyperparameterTuningJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
cancelNasJob(request?: protos.google.cloud.aiplatform.v1beta1.ICancelNasJobRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.aiplatform.v1beta1.ICancelNasJobRequest | undefined,
{} | undefined
]>;
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 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 NasJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and NasJob.state is set to CANCELLED.
| Parameters |
| Name |
Description |
request |
ICancelNasJobRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the NasJob to cancel.
* Format:
* `projects/{project}/locations/{location}/nasJobs/{nas_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callCancelNasJob() {
// Construct request
const request = {
name,
};
// Run request
const response = await aiplatformClient.cancelNasJob(request);
console.log(response);
}
callCancelNasJob();
cancelNasJob(request: protos.google.cloud.aiplatform.v1beta1.ICancelNasJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.ICancelNasJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
cancelNasJob(request: protos.google.cloud.aiplatform.v1beta1.ICancelNasJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.ICancelNasJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
checkDeleteBatchPredictionJobProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>;
Check the status of the long running operation returned by deleteBatchPredictionJob().
| Parameter |
| Name |
Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the BatchPredictionJob resource to be deleted.
* Format:
* `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callDeleteBatchPredictionJob() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteBatchPredictionJob(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteBatchPredictionJob();
checkDeleteCustomJobProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>;
Check the status of the long running operation returned by deleteCustomJob().
| Parameter |
| Name |
Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the CustomJob resource to be deleted.
* Format:
* `projects/{project}/locations/{location}/customJobs/{custom_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callDeleteCustomJob() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteCustomJob(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteCustomJob();
checkDeleteDataLabelingJobProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>;
Check the status of the long running operation returned by deleteDataLabelingJob().
| Parameter |
| Name |
Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the DataLabelingJob to be deleted.
* Format:
* `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callDeleteDataLabelingJob() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteDataLabelingJob(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteDataLabelingJob();
checkDeleteHyperparameterTuningJobProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>;
Check the status of the long running operation returned by deleteHyperparameterTuningJob().
| Parameter |
| Name |
Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the HyperparameterTuningJob resource to be deleted.
* Format:
* `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callDeleteHyperparameterTuningJob() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteHyperparameterTuningJob(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteHyperparameterTuningJob();
checkDeleteModelDeploymentMonitoringJobProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>;
Check the status of the long running operation returned by deleteModelDeploymentMonitoringJob().
| Parameter |
| Name |
Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the model monitoring job to delete.
* Format:
* `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callDeleteModelDeploymentMonitoringJob() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteModelDeploymentMonitoringJob(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteModelDeploymentMonitoringJob();
checkDeleteNasJobProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>;
Check the status of the long running operation returned by deleteNasJob().
| Parameter |
| Name |
Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the NasJob resource to be deleted.
* Format:
* `projects/{project}/locations/{location}/nasJobs/{nas_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callDeleteNasJob() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteNasJob(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteNasJob();
checkUpdateModelDeploymentMonitoringJobProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob, protos.google.cloud.aiplatform.v1beta1.UpdateModelDeploymentMonitoringJobOperationMetadata>>;
Check the status of the long running operation returned by updateModelDeploymentMonitoringJob().
| Parameter |
| Name |
Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The model monitoring configuration which replaces the resource on
* the server.
*/
// const modelDeploymentMonitoringJob = {}
/**
* Required. The update mask is used to specify the fields to be overwritten
* in the ModelDeploymentMonitoringJob resource by the update. The fields
* specified in the update_mask are relative to the resource, not the full
* request. A field will be overwritten if it is in the mask. If the user does
* not provide a mask then only the non-empty fields present in the request
* will be overwritten. Set the update_mask to `*` to override all fields. For
* the objective config, the user can either provide the update mask for
* model_deployment_monitoring_objective_configs or any combination of its
* nested fields, such as:
* model_deployment_monitoring_objective_configs.objective_config.training_dataset.
* Updatable fields:
* * `display_name`
* * `model_deployment_monitoring_schedule_config`
* * `model_monitoring_alert_config`
* * `logging_sampling_strategy`
* * `labels`
* * `log_ttl`
* * `enable_monitoring_pipeline_logs`
* . and
* * `model_deployment_monitoring_objective_configs`
* . or
* * `model_deployment_monitoring_objective_configs.objective_config.training_dataset`
* * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config`
* * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`
*/
// const updateMask = {}
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callUpdateModelDeploymentMonitoringJob() {
// Construct request
const request = {
modelDeploymentMonitoringJob,
updateMask,
};
// Run request
const [operation] = await aiplatformClient.updateModelDeploymentMonitoringJob(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateModelDeploymentMonitoringJob();
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
| Returns |
| Type |
Description |
Promise<void> |
{Promise} A promise that resolves when the client is closed.
|
contextPath(project, location, metadataStore, context)
contextPath(project: string, location: string, metadataStore: string, context: string): string;
Return a fully-qualified context resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
metadataStore |
string
|
context |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
createBatchPredictionJob(request?: protos.google.cloud.aiplatform.v1beta1.ICreateBatchPredictionJobRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IBatchPredictionJob,
protos.google.cloud.aiplatform.v1beta1.ICreateBatchPredictionJobRequest | undefined,
{} | undefined
]>;
Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the Location to create the
* BatchPredictionJob in. Format: `projects/{project}/locations/{location}`
*/
// const parent = 'abc123'
/**
* Required. The BatchPredictionJob to create.
*/
// const batchPredictionJob = {}
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callCreateBatchPredictionJob() {
// Construct request
const request = {
parent,
batchPredictionJob,
};
// Run request
const response = await aiplatformClient.createBatchPredictionJob(request);
console.log(response);
}
callCreateBatchPredictionJob();
createBatchPredictionJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateBatchPredictionJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IBatchPredictionJob, protos.google.cloud.aiplatform.v1beta1.ICreateBatchPredictionJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createBatchPredictionJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateBatchPredictionJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IBatchPredictionJob, protos.google.cloud.aiplatform.v1beta1.ICreateBatchPredictionJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createCustomJob(request?: protos.google.cloud.aiplatform.v1beta1.ICreateCustomJobRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ICustomJob,
protos.google.cloud.aiplatform.v1beta1.ICreateCustomJobRequest | undefined,
{} | undefined
]>;
Creates a CustomJob. A created CustomJob right away will be attempted to be run.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the Location to create the CustomJob in.
* Format: `projects/{project}/locations/{location}`
*/
// const parent = 'abc123'
/**
* Required. The CustomJob to create.
*/
// const customJob = {}
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callCreateCustomJob() {
// Construct request
const request = {
parent,
customJob,
};
// Run request
const response = await aiplatformClient.createCustomJob(request);
console.log(response);
}
callCreateCustomJob();
createCustomJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateCustomJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ICustomJob, protos.google.cloud.aiplatform.v1beta1.ICreateCustomJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createCustomJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateCustomJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ICustomJob, protos.google.cloud.aiplatform.v1beta1.ICreateCustomJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createDataLabelingJob(request?: protos.google.cloud.aiplatform.v1beta1.ICreateDataLabelingJobRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IDataLabelingJob,
protos.google.cloud.aiplatform.v1beta1.ICreateDataLabelingJobRequest | undefined,
{} | undefined
]>;
Creates a DataLabelingJob.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent of the DataLabelingJob.
* Format: `projects/{project}/locations/{location}`
*/
// const parent = 'abc123'
/**
* Required. The DataLabelingJob to create.
*/
// const dataLabelingJob = {}
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callCreateDataLabelingJob() {
// Construct request
const request = {
parent,
dataLabelingJob,
};
// Run request
const response = await aiplatformClient.createDataLabelingJob(request);
console.log(response);
}
callCreateDataLabelingJob();
createDataLabelingJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateDataLabelingJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IDataLabelingJob, protos.google.cloud.aiplatform.v1beta1.ICreateDataLabelingJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createDataLabelingJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateDataLabelingJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IDataLabelingJob, protos.google.cloud.aiplatform.v1beta1.ICreateDataLabelingJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createHyperparameterTuningJob(request?: protos.google.cloud.aiplatform.v1beta1.ICreateHyperparameterTuningJobRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IHyperparameterTuningJob,
protos.google.cloud.aiplatform.v1beta1.ICreateHyperparameterTuningJobRequest | undefined,
{} | undefined
]>;
Creates a HyperparameterTuningJob
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the Location to create the
* HyperparameterTuningJob in. Format:
* `projects/{project}/locations/{location}`
*/
// const parent = 'abc123'
/**
* Required. The HyperparameterTuningJob to create.
*/
// const hyperparameterTuningJob = {}
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callCreateHyperparameterTuningJob() {
// Construct request
const request = {
parent,
hyperparameterTuningJob,
};
// Run request
const response = await aiplatformClient.createHyperparameterTuningJob(request);
console.log(response);
}
callCreateHyperparameterTuningJob();
createHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateHyperparameterTuningJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IHyperparameterTuningJob, protos.google.cloud.aiplatform.v1beta1.ICreateHyperparameterTuningJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateHyperparameterTuningJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IHyperparameterTuningJob, protos.google.cloud.aiplatform.v1beta1.ICreateHyperparameterTuningJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createModelDeploymentMonitoringJob(request?: protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob,
protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest | undefined,
{} | undefined
]>;
Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent of the ModelDeploymentMonitoringJob.
* Format: `projects/{project}/locations/{location}`
*/
// const parent = 'abc123'
/**
* Required. The ModelDeploymentMonitoringJob to create
*/
// const modelDeploymentMonitoringJob = {}
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callCreateModelDeploymentMonitoringJob() {
// Construct request
const request = {
parent,
modelDeploymentMonitoringJob,
};
// Run request
const response = await aiplatformClient.createModelDeploymentMonitoringJob(request);
console.log(response);
}
callCreateModelDeploymentMonitoringJob();
createModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob, protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IModelDeploymentMonitoringJob, protos.google.cloud.aiplatform.v1beta1.ICreateModelDeploymentMonitoringJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createNasJob(request?: protos.google.cloud.aiplatform.v1beta1.ICreateNasJobRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.INasJob,
protos.google.cloud.aiplatform.v1beta1.ICreateNasJobRequest | undefined,
{} | undefined
]>;
| Parameters |
| Name |
Description |
request |
ICreateNasJobRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the Location to create the NasJob in.
* Format: `projects/{project}/locations/{location}`
*/
// const parent = 'abc123'
/**
* Required. The NasJob to create.
*/
// const nasJob = {}
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callCreateNasJob() {
// Construct request
const request = {
parent,
nasJob,
};
// Run request
const response = await aiplatformClient.createNasJob(request);
console.log(response);
}
callCreateNasJob();
createNasJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateNasJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.INasJob, protos.google.cloud.aiplatform.v1beta1.ICreateNasJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createNasJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateNasJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.INasJob, protos.google.cloud.aiplatform.v1beta1.ICreateNasJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
customJobPath(project: string, location: string, customJob: string): string;
Return a fully-qualified customJob resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
customJob |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
dataItemPath(project: string, location: string, dataset: string, dataItem: string): string;
Return a fully-qualified dataItem resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
dataset |
string
|
dataItem |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
dataLabelingJobPath(project: string, location: string, dataLabelingJob: string): string;
Return a fully-qualified dataLabelingJob resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
dataLabelingJob |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
datasetPath(project: string, location: string, dataset: string): string;
Return a fully-qualified dataset resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
dataset |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
datasetVersionPath(project: string, location: string, dataset: string, datasetVersion: string): string;
Return a fully-qualified datasetVersion resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
dataset |
string
|
datasetVersion |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
deleteBatchPredictionJob(request?: protos.google.cloud.aiplatform.v1beta1.IDeleteBatchPredictionJobRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a BatchPredictionJob. Can only be called on jobs that already finished.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the BatchPredictionJob resource to be deleted.
* Format:
* `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callDeleteBatchPredictionJob() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteBatchPredictionJob(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteBatchPredictionJob();
deleteBatchPredictionJob(request: protos.google.cloud.aiplatform.v1beta1.IDeleteBatchPredictionJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteBatchPredictionJob(request: protos.google.cloud.aiplatform.v1beta1.IDeleteBatchPredictionJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteCustomJob(request?: protos.google.cloud.aiplatform.v1beta1.IDeleteCustomJobRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the CustomJob resource to be deleted.
* Format:
* `projects/{project}/locations/{location}/customJobs/{custom_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callDeleteCustomJob() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteCustomJob(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteCustomJob();
deleteCustomJob(request: protos.google.cloud.aiplatform.v1beta1.IDeleteCustomJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteCustomJob(request: protos.google.cloud.aiplatform.v1beta1.IDeleteCustomJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteDataLabelingJob(request?: protos.google.cloud.aiplatform.v1beta1.IDeleteDataLabelingJobRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a DataLabelingJob.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the DataLabelingJob to be deleted.
* Format:
* `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callDeleteDataLabelingJob() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteDataLabelingJob(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteDataLabelingJob();
deleteDataLabelingJob(request: protos.google.cloud.aiplatform.v1beta1.IDeleteDataLabelingJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteDataLabelingJob(request: protos.google.cloud.aiplatform.v1beta1.IDeleteDataLabelingJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteHyperparameterTuningJob(request?: protos.google.cloud.aiplatform.v1beta1.IDeleteHyperparameterTuningJobRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a HyperparameterTuningJob.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the HyperparameterTuningJob resource to be deleted.
* Format:
* `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callDeleteHyperparameterTuningJob() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteHyperparameterTuningJob(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteHyperparameterTuningJob();
deleteHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1beta1.IDeleteHyperparameterTuningJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteHyperparameterTuningJob(request: protos.google.cloud.aiplatform.v1beta1.IDeleteHyperparameterTuningJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteModelDeploymentMonitoringJob(request?: protos.google.cloud.aiplatform.v1beta1.IDeleteModelDeploymentMonitoringJobRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a ModelDeploymentMonitoringJob.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the model monitoring job to delete.
* Format:
* `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callDeleteModelDeploymentMonitoringJob() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteModelDeploymentMonitoringJob(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteModelDeploymentMonitoringJob();
deleteModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1beta1.IDeleteModelDeploymentMonitoringJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteModelDeploymentMonitoringJob(request: protos.google.cloud.aiplatform.v1beta1.IDeleteModelDeploymentMonitoringJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteNasJob(request?: protos.google.cloud.aiplatform.v1beta1.IDeleteNasJobRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
| Parameters |
| Name |
Description |
request |
IDeleteNasJobRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the NasJob resource to be deleted.
* Format:
* `projects/{project}/locations/{location}/nasJobs/{nas_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callDeleteNasJob() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteNasJob(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteNasJob();
deleteNasJob(request: protos.google.cloud.aiplatform.v1beta1.IDeleteNasJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteNasJob(request: protos.google.cloud.aiplatform.v1beta1.IDeleteNasJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
deploymentResourcePoolPath(project: string, location: string, deploymentResourcePool: string): string;
Return a fully-qualified deploymentResourcePool resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
deploymentResourcePool |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
entityTypePath(project: string, location: string, featurestore: string, entityType: string): string;
Return a fully-qualified entityType resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
featurestore |
string
|
entityType |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
exampleStorePath(project: string, location: string, exampleStore: string): string;
Return a fully-qualified exampleStore resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
exampleStore |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
executionPath(project: string, location: string, metadataStore: string, execution: string): string;
Return a fully-qualified execution resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
metadataStore |
string
|
execution |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
extensionPath(project: string, location: string, extension: string): string;
Return a fully-qualified extension resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
extension |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
featureGroupPath(project: string, location: string, featureGroup: string): string;
Return a fully-qualified featureGroup resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
featureGroup |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
featureMonitorJobPath(project: string, location: string, featureGroup: string, featureMonitor: string, featureMonitorJob: string): string;
Return a fully-qualified featureMonitorJob resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
featureGroup |
string
|
featureMonitor |
string
|
featureMonitorJob |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
featureMonitorPath(project: string, location: string, featureGroup: string, featureMonitor: string): string;
Return a fully-qualified featureMonitor resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
featureGroup |
string
|
featureMonitor |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
featureOnlineStorePath(project: string, location: string, featureOnlineStore: string): string;
Return a fully-qualified featureOnlineStore resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
featureOnlineStore |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
featurestorePath(project: string, location: string, featurestore: string): string;
Return a fully-qualified featurestore resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
featurestore |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
featureViewPath(project: string, location: string, featureOnlineStore: string, featureView: string): string;
Return a fully-qualified featureView resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
featureOnlineStore |
string
|
featureView |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
featureViewSyncPath(project: string, location: string, featureOnlineStore: string, featureView: string): string;
Return a fully-qualified featureViewSync resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
featureOnlineStore |
string
|
featureView |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
getBatchPredictionJob(request?: protos.google.cloud.aiplatform.v1beta1.IGetBatchPredictionJobRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IBatchPredictionJob,
protos.google.cloud.aiplatform.v1beta1.IGetBatchPredictionJobRequest | undefined,
{} | undefined
]>;
Gets a BatchPredictionJob
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the BatchPredictionJob resource.
* Format:
* `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new JobServiceClient();
async function callGetBatchPredictionJob() {
// Construct request
const request = {
name,
};
// Run request
const response = await aiplatformClient.getBatchPredictionJob(request);
console.log(response);
}
callGetBatchPredictionJob();
getBatchPredictionJob(request: protos.google.cloud.aiplatform.v1beta1.IGetBatchPredictionJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IBatchPredictionJob, protos.google.cloud.aiplatform.v1beta1.IGetBatchPredictionJobRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getBatchPredictionJob(request: protos.google.cloud.aiplatform.v1beta1.IGetBatchPredictionJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IBatchPredictionJob, protos.google
