A service that migrates resources from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI. v1
Package
@google-cloud/aiplatform!Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);Construct an instance of MigrationServiceClient.
| Name | Description |
| opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
| Type | Description |
| string |
auth
auth: gax.GoogleAuth;| Type | Description |
| gax.GoogleAuth |
descriptors
descriptors: Descriptors;| Type | Description |
| Descriptors |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};| Type | Description |
| { [name: string]: Function; } |
migrationServiceStub
migrationServiceStub?: Promise<{
[name: string]: Function;
}>;| Type | Description |
| Promise<{ [name: string]: Function; }> |
operationsClient
operationsClient: gax.OperationsClient;| Type | Description |
| gax.OperationsClient |
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};| Type | Description |
| { [name: string]: gax.PathTemplate; } |
port
static get port(): number;The port for this API service.
| Type | Description |
| number |
scopes
static get scopes(): string[];The scopes needed to make gRPC calls for every method defined in this service.
| Type | Description |
| string[] |
servicePath
static get servicePath(): string;The DNS address for this API service.
| Type | Description |
| string |
Methods
annotationPath(project, location, dataset, dataItem, annotation)
annotationPath(project: string, location: string, dataset: string, dataItem: string, annotation: string): string;Return a fully-qualified annotation resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| dataset |
string
|
| dataItem |
string
|
| annotation |
string
|
| Type | Description |
| string | {string} Resource name string. |
annotationSpecPath(project, location, dataset, annotationSpec)
annotationSpecPath(project: string, location: string, dataset: string, annotationSpec: string): string;Return a fully-qualified annotationSpec resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| dataset |
string
|
| annotationSpec |
string
|
| Type | Description |
| string | {string} Resource name string. |
batchMigrateResources(request, options)
batchMigrateResources(request?: protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesResponse, protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;| Name | Description |
| request |
protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesRequest
|
| options |
CallOptions
|
| Type | Description |
| Promise<[ LROperation<protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesResponse, protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> |
batchMigrateResources(request, options, callback)
batchMigrateResources(request: protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesResponse, protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Name | Description |
| request |
protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesRequest
|
| options |
CallOptions
|
| callback |
Callback<LROperation<protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesResponse, protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Type | Description |
| void |
batchMigrateResources(request, callback)
batchMigrateResources(request: protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesResponse, protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Name | Description |
| request |
protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesRequest
|
| callback |
Callback<LROperation<protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesResponse, protos.google.cloud.aiplatform.v1.IBatchMigrateResourcesOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Type | Description |
| void |
batchPredictionJobPath(project, location, batchPredictionJob)
batchPredictionJobPath(project: string, location: string, batchPredictionJob: string): string;Return a fully-qualified batchPredictionJob resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| batchPredictionJob |
string
|
| Type | Description |
| string | {string} Resource name string. |
checkBatchMigrateResourcesProgress(name)
checkBatchMigrateResourcesProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1.BatchMigrateResourcesResponse, protos.google.cloud.aiplatform.v1.BatchMigrateResourcesOperationMetadata>>;Check the status of the long running operation returned by batchMigrateResources().
| Name | Description |
| name |
string
The operation name that will be passed. |
| Type | Description |
| Promise<LROperation<protos.google.cloud.aiplatform.v1.BatchMigrateResourcesResponse, protos.google.cloud.aiplatform.v1.BatchMigrateResourcesOperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
close()
close(): Promise<void>;Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
| Type | Description |
| Promise<void> | {Promise} A promise that resolves when the client is closed. |
customJobPath(project, location, customJob)
customJobPath(project: string, location: string, customJob: string): string;Return a fully-qualified customJob resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| customJob |
string
|
| Type | Description |
| string | {string} Resource name string. |
dataItemPath(project, location, dataset, dataItem)
dataItemPath(project: string, location: string, dataset: string, dataItem: string): string;Return a fully-qualified dataItem resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| dataset |
string
|
| dataItem |
string
|
| Type | Description |
| string | {string} Resource name string. |
dataLabelingJobPath(project, location, dataLabelingJob)
dataLabelingJobPath(project: string, location: string, dataLabelingJob: string): string;Return a fully-qualified dataLabelingJob resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| dataLabelingJob |
string
|
| Type | Description |
| string | {string} Resource name string. |
datasetPath(project, location, dataset)
datasetPath(project: string, location: string, dataset: string): string;Return a fully-qualified dataset resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| dataset |
string
|
| Type | Description |
| string | {string} Resource name string. |
endpointPath(project, location, endpoint)
endpointPath(project: string, location: string, endpoint: string): string;Return a fully-qualified endpoint resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| endpoint |
string
|
| Type | Description |
| string | {string} Resource name string. |
getProjectId()
getProjectId(): Promise<string>;| Type | Description |
| Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;| Name | Description |
| callback |
Callback<string, undefined, undefined>
|
| Type | Description |
| void |
hyperparameterTuningJobPath(project, location, hyperparameterTuningJob)
hyperparameterTuningJobPath(project: string, location: string, hyperparameterTuningJob: string): string;Return a fully-qualified hyperparameterTuningJob resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| hyperparameterTuningJob |
string
|
| Type | Description |
| string | {string} Resource name string. |
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
| Type | Description |
| Promise<{ [name: string]: Function; }> | {Promise} A promise that resolves to an authenticated service stub. |
locationPath(project, location)
locationPath(project: string, location: string): string;Return a fully-qualified location resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| Type | Description |
| string | {string} Resource name string. |
matchAnnotationFromAnnotationName(annotationName)
matchAnnotationFromAnnotationName(annotationName: string): string | number;Parse the annotation from Annotation resource.
| Name | Description |
| annotationName |
string
A fully-qualified path representing Annotation resource. |
| Type | Description |
| string | number | {string} A string representing the annotation. |
matchAnnotationSpecFromAnnotationSpecName(annotationSpecName)
matchAnnotationSpecFromAnnotationSpecName(annotationSpecName: string): string | number;Parse the annotation_spec from AnnotationSpec resource.
| Name | Description |
| annotationSpecName |
string
A fully-qualified path representing AnnotationSpec resource. |
| Type | Description |
| string | number | {string} A string representing the annotation_spec. |
matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName)
matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName: string): string | number;Parse the batch_prediction_job from BatchPredictionJob resource.
| Name | Description |
| batchPredictionJobName |
string
A fully-qualified path representing BatchPredictionJob resource. |
| Type | Description |
| string | number | {string} A string representing the batch_prediction_job. |
matchCustomJobFromCustomJobName(customJobName)
matchCustomJobFromCustomJobName(customJobName: string): string | number;Parse the custom_job from CustomJob resource.
| Name | Description |
| customJobName |
string
A fully-qualified path representing CustomJob resource. |
| Type | Description |
| string | number | {string} A string representing the custom_job. |
matchDataItemFromAnnotationName(annotationName)
matchDataItemFromAnnotationName(annotationName: string): string | number;Parse the data_item from Annotation resource.
| Name | Description |
| annotationName |
string
A fully-qualified path representing Annotation resource. |
| Type | Description |
| string | number | {string} A string representing the data_item. |
matchDataItemFromDataItemName(dataItemName)
matchDataItemFromDataItemName(dataItemName: string): string | number;Parse the data_item from DataItem resource.
| Name | Description |
| dataItemName |
string
A fully-qualified path representing DataItem resource. |
| Type | Description |
| string | number | {string} A string representing the data_item. |
matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName)
matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName: string): string | number;Parse the data_labeling_job from DataLabelingJob resource.
| Name | Description |
| dataLabelingJobName |
string
A fully-qualified path representing DataLabelingJob resource. |
| Type | Description |
| string | number | {string} A string representing the data_labeling_job. |
matchDatasetFromAnnotationName(annotationName)
matchDatasetFromAnnotationName(annotationName: string): string | number;Parse the dataset from Annotation resource.
| Name | Description |
| annotationName |
string
A fully-qualified path representing Annotation resource. |
| Type | Description |
| string | number | {string} A string representing the dataset. |
matchDatasetFromAnnotationSpecName(annotationSpecName)
matchDatasetFromAnnotationSpecName(annotationSpecName: string): string | number;Parse the dataset from AnnotationSpec resource.
| Name | Description |
| annotationSpecName |
string
A fully-qualified path representing AnnotationSpec resource. |
| Type | Description |
| string | number | {string} A string representing the dataset. |
matchDatasetFromDataItemName(dataItemName)
matchDatasetFromDataItemName(dataItemName: string): string | number;Parse the dataset from DataItem resource.
| Name | Description |
| dataItemName |
string
A fully-qualified path representing DataItem resource. |
| Type | Description |
| string | number | {string} A string representing the dataset. |
matchDatasetFromDatasetName(datasetName)
matchDatasetFromDatasetName(datasetName: string): string | number;Parse the dataset from Dataset resource.
| Name | Description |
| datasetName |
string
A fully-qualified path representing Dataset resource. |
| Type | Description |
| string | number | {string} A string representing the dataset. |
matchEndpointFromEndpointName(endpointName)
matchEndpointFromEndpointName(endpointName: string): string | number;Parse the endpoint from Endpoint resource.
| Name | Description |
| endpointName |
string
A fully-qualified path representing Endpoint resource. |
| Type | Description |
| string | number | {string} A string representing the endpoint. |
matchEvaluationFromModelEvaluationName(modelEvaluationName)
matchEvaluationFromModelEvaluationName(modelEvaluationName: string): string | number;Parse the evaluation from ModelEvaluation resource.
| Name | Description |
| modelEvaluationName |
string
A fully-qualified path representing ModelEvaluation resource. |
| Type | Description |
| string | number | {string} A string representing the evaluation. |
matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName)
matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;Parse the evaluation from ModelEvaluationSlice resource.
| Name | Description |
| modelEvaluationSliceName |
string
A fully-qualified path representing ModelEvaluationSlice resource. |
| Type | Description |
| string | number | {string} A string representing the evaluation. |
matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName)
matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;Parse the hyperparameter_tuning_job from HyperparameterTuningJob resource.
| Name | Description |
| hyperparameterTuningJobName |
string
A fully-qualified path representing HyperparameterTuningJob resource. |
| Type | Description |
| string | number | {string} A string representing the hyperparameter_tuning_job. |
matchLocationFromAnnotationName(annotationName)
matchLocationFromAnnotationName(annotationName: string): string | number;Parse the location from Annotation resource.
| Name | Description |
| annotationName |
string
A fully-qualified path representing Annotation resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromAnnotationSpecName(annotationSpecName)
matchLocationFromAnnotationSpecName(annotationSpecName: string): string | number;Parse the location from AnnotationSpec resource.
| Name | Description |
| annotationSpecName |
string
A fully-qualified path representing AnnotationSpec resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromBatchPredictionJobName(batchPredictionJobName)
matchLocationFromBatchPredictionJobName(batchPredictionJobName: string): string | number;Parse the location from BatchPredictionJob resource.
| Name | Description |
| batchPredictionJobName |
string
A fully-qualified path representing BatchPredictionJob resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromCustomJobName(customJobName)
matchLocationFromCustomJobName(customJobName: string): string | number;Parse the location from CustomJob resource.
| Name | Description |
| customJobName |
string
A fully-qualified path representing CustomJob resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromDataItemName(dataItemName)
matchLocationFromDataItemName(dataItemName: string): string | number;Parse the location from DataItem resource.
| Name | Description |
| dataItemName |
string
A fully-qualified path representing DataItem resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromDataLabelingJobName(dataLabelingJobName)
matchLocationFromDataLabelingJobName(dataLabelingJobName: string): string | number;Parse the location from DataLabelingJob resource.
| Name | Description |
| dataLabelingJobName |
string
A fully-qualified path representing DataLabelingJob resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromDatasetName(datasetName)
matchLocationFromDatasetName(datasetName: string): string | number;Parse the location from Dataset resource.
| Name | Description |
| datasetName |
string
A fully-qualified path representing Dataset resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromEndpointName(endpointName)
matchLocationFromEndpointName(endpointName: string): string | number;Parse the location from Endpoint resource.
| Name | Description |
| endpointName |
string
A fully-qualified path representing Endpoint resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName)
matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;Parse the location from HyperparameterTuningJob resource.
| Name | Description |
| hyperparameterTuningJobName |
string
A fully-qualified path representing HyperparameterTuningJob resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromLocationName(locationName)
matchLocationFromLocationName(locationName: string): string | number;Parse the location from Location resource.
| Name | Description |
| locationName |
string
A fully-qualified path representing Location resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromModelEvaluationName(modelEvaluationName)
matchLocationFromModelEvaluationName(modelEvaluationName: string): string | number;Parse the location from ModelEvaluation resource.
| Name | Description |
| modelEvaluationName |
string
A fully-qualified path representing ModelEvaluation resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName)
matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;Parse the location from ModelEvaluationSlice resource.
| Name | Description |
| modelEvaluationSliceName |
string
A fully-qualified path representing ModelEvaluationSlice resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromModelName(modelName)
matchLocationFromModelName(modelName: string): string | number;Parse the location from Model resource.
| Name | Description |
| modelName |
string
A fully-qualified path representing Model resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromSpecialistPoolName(specialistPoolName)
matchLocationFromSpecialistPoolName(specialistPoolName: string): string | number;Parse the location from SpecialistPool resource.
| Name | Description |
| specialistPoolName |
string
A fully-qualified path representing SpecialistPool resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromTrainingPipelineName(trainingPipelineName)
matchLocationFromTrainingPipelineName(trainingPipelineName: string): string | number;Parse the location from TrainingPipeline resource.
| Name | Description |
| trainingPipelineName |
string
A fully-qualified path representing TrainingPipeline resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchLocationFromTrialName(trialName)
matchLocationFromTrialName(trialName: string): string | number;Parse the location from Trial resource.
| Name | Description |
| trialName |
string
A fully-qualified path representing Trial resource. |
| Type | Description |
| string | number | {string} A string representing the location. |
matchModelFromModelEvaluationName(modelEvaluationName)
matchModelFromModelEvaluationName(modelEvaluationName: string): string | number;Parse the model from ModelEvaluation resource.
| Name | Description |
| modelEvaluationName |
string
A fully-qualified path representing ModelEvaluation resource. |
| Type | Description |
| string | number | {string} A string representing the model. |
matchModelFromModelEvaluationSliceName(modelEvaluationSliceName)
matchModelFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;Parse the model from ModelEvaluationSlice resource.
| Name | Description |
| modelEvaluationSliceName |
string
A fully-qualified path representing ModelEvaluationSlice resource. |
| Type | Description |
| string | number | {string} A string representing the model. |
matchModelFromModelName(modelName)
matchModelFromModelName(modelName: string): string | number;Parse the model from Model resource.
| Name | Description |
| modelName |
string
A fully-qualified path representing Model resource. |
| Type | Description |
| string | number | {string} A string representing the model. |
matchProjectFromAnnotationName(annotationName)
matchProjectFromAnnotationName(annotationName: string): string | number;Parse the project from Annotation resource.
| Name | Description |
| annotationName |
string
A fully-qualified path representing Annotation resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromAnnotationSpecName(annotationSpecName)
matchProjectFromAnnotationSpecName(annotationSpecName: string): string | number;Parse the project from AnnotationSpec resource.
| Name | Description |
| annotationSpecName |
string
A fully-qualified path representing AnnotationSpec resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromBatchPredictionJobName(batchPredictionJobName)
matchProjectFromBatchPredictionJobName(batchPredictionJobName: string): string | number;Parse the project from BatchPredictionJob resource.
| Name | Description |
| batchPredictionJobName |
string
A fully-qualified path representing BatchPredictionJob resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromCustomJobName(customJobName)
matchProjectFromCustomJobName(customJobName: string): string | number;Parse the project from CustomJob resource.
| Name | Description |
| customJobName |
string
A fully-qualified path representing CustomJob resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromDataItemName(dataItemName)
matchProjectFromDataItemName(dataItemName: string): string | number;Parse the project from DataItem resource.
| Name | Description |
| dataItemName |
string
A fully-qualified path representing DataItem resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromDataLabelingJobName(dataLabelingJobName)
matchProjectFromDataLabelingJobName(dataLabelingJobName: string): string | number;Parse the project from DataLabelingJob resource.
| Name | Description |
| dataLabelingJobName |
string
A fully-qualified path representing DataLabelingJob resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromDatasetName(datasetName)
matchProjectFromDatasetName(datasetName: string): string | number;Parse the project from Dataset resource.
| Name | Description |
| datasetName |
string
A fully-qualified path representing Dataset resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromEndpointName(endpointName)
matchProjectFromEndpointName(endpointName: string): string | number;Parse the project from Endpoint resource.
| Name | Description |
| endpointName |
string
A fully-qualified path representing Endpoint resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromHyperparameterTuningJobName(hyperparameterTuningJobName)
matchProjectFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;Parse the project from HyperparameterTuningJob resource.
| Name | Description |
| hyperparameterTuningJobName |
string
A fully-qualified path representing HyperparameterTuningJob resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName: string): string | number;Parse the project from Location resource.
| Name | Description |
| locationName |
string
A fully-qualified path representing Location resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromModelEvaluationName(modelEvaluationName)
matchProjectFromModelEvaluationName(modelEvaluationName: string): string | number;Parse the project from ModelEvaluation resource.
| Name | Description |
| modelEvaluationName |
string
A fully-qualified path representing ModelEvaluation resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromModelEvaluationSliceName(modelEvaluationSliceName)
matchProjectFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;Parse the project from ModelEvaluationSlice resource.
| Name | Description |
| modelEvaluationSliceName |
string
A fully-qualified path representing ModelEvaluationSlice resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromModelName(modelName)
matchProjectFromModelName(modelName: string): string | number;Parse the project from Model resource.
| Name | Description |
| modelName |
string
A fully-qualified path representing Model resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromSpecialistPoolName(specialistPoolName)
matchProjectFromSpecialistPoolName(specialistPoolName: string): string | number;Parse the project from SpecialistPool resource.
| Name | Description |
| specialistPoolName |
string
A fully-qualified path representing SpecialistPool resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromTrainingPipelineName(trainingPipelineName)
matchProjectFromTrainingPipelineName(trainingPipelineName: string): string | number;Parse the project from TrainingPipeline resource.
| Name | Description |
| trainingPipelineName |
string
A fully-qualified path representing TrainingPipeline resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromTrialName(trialName)
matchProjectFromTrialName(trialName: string): string | number;Parse the project from Trial resource.
| Name | Description |
| trialName |
string
A fully-qualified path representing Trial resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchSliceFromModelEvaluationSliceName(modelEvaluationSliceName)
matchSliceFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;Parse the slice from ModelEvaluationSlice resource.
| Name | Description |
| modelEvaluationSliceName |
string
A fully-qualified path representing ModelEvaluationSlice resource. |
| Type | Description |
| string | number | {string} A string representing the slice. |
matchSpecialistPoolFromSpecialistPoolName(specialistPoolName)
matchSpecialistPoolFromSpecialistPoolName(specialistPoolName: string): string | number;Parse the specialist_pool from SpecialistPool resource.
| Name | Description |
| specialistPoolName |
string
A fully-qualified path representing SpecialistPool resource. |
| Type | Description |
| string | number | {string} A string representing the specialist_pool. |
matchStudyFromTrialName(trialName)
matchStudyFromTrialName(trialName: string): string | number;Parse the study from Trial resource.
| Name | Description |
| trialName |
string
A fully-qualified path representing Trial resource. |
| Type | Description |
| string | number | {string} A string representing the study. |
matchTrainingPipelineFromTrainingPipelineName(trainingPipelineName)
matchTrainingPipelineFromTrainingPipelineName(trainingPipelineName: string): string | number;Parse the training_pipeline from TrainingPipeline resource.
| Name | Description |
| trainingPipelineName |
string
A fully-qualified path representing TrainingPipeline resource. |
| Type | Description |
| string | number | {string} A string representing the training_pipeline. |
matchTrialFromTrialName(trialName)
matchTrialFromTrialName(trialName: string): string | number;Parse the trial from Trial resource.
| Name | Description |
| trialName |
string
A fully-qualified path representing Trial resource. |
| Type | Description |
| string | number | {string} A string representing the trial. |
modelEvaluationPath(project, location, model, evaluation)
modelEvaluationPath(project: string, location: string, model: string, evaluation: string): string;Return a fully-qualified modelEvaluation resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| model |
string
|
| evaluation |
string
|
| Type | Description |
| string | {string} Resource name string. |
modelEvaluationSlicePath(project, location, model, evaluation, slice)
modelEvaluationSlicePath(project: string, location: string, model: string, evaluation: string, slice: string): string;Return a fully-qualified modelEvaluationSlice resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| model |
string
|
| evaluation |
string
|
| slice |
string
|
| Type | Description |
| string | {string} Resource name string. |
modelPath(project, location, model)
modelPath(project: string, location: string, model: string): string;Return a fully-qualified model resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| model |
string
|
| Type | Description |
| string | {string} Resource name string. |
searchMigratableResources(request, options)
searchMigratableResources(request?: protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1.IMigratableResource[],
protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest | null,
protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesResponse
]>;| Name | Description |
| request |
protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest
|
| options |
CallOptions
|
| Type | Description |
| Promise<[ protos.google.cloud.aiplatform.v1.IMigratableResource[], protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest | null, protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesResponse ]> |
searchMigratableResources(request, options, callback)
searchMigratableResources(request: protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest, protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesResponse | null | undefined, protos.google.cloud.aiplatform.v1.IMigratableResource>): void;| Name | Description |
| request |
protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest
|
| options |
CallOptions
|
| callback |
PaginationCallback<protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest, protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesResponse | null | undefined, protos.google.cloud.aiplatform.v1.IMigratableResource>
|
| Type | Description |
| void |
searchMigratableResources(request, callback)
searchMigratableResources(request: protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest, protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesResponse | null | undefined, protos.google.cloud.aiplatform.v1.IMigratableResource>): void;| Name | Description |
| request |
protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest
|
| callback |
PaginationCallback<protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest, protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesResponse | null | undefined, protos.google.cloud.aiplatform.v1.IMigratableResource>
|
| Type | Description |
| void |
searchMigratableResourcesAsync(request, options)
searchMigratableResourcesAsync(request?: protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.IMigratableResource>;Equivalent to searchMigratableResources, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Name | Description |
| request |
protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest
The request object that will be sent. |
| options |
CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| AsyncIterable<protos.google.cloud.aiplatform.v1.IMigratableResource> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [MigratableResource]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
searchMigratableResourcesStream(request, options)
searchMigratableResourcesStream(request?: protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest, options?: CallOptions): Transform;Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.
| Name | Description |
| request |
protos.google.cloud.aiplatform.v1.ISearchMigratableResourcesRequest
The request object that will be sent. |
| options |
CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Transform | {Stream} An object stream which emits an object representing [MigratableResource] 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 |
specialistPoolPath(project, location, specialistPool)
specialistPoolPath(project: string, location: string, specialistPool: string): string;Return a fully-qualified specialistPool resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| specialistPool |
string
|
| Type | Description |
| string | {string} Resource name string. |
trainingPipelinePath(project, location, trainingPipeline)
trainingPipelinePath(project: string, location: string, trainingPipeline: string): string;Return a fully-qualified trainingPipeline resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| trainingPipeline |
string
|
| Type | Description |
| string | {string} Resource name string. |
trialPath(project, location, study, trial)
trialPath(project: string, location: string, study: string, trial: string): string;Return a fully-qualified trial resource name string.
| Name | Description |
| project |
string
|
| location |
string
|
| study |
string
|
| trial |
string
|
| Type | Description |
| string | {string} Resource name string. |