Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

AIplatform

import { AIplatform } from "https://googleapis.deno.dev/v1/aiplatform:v1.ts";

Train high-quality custom machine learning models with minimal machine learning expertise and effort.

class AIplatform {
constructor(client?: CredentialsClient, baseUrl?: string);
models;
models;
models;
models;
 
async projectsLocationsBatchPredictionJobsCancel(name: string, req: GoogleCloudAiplatformV1CancelBatchPredictionJobRequest): Promise<GoogleProtobufEmpty>;
async projectsLocationsBatchPredictionJobsCreate(parent: string, req: GoogleCloudAiplatformV1BatchPredictionJob): Promise<GoogleCloudAiplatformV1BatchPredictionJob>;
async projectsLocationsBatchPredictionJobsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsBatchPredictionJobsGet(name: string): Promise<GoogleCloudAiplatformV1BatchPredictionJob>;
async projectsLocationsBatchPredictionJobsList(parent: string, opts?: ProjectsLocationsBatchPredictionJobsListOptions): Promise<GoogleCloudAiplatformV1ListBatchPredictionJobsResponse>;
async projectsLocationsCustomJobsCancel(name: string, req: GoogleCloudAiplatformV1CancelCustomJobRequest): Promise<GoogleProtobufEmpty>;
async projectsLocationsCustomJobsCreate(parent: string, req: GoogleCloudAiplatformV1CustomJob): Promise<GoogleCloudAiplatformV1CustomJob>;
async projectsLocationsCustomJobsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsCustomJobsGet(name: string): Promise<GoogleCloudAiplatformV1CustomJob>;
async projectsLocationsCustomJobsList(parent: string, opts?: ProjectsLocationsCustomJobsListOptions): Promise<GoogleCloudAiplatformV1ListCustomJobsResponse>;
async projectsLocationsCustomJobsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsCustomJobsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsCustomJobsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsCustomJobsOperationsList(name: string, opts?: ProjectsLocationsCustomJobsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsCustomJobsOperationsWait(name: string, opts?: ProjectsLocationsCustomJobsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsDataLabelingJobsCancel(name: string, req: GoogleCloudAiplatformV1CancelDataLabelingJobRequest): Promise<GoogleProtobufEmpty>;
async projectsLocationsDataLabelingJobsCreate(parent: string, req: GoogleCloudAiplatformV1DataLabelingJob): Promise<GoogleCloudAiplatformV1DataLabelingJob>;
async projectsLocationsDataLabelingJobsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsDataLabelingJobsGet(name: string): Promise<GoogleCloudAiplatformV1DataLabelingJob>;
async projectsLocationsDataLabelingJobsList(parent: string, opts?: ProjectsLocationsDataLabelingJobsListOptions): Promise<GoogleCloudAiplatformV1ListDataLabelingJobsResponse>;
async projectsLocationsDataLabelingJobsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsDataLabelingJobsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsDataLabelingJobsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsDataLabelingJobsOperationsList(name: string, opts?: ProjectsLocationsDataLabelingJobsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsDataLabelingJobsOperationsWait(name: string, opts?: ProjectsLocationsDataLabelingJobsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsAnnotationSpecsGet(name: string, opts?: ProjectsLocationsDatasetsAnnotationSpecsGetOptions): Promise<GoogleCloudAiplatformV1AnnotationSpec>;
async projectsLocationsDatasetsAnnotationSpecsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsDatasetsAnnotationSpecsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsDatasetsAnnotationSpecsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsAnnotationSpecsOperationsList(name: string, opts?: ProjectsLocationsDatasetsAnnotationSpecsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsDatasetsAnnotationSpecsOperationsWait(name: string, opts?: ProjectsLocationsDatasetsAnnotationSpecsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsCreate(parent: string, req: GoogleCloudAiplatformV1Dataset): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsDataItemsAnnotationsList(parent: string, opts?: ProjectsLocationsDatasetsDataItemsAnnotationsListOptions): Promise<GoogleCloudAiplatformV1ListAnnotationsResponse>;
async projectsLocationsDatasetsDataItemsAnnotationsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsDatasetsDataItemsAnnotationsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsDatasetsDataItemsAnnotationsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsDataItemsAnnotationsOperationsList(name: string, opts?: ProjectsLocationsDatasetsDataItemsAnnotationsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsDatasetsDataItemsAnnotationsOperationsWait(name: string, opts?: ProjectsLocationsDatasetsDataItemsAnnotationsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsDataItemsList(parent: string, opts?: ProjectsLocationsDatasetsDataItemsListOptions): Promise<GoogleCloudAiplatformV1ListDataItemsResponse>;
async projectsLocationsDatasetsDataItemsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsDatasetsDataItemsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsDatasetsDataItemsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsDataItemsOperationsList(name: string, opts?: ProjectsLocationsDatasetsDataItemsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsDatasetsDataItemsOperationsWait(name: string, opts?: ProjectsLocationsDatasetsDataItemsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsDatasetVersionsCreate(parent: string, req: GoogleCloudAiplatformV1DatasetVersion): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsDatasetVersionsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsDatasetVersionsGet(name: string, opts?: ProjectsLocationsDatasetsDatasetVersionsGetOptions): Promise<GoogleCloudAiplatformV1DatasetVersion>;
async projectsLocationsDatasetsDatasetVersionsList(parent: string, opts?: ProjectsLocationsDatasetsDatasetVersionsListOptions): Promise<GoogleCloudAiplatformV1ListDatasetVersionsResponse>;
async projectsLocationsDatasetsDatasetVersionsPatch(
name: string,
req: GoogleCloudAiplatformV1DatasetVersion,
opts?: ProjectsLocationsDatasetsDatasetVersionsPatchOptions,
): Promise<GoogleCloudAiplatformV1DatasetVersion>;
async projectsLocationsDatasetsDatasetVersionsRestore(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsExport(name: string, req: GoogleCloudAiplatformV1ExportDataRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsGet(name: string, opts?: ProjectsLocationsDatasetsGetOptions): Promise<GoogleCloudAiplatformV1Dataset>;
async projectsLocationsDatasetsImport(name: string, req: GoogleCloudAiplatformV1ImportDataRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsList(parent: string, opts?: ProjectsLocationsDatasetsListOptions): Promise<GoogleCloudAiplatformV1ListDatasetsResponse>;
async projectsLocationsDatasetsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsDatasetsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsDatasetsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsOperationsList(name: string, opts?: ProjectsLocationsDatasetsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsDatasetsOperationsWait(name: string, opts?: ProjectsLocationsDatasetsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsPatch(
name: string,
req: GoogleCloudAiplatformV1Dataset,
opts?: ProjectsLocationsDatasetsPatchOptions,
): Promise<GoogleCloudAiplatformV1Dataset>;
async projectsLocationsDatasetsSavedQueriesDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsSavedQueriesList(parent: string, opts?: ProjectsLocationsDatasetsSavedQueriesListOptions): Promise<GoogleCloudAiplatformV1ListSavedQueriesResponse>;
async projectsLocationsDatasetsSavedQueriesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsDatasetsSavedQueriesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsDatasetsSavedQueriesOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsSavedQueriesOperationsList(name: string, opts?: ProjectsLocationsDatasetsSavedQueriesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsDatasetsSavedQueriesOperationsWait(name: string, opts?: ProjectsLocationsDatasetsSavedQueriesOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsDatasetsSearchDataItems(dataset: string, opts?: ProjectsLocationsDatasetsSearchDataItemsOptions): Promise<GoogleCloudAiplatformV1SearchDataItemsResponse>;
async projectsLocationsDeploymentResourcePoolsCreate(parent: string, req: GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsDeploymentResourcePoolsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsDeploymentResourcePoolsGet(name: string): Promise<GoogleCloudAiplatformV1DeploymentResourcePool>;
async projectsLocationsDeploymentResourcePoolsList(parent: string, opts?: ProjectsLocationsDeploymentResourcePoolsListOptions): Promise<GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse>;
async projectsLocationsDeploymentResourcePoolsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsDeploymentResourcePoolsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsDeploymentResourcePoolsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsDeploymentResourcePoolsOperationsList(name: string, opts?: ProjectsLocationsDeploymentResourcePoolsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsDeploymentResourcePoolsOperationsWait(name: string, opts?: ProjectsLocationsDeploymentResourcePoolsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsDeploymentResourcePoolsQueryDeployedModels(deploymentResourcePool: string, opts?: ProjectsLocationsDeploymentResourcePoolsQueryDeployedModelsOptions): Promise<GoogleCloudAiplatformV1QueryDeployedModelsResponse>;
async projectsLocationsEndpointsComputeTokens(endpoint: string, req: GoogleCloudAiplatformV1ComputeTokensRequest): Promise<GoogleCloudAiplatformV1ComputeTokensResponse>;
async projectsLocationsEndpointsCountTokens(endpoint: string, req: GoogleCloudAiplatformV1CountTokensRequest): Promise<GoogleCloudAiplatformV1CountTokensResponse>;
async projectsLocationsEndpointsCreate(
parent: string,
req: GoogleCloudAiplatformV1Endpoint,
opts?: ProjectsLocationsEndpointsCreateOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsEndpointsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsEndpointsDeployModel(endpoint: string, req: GoogleCloudAiplatformV1DeployModelRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsEndpointsDirectPredict(endpoint: string, req: GoogleCloudAiplatformV1DirectPredictRequest): Promise<GoogleCloudAiplatformV1DirectPredictResponse>;
async projectsLocationsEndpointsDirectRawPredict(endpoint: string, req: GoogleCloudAiplatformV1DirectRawPredictRequest): Promise<GoogleCloudAiplatformV1DirectRawPredictResponse>;
async projectsLocationsEndpointsExplain(endpoint: string, req: GoogleCloudAiplatformV1ExplainRequest): Promise<GoogleCloudAiplatformV1ExplainResponse>;
async projectsLocationsEndpointsGenerateContent(model: string, req: GoogleCloudAiplatformV1GenerateContentRequest): Promise<GoogleCloudAiplatformV1GenerateContentResponse>;
async projectsLocationsEndpointsGet(name: string): Promise<GoogleCloudAiplatformV1Endpoint>;
async projectsLocationsEndpointsList(parent: string, opts?: ProjectsLocationsEndpointsListOptions): Promise<GoogleCloudAiplatformV1ListEndpointsResponse>;
async projectsLocationsEndpointsMutateDeployedModel(endpoint: string, req: GoogleCloudAiplatformV1MutateDeployedModelRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsEndpointsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsEndpointsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsEndpointsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsEndpointsOperationsList(name: string, opts?: ProjectsLocationsEndpointsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsEndpointsOperationsWait(name: string, opts?: ProjectsLocationsEndpointsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsEndpointsPatch(
name: string,
req: GoogleCloudAiplatformV1Endpoint,
opts?: ProjectsLocationsEndpointsPatchOptions,
): Promise<GoogleCloudAiplatformV1Endpoint>;
async projectsLocationsEndpointsPredict(endpoint: string, req: GoogleCloudAiplatformV1PredictRequest): Promise<GoogleCloudAiplatformV1PredictResponse>;
async projectsLocationsEndpointsRawPredict(endpoint: string, req: GoogleCloudAiplatformV1RawPredictRequest): Promise<GoogleApiHttpBody>;
async projectsLocationsEndpointsServerStreamingPredict(endpoint: string, req: GoogleCloudAiplatformV1StreamingPredictRequest): Promise<GoogleCloudAiplatformV1StreamingPredictResponse>;
async projectsLocationsEndpointsStreamGenerateContent(model: string, req: GoogleCloudAiplatformV1GenerateContentRequest): Promise<GoogleCloudAiplatformV1GenerateContentResponse>;
async projectsLocationsEndpointsStreamRawPredict(endpoint: string, req: GoogleCloudAiplatformV1StreamRawPredictRequest): Promise<GoogleApiHttpBody>;
async projectsLocationsEndpointsUndeployModel(endpoint: string, req: GoogleCloudAiplatformV1UndeployModelRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureGroupsCreate(
parent: string,
req: GoogleCloudAiplatformV1FeatureGroup,
opts?: ProjectsLocationsFeatureGroupsCreateOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureGroupsDelete(name: string, opts?: ProjectsLocationsFeatureGroupsDeleteOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureGroupsFeaturesCreate(
parent: string,
req: GoogleCloudAiplatformV1Feature,
opts?: ProjectsLocationsFeatureGroupsFeaturesCreateOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureGroupsFeaturesDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureGroupsFeaturesGet(name: string): Promise<GoogleCloudAiplatformV1Feature>;
async projectsLocationsFeatureGroupsFeaturesList(parent: string, opts?: ProjectsLocationsFeatureGroupsFeaturesListOptions): Promise<GoogleCloudAiplatformV1ListFeaturesResponse>;
async projectsLocationsFeatureGroupsFeaturesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsFeatureGroupsFeaturesOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureGroupsFeaturesOperationsListWait(name: string, opts?: ProjectsLocationsFeatureGroupsFeaturesOperationsListWaitOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsFeatureGroupsFeaturesOperationsWait(name: string, opts?: ProjectsLocationsFeatureGroupsFeaturesOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureGroupsFeaturesPatch(
name: string,
req: GoogleCloudAiplatformV1Feature,
opts?: ProjectsLocationsFeatureGroupsFeaturesPatchOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureGroupsGet(name: string): Promise<GoogleCloudAiplatformV1FeatureGroup>;
async projectsLocationsFeatureGroupsList(parent: string, opts?: ProjectsLocationsFeatureGroupsListOptions): Promise<GoogleCloudAiplatformV1ListFeatureGroupsResponse>;
async projectsLocationsFeatureGroupsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsFeatureGroupsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureGroupsOperationsListWait(name: string, opts?: ProjectsLocationsFeatureGroupsOperationsListWaitOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsFeatureGroupsOperationsWait(name: string, opts?: ProjectsLocationsFeatureGroupsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureGroupsPatch(
name: string,
req: GoogleCloudAiplatformV1FeatureGroup,
opts?: ProjectsLocationsFeatureGroupsPatchOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureOnlineStoresCreate(
parent: string,
req: GoogleCloudAiplatformV1FeatureOnlineStore,
opts?: ProjectsLocationsFeatureOnlineStoresCreateOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureOnlineStoresDelete(name: string, opts?: ProjectsLocationsFeatureOnlineStoresDeleteOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureOnlineStoresFeatureViewsCreate(
parent: string,
req: GoogleCloudAiplatformV1FeatureView,
opts?: ProjectsLocationsFeatureOnlineStoresFeatureViewsCreateOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureOnlineStoresFeatureViewsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureOnlineStoresFeatureViewsFeatureViewSyncsGet(name: string): Promise<GoogleCloudAiplatformV1FeatureViewSync>;
async projectsLocationsFeatureOnlineStoresFeatureViewsFeatureViewSyncsList(parent: string, opts?: ProjectsLocationsFeatureOnlineStoresFeatureViewsFeatureViewSyncsListOptions): Promise<GoogleCloudAiplatformV1ListFeatureViewSyncsResponse>;
async projectsLocationsFeatureOnlineStoresFeatureViewsFetchFeatureValues(featureView: string, req: GoogleCloudAiplatformV1FetchFeatureValuesRequest): Promise<GoogleCloudAiplatformV1FetchFeatureValuesResponse>;
async projectsLocationsFeatureOnlineStoresFeatureViewsGet(name: string): Promise<GoogleCloudAiplatformV1FeatureView>;
async projectsLocationsFeatureOnlineStoresFeatureViewsList(parent: string, opts?: ProjectsLocationsFeatureOnlineStoresFeatureViewsListOptions): Promise<GoogleCloudAiplatformV1ListFeatureViewsResponse>;
async projectsLocationsFeatureOnlineStoresFeatureViewsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsFeatureOnlineStoresFeatureViewsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureOnlineStoresFeatureViewsOperationsListWait(name: string, opts?: ProjectsLocationsFeatureOnlineStoresFeatureViewsOperationsListWaitOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsFeatureOnlineStoresFeatureViewsOperationsWait(name: string, opts?: ProjectsLocationsFeatureOnlineStoresFeatureViewsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureOnlineStoresFeatureViewsPatch(
name: string,
req: GoogleCloudAiplatformV1FeatureView,
opts?: ProjectsLocationsFeatureOnlineStoresFeatureViewsPatchOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureOnlineStoresFeatureViewsSearchNearestEntities(featureView: string, req: GoogleCloudAiplatformV1SearchNearestEntitiesRequest): Promise<GoogleCloudAiplatformV1SearchNearestEntitiesResponse>;
async projectsLocationsFeatureOnlineStoresFeatureViewsSync(featureView: string, req: GoogleCloudAiplatformV1SyncFeatureViewRequest): Promise<GoogleCloudAiplatformV1SyncFeatureViewResponse>;
async projectsLocationsFeatureOnlineStoresGet(name: string): Promise<GoogleCloudAiplatformV1FeatureOnlineStore>;
async projectsLocationsFeatureOnlineStoresList(parent: string, opts?: ProjectsLocationsFeatureOnlineStoresListOptions): Promise<GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse>;
async projectsLocationsFeatureOnlineStoresOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsFeatureOnlineStoresOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureOnlineStoresOperationsListWait(name: string, opts?: ProjectsLocationsFeatureOnlineStoresOperationsListWaitOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsFeatureOnlineStoresOperationsWait(name: string, opts?: ProjectsLocationsFeatureOnlineStoresOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeatureOnlineStoresPatch(
name: string,
req: GoogleCloudAiplatformV1FeatureOnlineStore,
opts?: ProjectsLocationsFeatureOnlineStoresPatchOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresBatchReadFeatureValues(featurestore: string, req: GoogleCloudAiplatformV1BatchReadFeatureValuesRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresCreate(
parent: string,
req: GoogleCloudAiplatformV1Featurestore,
opts?: ProjectsLocationsFeaturestoresCreateOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresDelete(name: string, opts?: ProjectsLocationsFeaturestoresDeleteOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresEntityTypesCreate(
parent: string,
req: GoogleCloudAiplatformV1EntityType,
opts?: ProjectsLocationsFeaturestoresEntityTypesCreateOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresEntityTypesDelete(name: string, opts?: ProjectsLocationsFeaturestoresEntityTypesDeleteOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresEntityTypesDeleteFeatureValues(entityType: string, req: GoogleCloudAiplatformV1DeleteFeatureValuesRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresEntityTypesExportFeatureValues(entityType: string, req: GoogleCloudAiplatformV1ExportFeatureValuesRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresEntityTypesFeaturesBatchCreate(parent: string, req: GoogleCloudAiplatformV1BatchCreateFeaturesRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresEntityTypesFeaturesCreate(
parent: string,
req: GoogleCloudAiplatformV1Feature,
opts?: ProjectsLocationsFeaturestoresEntityTypesFeaturesCreateOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresEntityTypesFeaturesDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresEntityTypesFeaturesGet(name: string): Promise<GoogleCloudAiplatformV1Feature>;
async projectsLocationsFeaturestoresEntityTypesFeaturesList(parent: string, opts?: ProjectsLocationsFeaturestoresEntityTypesFeaturesListOptions): Promise<GoogleCloudAiplatformV1ListFeaturesResponse>;
async projectsLocationsFeaturestoresEntityTypesFeaturesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsFeaturestoresEntityTypesFeaturesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsFeaturestoresEntityTypesFeaturesOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresEntityTypesFeaturesOperationsList(name: string, opts?: ProjectsLocationsFeaturestoresEntityTypesFeaturesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsFeaturestoresEntityTypesFeaturesOperationsWait(name: string, opts?: ProjectsLocationsFeaturestoresEntityTypesFeaturesOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresEntityTypesFeaturesPatch(
name: string,
req: GoogleCloudAiplatformV1Feature,
opts?: ProjectsLocationsFeaturestoresEntityTypesFeaturesPatchOptions,
): Promise<GoogleCloudAiplatformV1Feature>;
async projectsLocationsFeaturestoresEntityTypesGet(name: string): Promise<GoogleCloudAiplatformV1EntityType>;
async projectsLocationsFeaturestoresEntityTypesGetIamPolicy(resource: string, opts?: ProjectsLocationsFeaturestoresEntityTypesGetIamPolicyOptions): Promise<GoogleIamV1Policy>;
async projectsLocationsFeaturestoresEntityTypesImportFeatureValues(entityType: string, req: GoogleCloudAiplatformV1ImportFeatureValuesRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresEntityTypesList(parent: string, opts?: ProjectsLocationsFeaturestoresEntityTypesListOptions): Promise<GoogleCloudAiplatformV1ListEntityTypesResponse>;
async projectsLocationsFeaturestoresEntityTypesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsFeaturestoresEntityTypesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsFeaturestoresEntityTypesOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresEntityTypesOperationsList(name: string, opts?: ProjectsLocationsFeaturestoresEntityTypesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsFeaturestoresEntityTypesOperationsWait(name: string, opts?: ProjectsLocationsFeaturestoresEntityTypesOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresEntityTypesPatch(
name: string,
req: GoogleCloudAiplatformV1EntityType,
opts?: ProjectsLocationsFeaturestoresEntityTypesPatchOptions,
): Promise<GoogleCloudAiplatformV1EntityType>;
async projectsLocationsFeaturestoresEntityTypesReadFeatureValues(entityType: string, req: GoogleCloudAiplatformV1ReadFeatureValuesRequest): Promise<GoogleCloudAiplatformV1ReadFeatureValuesResponse>;
async projectsLocationsFeaturestoresEntityTypesSetIamPolicy(resource: string, req: GoogleIamV1SetIamPolicyRequest): Promise<GoogleIamV1Policy>;
async projectsLocationsFeaturestoresEntityTypesStreamingReadFeatureValues(entityType: string, req: GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest): Promise<GoogleCloudAiplatformV1ReadFeatureValuesResponse>;
async projectsLocationsFeaturestoresEntityTypesTestIamPermissions(resource: string, opts?: ProjectsLocationsFeaturestoresEntityTypesTestIamPermissionsOptions): Promise<GoogleIamV1TestIamPermissionsResponse>;
async projectsLocationsFeaturestoresEntityTypesWriteFeatureValues(entityType: string, req: GoogleCloudAiplatformV1WriteFeatureValuesRequest): Promise<GoogleCloudAiplatformV1WriteFeatureValuesResponse>;
async projectsLocationsFeaturestoresGet(name: string): Promise<GoogleCloudAiplatformV1Featurestore>;
async projectsLocationsFeaturestoresGetIamPolicy(resource: string, opts?: ProjectsLocationsFeaturestoresGetIamPolicyOptions): Promise<GoogleIamV1Policy>;
async projectsLocationsFeaturestoresList(parent: string, opts?: ProjectsLocationsFeaturestoresListOptions): Promise<GoogleCloudAiplatformV1ListFeaturestoresResponse>;
async projectsLocationsFeaturestoresOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsFeaturestoresOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsFeaturestoresOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresOperationsList(name: string, opts?: ProjectsLocationsFeaturestoresOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsFeaturestoresOperationsWait(name: string, opts?: ProjectsLocationsFeaturestoresOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresPatch(
name: string,
req: GoogleCloudAiplatformV1Featurestore,
opts?: ProjectsLocationsFeaturestoresPatchOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsFeaturestoresSearchFeatures(location: string, opts?: ProjectsLocationsFeaturestoresSearchFeaturesOptions): Promise<GoogleCloudAiplatformV1SearchFeaturesResponse>;
async projectsLocationsFeaturestoresSetIamPolicy(resource: string, req: GoogleIamV1SetIamPolicyRequest): Promise<GoogleIamV1Policy>;
async projectsLocationsFeaturestoresTestIamPermissions(resource: string, opts?: ProjectsLocationsFeaturestoresTestIamPermissionsOptions): Promise<GoogleIamV1TestIamPermissionsResponse>;
async projectsLocationsGet(name: string): Promise<GoogleCloudLocationLocation>;
async projectsLocationsHyperparameterTuningJobsCancel(name: string, req: GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest): Promise<GoogleProtobufEmpty>;
async projectsLocationsHyperparameterTuningJobsCreate(parent: string, req: GoogleCloudAiplatformV1HyperparameterTuningJob): Promise<GoogleCloudAiplatformV1HyperparameterTuningJob>;
async projectsLocationsHyperparameterTuningJobsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsHyperparameterTuningJobsGet(name: string): Promise<GoogleCloudAiplatformV1HyperparameterTuningJob>;
async projectsLocationsHyperparameterTuningJobsList(parent: string, opts?: ProjectsLocationsHyperparameterTuningJobsListOptions): Promise<GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse>;
async projectsLocationsHyperparameterTuningJobsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsHyperparameterTuningJobsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsHyperparameterTuningJobsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsHyperparameterTuningJobsOperationsList(name: string, opts?: ProjectsLocationsHyperparameterTuningJobsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsHyperparameterTuningJobsOperationsWait(name: string, opts?: ProjectsLocationsHyperparameterTuningJobsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsIndexEndpointsCreate(parent: string, req: GoogleCloudAiplatformV1IndexEndpoint): Promise<GoogleLongrunningOperation>;
async projectsLocationsIndexEndpointsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsIndexEndpointsDeployIndex(indexEndpoint: string, req: GoogleCloudAiplatformV1DeployIndexRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsIndexEndpointsFindNeighbors(indexEndpoint: string, req: GoogleCloudAiplatformV1FindNeighborsRequest): Promise<GoogleCloudAiplatformV1FindNeighborsResponse>;
async projectsLocationsIndexEndpointsGet(name: string): Promise<GoogleCloudAiplatformV1IndexEndpoint>;
async projectsLocationsIndexEndpointsList(parent: string, opts?: ProjectsLocationsIndexEndpointsListOptions): Promise<GoogleCloudAiplatformV1ListIndexEndpointsResponse>;
async projectsLocationsIndexEndpointsMutateDeployedIndex(indexEndpoint: string, req: GoogleCloudAiplatformV1DeployedIndex): Promise<GoogleLongrunningOperation>;
async projectsLocationsIndexEndpointsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsIndexEndpointsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsIndexEndpointsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsIndexEndpointsOperationsList(name: string, opts?: ProjectsLocationsIndexEndpointsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsIndexEndpointsOperationsWait(name: string, opts?: ProjectsLocationsIndexEndpointsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsIndexEndpointsPatch(
name: string,
req: GoogleCloudAiplatformV1IndexEndpoint,
opts?: ProjectsLocationsIndexEndpointsPatchOptions,
): Promise<GoogleCloudAiplatformV1IndexEndpoint>;
async projectsLocationsIndexEndpointsReadIndexDatapoints(indexEndpoint: string, req: GoogleCloudAiplatformV1ReadIndexDatapointsRequest): Promise<GoogleCloudAiplatformV1ReadIndexDatapointsResponse>;
async projectsLocationsIndexEndpointsUndeployIndex(indexEndpoint: string, req: GoogleCloudAiplatformV1UndeployIndexRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsIndexesCreate(parent: string, req: GoogleCloudAiplatformV1Index): Promise<GoogleLongrunningOperation>;
async projectsLocationsIndexesDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsIndexesGet(name: string): Promise<GoogleCloudAiplatformV1Index>;
async projectsLocationsIndexesList(parent: string, opts?: ProjectsLocationsIndexesListOptions): Promise<GoogleCloudAiplatformV1ListIndexesResponse>;
async projectsLocationsIndexesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsIndexesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsIndexesOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsIndexesOperationsList(name: string, opts?: ProjectsLocationsIndexesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsIndexesOperationsWait(name: string, opts?: ProjectsLocationsIndexesOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsIndexesPatch(
name: string,
req: GoogleCloudAiplatformV1Index,
opts?: ProjectsLocationsIndexesPatchOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsIndexesRemoveDatapoints(index: string, req: GoogleCloudAiplatformV1RemoveDatapointsRequest): Promise<GoogleCloudAiplatformV1RemoveDatapointsResponse>;
async projectsLocationsIndexesUpsertDatapoints(index: string, req: GoogleCloudAiplatformV1UpsertDatapointsRequest): Promise<GoogleCloudAiplatformV1UpsertDatapointsResponse>;
async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<GoogleCloudLocationListLocationsResponse>;
async projectsLocationsMetadataStoresArtifactsCreate(
parent: string,
req: GoogleCloudAiplatformV1Artifact,
opts?: ProjectsLocationsMetadataStoresArtifactsCreateOptions,
): Promise<GoogleCloudAiplatformV1Artifact>;
async projectsLocationsMetadataStoresArtifactsDelete(name: string, opts?: ProjectsLocationsMetadataStoresArtifactsDeleteOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsMetadataStoresArtifactsGet(name: string): Promise<GoogleCloudAiplatformV1Artifact>;
async projectsLocationsMetadataStoresArtifactsList(parent: string, opts?: ProjectsLocationsMetadataStoresArtifactsListOptions): Promise<GoogleCloudAiplatformV1ListArtifactsResponse>;
async projectsLocationsMetadataStoresArtifactsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsMetadataStoresArtifactsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsMetadataStoresArtifactsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsMetadataStoresArtifactsOperationsList(name: string, opts?: ProjectsLocationsMetadataStoresArtifactsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsMetadataStoresArtifactsOperationsWait(name: string, opts?: ProjectsLocationsMetadataStoresArtifactsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsMetadataStoresArtifactsPatch(
name: string,
req: GoogleCloudAiplatformV1Artifact,
opts?: ProjectsLocationsMetadataStoresArtifactsPatchOptions,
): Promise<GoogleCloudAiplatformV1Artifact>;
async projectsLocationsMetadataStoresArtifactsPurge(parent: string, req: GoogleCloudAiplatformV1PurgeArtifactsRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsMetadataStoresArtifactsQueryArtifactLineageSubgraph(artifact: string, opts?: ProjectsLocationsMetadataStoresArtifactsQueryArtifactLineageSubgraphOptions): Promise<GoogleCloudAiplatformV1LineageSubgraph>;
async projectsLocationsMetadataStoresContextsAddContextArtifactsAndExecutions(context: string, req: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest): Promise<GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse>;
async projectsLocationsMetadataStoresContextsAddContextChildren(context: string, req: GoogleCloudAiplatformV1AddContextChildrenRequest): Promise<GoogleCloudAiplatformV1AddContextChildrenResponse>;
async projectsLocationsMetadataStoresContextsCreate(
parent: string,
req: GoogleCloudAiplatformV1Context,
opts?: ProjectsLocationsMetadataStoresContextsCreateOptions,
): Promise<GoogleCloudAiplatformV1Context>;
async projectsLocationsMetadataStoresContextsDelete(name: string, opts?: ProjectsLocationsMetadataStoresContextsDeleteOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsMetadataStoresContextsGet(name: string): Promise<GoogleCloudAiplatformV1Context>;
async projectsLocationsMetadataStoresContextsList(parent: string, opts?: ProjectsLocationsMetadataStoresContextsListOptions): Promise<GoogleCloudAiplatformV1ListContextsResponse>;
async projectsLocationsMetadataStoresContextsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsMetadataStoresContextsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsMetadataStoresContextsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsMetadataStoresContextsOperationsList(name: string, opts?: ProjectsLocationsMetadataStoresContextsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsMetadataStoresContextsOperationsWait(name: string, opts?: ProjectsLocationsMetadataStoresContextsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsMetadataStoresContextsPatch(
name: string,
req: GoogleCloudAiplatformV1Context,
opts?: ProjectsLocationsMetadataStoresContextsPatchOptions,
): Promise<GoogleCloudAiplatformV1Context>;
async projectsLocationsMetadataStoresContextsPurge(parent: string, req: GoogleCloudAiplatformV1PurgeContextsRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsMetadataStoresContextsQueryContextLineageSubgraph(context: string): Promise<GoogleCloudAiplatformV1LineageSubgraph>;
async projectsLocationsMetadataStoresContextsRemoveContextChildren(context: string, req: GoogleCloudAiplatformV1RemoveContextChildrenRequest): Promise<GoogleCloudAiplatformV1RemoveContextChildrenResponse>;
async projectsLocationsMetadataStoresCreate(
parent: string,
req: GoogleCloudAiplatformV1MetadataStore,
opts?: ProjectsLocationsMetadataStoresCreateOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsMetadataStoresDelete(name: string, opts?: ProjectsLocationsMetadataStoresDeleteOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsMetadataStoresExecutionsAddExecutionEvents(execution: string, req: GoogleCloudAiplatformV1AddExecutionEventsRequest): Promise<GoogleCloudAiplatformV1AddExecutionEventsResponse>;
async projectsLocationsMetadataStoresExecutionsCreate(
parent: string,
req: GoogleCloudAiplatformV1Execution,
opts?: ProjectsLocationsMetadataStoresExecutionsCreateOptions,
): Promise<GoogleCloudAiplatformV1Execution>;
async projectsLocationsMetadataStoresExecutionsDelete(name: string, opts?: ProjectsLocationsMetadataStoresExecutionsDeleteOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsMetadataStoresExecutionsGet(name: string): Promise<GoogleCloudAiplatformV1Execution>;
async projectsLocationsMetadataStoresExecutionsList(parent: string, opts?: ProjectsLocationsMetadataStoresExecutionsListOptions): Promise<GoogleCloudAiplatformV1ListExecutionsResponse>;
async projectsLocationsMetadataStoresExecutionsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsMetadataStoresExecutionsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsMetadataStoresExecutionsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsMetadataStoresExecutionsOperationsList(name: string, opts?: ProjectsLocationsMetadataStoresExecutionsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsMetadataStoresExecutionsOperationsWait(name: string, opts?: ProjectsLocationsMetadataStoresExecutionsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsMetadataStoresExecutionsPatch(
name: string,
req: GoogleCloudAiplatformV1Execution,
opts?: ProjectsLocationsMetadataStoresExecutionsPatchOptions,
): Promise<GoogleCloudAiplatformV1Execution>;
async projectsLocationsMetadataStoresExecutionsPurge(parent: string, req: GoogleCloudAiplatformV1PurgeExecutionsRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsMetadataStoresExecutionsQueryExecutionInputsAndOutputs(execution: string): Promise<GoogleCloudAiplatformV1LineageSubgraph>;
async projectsLocationsMetadataStoresGet(name: string): Promise<GoogleCloudAiplatformV1MetadataStore>;
async projectsLocationsMetadataStoresList(parent: string, opts?: ProjectsLocationsMetadataStoresListOptions): Promise<GoogleCloudAiplatformV1ListMetadataStoresResponse>;
async projectsLocationsMetadataStoresMetadataSchemasCreate(
parent: string,
req: GoogleCloudAiplatformV1MetadataSchema,
opts?: ProjectsLocationsMetadataStoresMetadataSchemasCreateOptions,
): Promise<GoogleCloudAiplatformV1MetadataSchema>;
async projectsLocationsMetadataStoresMetadataSchemasGet(name: string): Promise<GoogleCloudAiplatformV1MetadataSchema>;
async projectsLocationsMetadataStoresMetadataSchemasList(parent: string, opts?: ProjectsLocationsMetadataStoresMetadataSchemasListOptions): Promise<GoogleCloudAiplatformV1ListMetadataSchemasResponse>;
async projectsLocationsMetadataStoresOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsMetadataStoresOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsMetadataStoresOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsMetadataStoresOperationsList(name: string, opts?: ProjectsLocationsMetadataStoresOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsMetadataStoresOperationsWait(name: string, opts?: ProjectsLocationsMetadataStoresOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsMigratableResourcesBatchMigrate(parent: string, req: GoogleCloudAiplatformV1BatchMigrateResourcesRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsMigratableResourcesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsMigratableResourcesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsMigratableResourcesOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsMigratableResourcesOperationsList(name: string, opts?: ProjectsLocationsMigratableResourcesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsMigratableResourcesOperationsWait(name: string, opts?: ProjectsLocationsMigratableResourcesOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsMigratableResourcesSearch(parent: string, req: GoogleCloudAiplatformV1SearchMigratableResourcesRequest): Promise<GoogleCloudAiplatformV1SearchMigratableResourcesResponse>;
async projectsLocationsModelDeploymentMonitoringJobsCreate(parent: string, req: GoogleCloudAiplatformV1ModelDeploymentMonitoringJob): Promise<GoogleCloudAiplatformV1ModelDeploymentMonitoringJob>;
async projectsLocationsModelDeploymentMonitoringJobsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsModelDeploymentMonitoringJobsGet(name: string): Promise<GoogleCloudAiplatformV1ModelDeploymentMonitoringJob>;
async projectsLocationsModelDeploymentMonitoringJobsList(parent: string, opts?: ProjectsLocationsModelDeploymentMonitoringJobsListOptions): Promise<GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse>;
async projectsLocationsModelDeploymentMonitoringJobsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsModelDeploymentMonitoringJobsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsModelDeploymentMonitoringJobsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsModelDeploymentMonitoringJobsOperationsList(name: string, opts?: ProjectsLocationsModelDeploymentMonitoringJobsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsModelDeploymentMonitoringJobsOperationsWait(name: string, opts?: ProjectsLocationsModelDeploymentMonitoringJobsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsModelDeploymentMonitoringJobsPatch(
name: string,
req: GoogleCloudAiplatformV1ModelDeploymentMonitoringJob,
opts?: ProjectsLocationsModelDeploymentMonitoringJobsPatchOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsModelDeploymentMonitoringJobsPause(name: string, req: GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest): Promise<GoogleProtobufEmpty>;
async projectsLocationsModelDeploymentMonitoringJobsResume(name: string, req: GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest): Promise<GoogleProtobufEmpty>;
async projectsLocationsModelDeploymentMonitoringJobsSearchModelDeploymentMonitoringStatsAnomalies(modelDeploymentMonitoringJob: string, req: GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest): Promise<GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse>;
async projectsLocationsModelsCopy(parent: string, req: GoogleCloudAiplatformV1CopyModelRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsModelsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsModelsDeleteVersion(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsModelsEvaluationsGet(name: string): Promise<GoogleCloudAiplatformV1ModelEvaluation>;
async projectsLocationsModelsEvaluationsImport(parent: string, req: GoogleCloudAiplatformV1ImportModelEvaluationRequest): Promise<GoogleCloudAiplatformV1ModelEvaluation>;
async projectsLocationsModelsEvaluationsList(parent: string, opts?: ProjectsLocationsModelsEvaluationsListOptions): Promise<GoogleCloudAiplatformV1ListModelEvaluationsResponse>;
async projectsLocationsModelsEvaluationsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsModelsEvaluationsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsModelsEvaluationsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsModelsEvaluationsOperationsList(name: string, opts?: ProjectsLocationsModelsEvaluationsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsModelsEvaluationsOperationsWait(name: string, opts?: ProjectsLocationsModelsEvaluationsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsModelsEvaluationsSlicesBatchImport(parent: string, req: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest): Promise<GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse>;
async projectsLocationsModelsEvaluationsSlicesGet(name: string): Promise<GoogleCloudAiplatformV1ModelEvaluationSlice>;
async projectsLocationsModelsEvaluationsSlicesList(parent: string, opts?: ProjectsLocationsModelsEvaluationsSlicesListOptions): Promise<GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse>;
async projectsLocationsModelsExport(name: string, req: GoogleCloudAiplatformV1ExportModelRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsModelsGet(name: string): Promise<GoogleCloudAiplatformV1Model>;
async projectsLocationsModelsGetIamPolicy(resource: string, opts?: ProjectsLocationsModelsGetIamPolicyOptions): Promise<GoogleIamV1Policy>;
async projectsLocationsModelsList(parent: string, opts?: ProjectsLocationsModelsListOptions): Promise<GoogleCloudAiplatformV1ListModelsResponse>;
async projectsLocationsModelsListVersions(name: string, opts?: ProjectsLocationsModelsListVersionsOptions): Promise<GoogleCloudAiplatformV1ListModelVersionsResponse>;
async projectsLocationsModelsMergeVersionAliases(name: string, req: GoogleCloudAiplatformV1MergeVersionAliasesRequest): Promise<GoogleCloudAiplatformV1Model>;
async projectsLocationsModelsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsModelsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsModelsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsModelsOperationsList(name: string, opts?: ProjectsLocationsModelsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsModelsOperationsWait(name: string, opts?: ProjectsLocationsModelsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsModelsPatch(
name: string,
req: GoogleCloudAiplatformV1Model,
opts?: ProjectsLocationsModelsPatchOptions,
): Promise<GoogleCloudAiplatformV1Model>;
async projectsLocationsModelsSetIamPolicy(resource: string, req: GoogleIamV1SetIamPolicyRequest): Promise<GoogleIamV1Policy>;
async projectsLocationsModelsTestIamPermissions(resource: string, opts?: ProjectsLocationsModelsTestIamPermissionsOptions): Promise<GoogleIamV1TestIamPermissionsResponse>;
async projectsLocationsModelsUpdateExplanationDataset(model: string, req: GoogleCloudAiplatformV1UpdateExplanationDatasetRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsModelsUpload(parent: string, req: GoogleCloudAiplatformV1UploadModelRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsNasJobsCancel(name: string, req: GoogleCloudAiplatformV1CancelNasJobRequest): Promise<GoogleProtobufEmpty>;
async projectsLocationsNasJobsCreate(parent: string, req: GoogleCloudAiplatformV1NasJob): Promise<GoogleCloudAiplatformV1NasJob>;
async projectsLocationsNasJobsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsNasJobsGet(name: string): Promise<GoogleCloudAiplatformV1NasJob>;
async projectsLocationsNasJobsList(parent: string, opts?: ProjectsLocationsNasJobsListOptions): Promise<GoogleCloudAiplatformV1ListNasJobsResponse>;
async projectsLocationsNasJobsNasTrialDetailsGet(name: string): Promise<GoogleCloudAiplatformV1NasTrialDetail>;
async projectsLocationsNasJobsNasTrialDetailsList(parent: string, opts?: ProjectsLocationsNasJobsNasTrialDetailsListOptions): Promise<GoogleCloudAiplatformV1ListNasTrialDetailsResponse>;
async projectsLocationsNotebookRuntimesAssign(parent: string, req: GoogleCloudAiplatformV1AssignNotebookRuntimeRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsNotebookRuntimesDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsNotebookRuntimesGet(name: string): Promise<GoogleCloudAiplatformV1NotebookRuntime>;
async projectsLocationsNotebookRuntimesList(parent: string, opts?: ProjectsLocationsNotebookRuntimesListOptions): Promise<GoogleCloudAiplatformV1ListNotebookRuntimesResponse>;
async projectsLocationsNotebookRuntimesStart(name: string, req: GoogleCloudAiplatformV1StartNotebookRuntimeRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsNotebookRuntimesUpgrade(name: string, req: GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsNotebookRuntimeTemplatesCreate(
parent: string,
req: GoogleCloudAiplatformV1NotebookRuntimeTemplate,
opts?: ProjectsLocationsNotebookRuntimeTemplatesCreateOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsNotebookRuntimeTemplatesDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsNotebookRuntimeTemplatesGet(name: string): Promise<GoogleCloudAiplatformV1NotebookRuntimeTemplate>;
async projectsLocationsNotebookRuntimeTemplatesGetIamPolicy(resource: string, opts?: ProjectsLocationsNotebookRuntimeTemplatesGetIamPolicyOptions): Promise<GoogleIamV1Policy>;
async projectsLocationsNotebookRuntimeTemplatesList(parent: string, opts?: ProjectsLocationsNotebookRuntimeTemplatesListOptions): Promise<GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse>;
async projectsLocationsNotebookRuntimeTemplatesSetIamPolicy(resource: string, req: GoogleIamV1SetIamPolicyRequest): Promise<GoogleIamV1Policy>;
async projectsLocationsNotebookRuntimeTemplatesTestIamPermissions(resource: string, opts?: ProjectsLocationsNotebookRuntimeTemplatesTestIamPermissionsOptions): Promise<GoogleIamV1TestIamPermissionsResponse>;
async projectsLocationsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsOperationsWait(name: string, opts?: ProjectsLocationsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsPersistentResourcesCreate(
parent: string,
req: GoogleCloudAiplatformV1PersistentResource,
opts?: ProjectsLocationsPersistentResourcesCreateOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsPersistentResourcesDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsPersistentResourcesGet(name: string): Promise<GoogleCloudAiplatformV1PersistentResource>;
async projectsLocationsPersistentResourcesList(parent: string, opts?: ProjectsLocationsPersistentResourcesListOptions): Promise<GoogleCloudAiplatformV1ListPersistentResourcesResponse>;
async projectsLocationsPersistentResourcesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsPersistentResourcesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsPersistentResourcesOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsPersistentResourcesOperationsList(name: string, opts?: ProjectsLocationsPersistentResourcesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsPersistentResourcesOperationsWait(name: string, opts?: ProjectsLocationsPersistentResourcesOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsPersistentResourcesPatch(
name: string,
req: GoogleCloudAiplatformV1PersistentResource,
opts?: ProjectsLocationsPersistentResourcesPatchOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsPersistentResourcesReboot(name: string, req: GoogleCloudAiplatformV1RebootPersistentResourceRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsPipelineJobsBatchCancel(parent: string, req: GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsPipelineJobsBatchDelete(parent: string, req: GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsPipelineJobsCancel(name: string, req: GoogleCloudAiplatformV1CancelPipelineJobRequest): Promise<GoogleProtobufEmpty>;
async projectsLocationsPipelineJobsCreate(
parent: string,
req: GoogleCloudAiplatformV1PipelineJob,
opts?: ProjectsLocationsPipelineJobsCreateOptions,
): Promise<GoogleCloudAiplatformV1PipelineJob>;
async projectsLocationsPipelineJobsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsPipelineJobsGet(name: string): Promise<GoogleCloudAiplatformV1PipelineJob>;
async projectsLocationsPipelineJobsList(parent: string, opts?: ProjectsLocationsPipelineJobsListOptions): Promise<GoogleCloudAiplatformV1ListPipelineJobsResponse>;
async projectsLocationsPipelineJobsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsPipelineJobsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsPipelineJobsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsPipelineJobsOperationsList(name: string, opts?: ProjectsLocationsPipelineJobsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsPipelineJobsOperationsWait(name: string, opts?: ProjectsLocationsPipelineJobsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsPublishersModelsComputeTokens(endpoint: string, req: GoogleCloudAiplatformV1ComputeTokensRequest): Promise<GoogleCloudAiplatformV1ComputeTokensResponse>;
async projectsLocationsPublishersModelsCountTokens(endpoint: string, req: GoogleCloudAiplatformV1CountTokensRequest): Promise<GoogleCloudAiplatformV1CountTokensResponse>;
async projectsLocationsPublishersModelsGenerateContent(model: string, req: GoogleCloudAiplatformV1GenerateContentRequest): Promise<GoogleCloudAiplatformV1GenerateContentResponse>;
async projectsLocationsPublishersModelsPredict(endpoint: string, req: GoogleCloudAiplatformV1PredictRequest): Promise<GoogleCloudAiplatformV1PredictResponse>;
async projectsLocationsPublishersModelsRawPredict(endpoint: string, req: GoogleCloudAiplatformV1RawPredictRequest): Promise<GoogleApiHttpBody>;
async projectsLocationsPublishersModelsServerStreamingPredict(endpoint: string, req: GoogleCloudAiplatformV1StreamingPredictRequest): Promise<GoogleCloudAiplatformV1StreamingPredictResponse>;
async projectsLocationsPublishersModelsStreamGenerateContent(model: string, req: GoogleCloudAiplatformV1GenerateContentRequest): Promise<GoogleCloudAiplatformV1GenerateContentResponse>;
async projectsLocationsPublishersModelsStreamRawPredict(endpoint: string, req: GoogleCloudAiplatformV1StreamRawPredictRequest): Promise<GoogleApiHttpBody>;
async projectsLocationsSchedulesCreate(parent: string, req: GoogleCloudAiplatformV1Schedule): Promise<GoogleCloudAiplatformV1Schedule>;
async projectsLocationsSchedulesDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsSchedulesGet(name: string): Promise<GoogleCloudAiplatformV1Schedule>;
async projectsLocationsSchedulesList(parent: string, opts?: ProjectsLocationsSchedulesListOptions): Promise<GoogleCloudAiplatformV1ListSchedulesResponse>;
async projectsLocationsSchedulesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsSchedulesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsSchedulesOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsSchedulesOperationsList(name: string, opts?: ProjectsLocationsSchedulesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsSchedulesOperationsWait(name: string, opts?: ProjectsLocationsSchedulesOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsSchedulesPatch(
name: string,
req: GoogleCloudAiplatformV1Schedule,
opts?: ProjectsLocationsSchedulesPatchOptions,
): Promise<GoogleCloudAiplatformV1Schedule>;
async projectsLocationsSchedulesPause(name: string, req: GoogleCloudAiplatformV1PauseScheduleRequest): Promise<GoogleProtobufEmpty>;
async projectsLocationsSchedulesResume(name: string, req: GoogleCloudAiplatformV1ResumeScheduleRequest): Promise<GoogleProtobufEmpty>;
async projectsLocationsSpecialistPoolsCreate(parent: string, req: GoogleCloudAiplatformV1SpecialistPool): Promise<GoogleLongrunningOperation>;
async projectsLocationsSpecialistPoolsDelete(name: string, opts?: ProjectsLocationsSpecialistPoolsDeleteOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsSpecialistPoolsGet(name: string): Promise<GoogleCloudAiplatformV1SpecialistPool>;
async projectsLocationsSpecialistPoolsList(parent: string, opts?: ProjectsLocationsSpecialistPoolsListOptions): Promise<GoogleCloudAiplatformV1ListSpecialistPoolsResponse>;
async projectsLocationsSpecialistPoolsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsSpecialistPoolsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsSpecialistPoolsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsSpecialistPoolsOperationsList(name: string, opts?: ProjectsLocationsSpecialistPoolsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsSpecialistPoolsOperationsWait(name: string, opts?: ProjectsLocationsSpecialistPoolsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsSpecialistPoolsPatch(
name: string,
req: GoogleCloudAiplatformV1SpecialistPool,
opts?: ProjectsLocationsSpecialistPoolsPatchOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsStudiesCreate(parent: string, req: GoogleCloudAiplatformV1Study): Promise<GoogleCloudAiplatformV1Study>;
async projectsLocationsStudiesDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsStudiesGet(name: string): Promise<GoogleCloudAiplatformV1Study>;
async projectsLocationsStudiesList(parent: string, opts?: ProjectsLocationsStudiesListOptions): Promise<GoogleCloudAiplatformV1ListStudiesResponse>;
async projectsLocationsStudiesLookup(parent: string, req: GoogleCloudAiplatformV1LookupStudyRequest): Promise<GoogleCloudAiplatformV1Study>;
async projectsLocationsStudiesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsStudiesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsStudiesOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsStudiesOperationsList(name: string, opts?: ProjectsLocationsStudiesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsStudiesOperationsWait(name: string, opts?: ProjectsLocationsStudiesOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsStudiesTrialsAddTrialMeasurement(trialName: string, req: GoogleCloudAiplatformV1AddTrialMeasurementRequest): Promise<GoogleCloudAiplatformV1Trial>;
async projectsLocationsStudiesTrialsCheckTrialEarlyStoppingState(trialName: string, req: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsStudiesTrialsComplete(name: string, req: GoogleCloudAiplatformV1CompleteTrialRequest): Promise<GoogleCloudAiplatformV1Trial>;
async projectsLocationsStudiesTrialsCreate(parent: string, req: GoogleCloudAiplatformV1Trial): Promise<GoogleCloudAiplatformV1Trial>;
async projectsLocationsStudiesTrialsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsStudiesTrialsGet(name: string): Promise<GoogleCloudAiplatformV1Trial>;
async projectsLocationsStudiesTrialsList(parent: string, opts?: ProjectsLocationsStudiesTrialsListOptions): Promise<GoogleCloudAiplatformV1ListTrialsResponse>;
async projectsLocationsStudiesTrialsListOptimalTrials(parent: string, req: GoogleCloudAiplatformV1ListOptimalTrialsRequest): Promise<GoogleCloudAiplatformV1ListOptimalTrialsResponse>;
async projectsLocationsStudiesTrialsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsStudiesTrialsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsStudiesTrialsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsStudiesTrialsOperationsList(name: string, opts?: ProjectsLocationsStudiesTrialsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsStudiesTrialsOperationsWait(name: string, opts?: ProjectsLocationsStudiesTrialsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsStudiesTrialsStop(name: string, req: GoogleCloudAiplatformV1StopTrialRequest): Promise<GoogleCloudAiplatformV1Trial>;
async projectsLocationsStudiesTrialsSuggest(parent: string, req: GoogleCloudAiplatformV1SuggestTrialsRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsTensorboardsBatchRead(tensorboard: string, opts?: ProjectsLocationsTensorboardsBatchReadOptions): Promise<GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse>;
async projectsLocationsTensorboardsCreate(parent: string, req: GoogleCloudAiplatformV1Tensorboard): Promise<GoogleLongrunningOperation>;
async projectsLocationsTensorboardsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsTensorboardsExperimentsBatchCreate(parent: string, req: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest): Promise<GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse>;
async projectsLocationsTensorboardsExperimentsCreate(
parent: string,
req: GoogleCloudAiplatformV1TensorboardExperiment,
opts?: ProjectsLocationsTensorboardsExperimentsCreateOptions,
): Promise<GoogleCloudAiplatformV1TensorboardExperiment>;
async projectsLocationsTensorboardsExperimentsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsTensorboardsExperimentsGet(name: string): Promise<GoogleCloudAiplatformV1TensorboardExperiment>;
async projectsLocationsTensorboardsExperimentsList(parent: string, opts?: ProjectsLocationsTensorboardsExperimentsListOptions): Promise<GoogleCloudAiplatformV1ListTensorboardExperimentsResponse>;
async projectsLocationsTensorboardsExperimentsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsTensorboardsExperimentsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsTensorboardsExperimentsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsTensorboardsExperimentsOperationsList(name: string, opts?: ProjectsLocationsTensorboardsExperimentsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsTensorboardsExperimentsOperationsWait(name: string, opts?: ProjectsLocationsTensorboardsExperimentsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsTensorboardsExperimentsRunsBatchCreate(parent: string, req: GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest): Promise<GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse>;
async projectsLocationsTensorboardsExperimentsRunsCreate(
parent: string,
req: GoogleCloudAiplatformV1TensorboardRun,
opts?: ProjectsLocationsTensorboardsExperimentsRunsCreateOptions,
): Promise<GoogleCloudAiplatformV1TensorboardRun>;
async projectsLocationsTensorboardsExperimentsRunsDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsTensorboardsExperimentsRunsGet(name: string): Promise<GoogleCloudAiplatformV1TensorboardRun>;
async projectsLocationsTensorboardsExperimentsRunsList(parent: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsListOptions): Promise<GoogleCloudAiplatformV1ListTensorboardRunsResponse>;
async projectsLocationsTensorboardsExperimentsRunsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsTensorboardsExperimentsRunsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsTensorboardsExperimentsRunsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsTensorboardsExperimentsRunsOperationsList(name: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsTensorboardsExperimentsRunsOperationsWait(name: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsTensorboardsExperimentsRunsPatch(
name: string,
req: GoogleCloudAiplatformV1TensorboardRun,
opts?: ProjectsLocationsTensorboardsExperimentsRunsPatchOptions,
): Promise<GoogleCloudAiplatformV1TensorboardRun>;
async projectsLocationsTensorboardsExperimentsRunsTimeSeriesCreate(
parent: string,
req: GoogleCloudAiplatformV1TensorboardTimeSeries,
opts?: ProjectsLocationsTensorboardsExperimentsRunsTimeSeriesCreateOptions,
): Promise<GoogleCloudAiplatformV1TensorboardTimeSeries>;
async projectsLocationsTensorboardsExperimentsRunsTimeSeriesDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsTensorboardsExperimentsRunsTimeSeriesExportTensorboardTimeSeries(tensorboardTimeSeries: string, req: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest): Promise<GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse>;
async projectsLocationsTensorboardsExperimentsRunsTimeSeriesGet(name: string): Promise<GoogleCloudAiplatformV1TensorboardTimeSeries>;
async projectsLocationsTensorboardsExperimentsRunsTimeSeriesList(parent: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsTimeSeriesListOptions): Promise<GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse>;
async projectsLocationsTensorboardsExperimentsRunsTimeSeriesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsTensorboardsExperimentsRunsTimeSeriesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsTensorboardsExperimentsRunsTimeSeriesOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsTensorboardsExperimentsRunsTimeSeriesOperationsList(name: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsTimeSeriesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsTensorboardsExperimentsRunsTimeSeriesOperationsWait(name: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsTimeSeriesOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsTensorboardsExperimentsRunsTimeSeriesPatch(
name: string,
req: GoogleCloudAiplatformV1TensorboardTimeSeries,
opts?: ProjectsLocationsTensorboardsExperimentsRunsTimeSeriesPatchOptions,
): Promise<GoogleCloudAiplatformV1TensorboardTimeSeries>;
async projectsLocationsTensorboardsExperimentsRunsTimeSeriesRead(tensorboardTimeSeries: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsTimeSeriesReadOptions): Promise<GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse>;
async projectsLocationsTensorboardsExperimentsRunsTimeSeriesReadBlobData(timeSeries: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsTimeSeriesReadBlobDataOptions): Promise<GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse>;
async projectsLocationsTensorboardsExperimentsRunsWrite(tensorboardRun: string, req: GoogleCloudAiplatformV1WriteTensorboardRunDataRequest): Promise<GoogleCloudAiplatformV1WriteTensorboardRunDataResponse>;
async projectsLocationsTensorboardsExperimentsWrite(tensorboardExperiment: string, req: GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest): Promise<GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse>;
async projectsLocationsTensorboardsGet(name: string): Promise<GoogleCloudAiplatformV1Tensorboard>;
async projectsLocationsTensorboardsList(parent: string, opts?: ProjectsLocationsTensorboardsListOptions): Promise<GoogleCloudAiplatformV1ListTensorboardsResponse>;
async projectsLocationsTensorboardsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsTensorboardsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsTensorboardsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsTensorboardsOperationsList(name: string, opts?: ProjectsLocationsTensorboardsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsTensorboardsOperationsWait(name: string, opts?: ProjectsLocationsTensorboardsOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsTensorboardsPatch(
name: string,
req: GoogleCloudAiplatformV1Tensorboard,
opts?: ProjectsLocationsTensorboardsPatchOptions,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsTensorboardsReadSize(tensorboard: string): Promise<GoogleCloudAiplatformV1ReadTensorboardSizeResponse>;
async projectsLocationsTensorboardsReadUsage(tensorboard: string): Promise<GoogleCloudAiplatformV1ReadTensorboardUsageResponse>;
async projectsLocationsTrainingPipelinesCancel(name: string, req: GoogleCloudAiplatformV1CancelTrainingPipelineRequest): Promise<GoogleProtobufEmpty>;
async projectsLocationsTrainingPipelinesCreate(parent: string, req: GoogleCloudAiplatformV1TrainingPipeline): Promise<GoogleCloudAiplatformV1TrainingPipeline>;
async projectsLocationsTrainingPipelinesDelete(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsTrainingPipelinesGet(name: string): Promise<GoogleCloudAiplatformV1TrainingPipeline>;
async projectsLocationsTrainingPipelinesList(parent: string, opts?: ProjectsLocationsTrainingPipelinesListOptions): Promise<GoogleCloudAiplatformV1ListTrainingPipelinesResponse>;
async projectsLocationsTrainingPipelinesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsTrainingPipelinesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsTrainingPipelinesOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsTrainingPipelinesOperationsList(name: string, opts?: ProjectsLocationsTrainingPipelinesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsTrainingPipelinesOperationsWait(name: string, opts?: ProjectsLocationsTrainingPipelinesOperationsWaitOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsTuningJobsCancel(name: string, req: GoogleCloudAiplatformV1CancelTuningJobRequest): Promise<GoogleProtobufEmpty>;
async projectsLocationsTuningJobsCreate(parent: string, req: GoogleCloudAiplatformV1TuningJob): Promise<GoogleCloudAiplatformV1TuningJob>;
async projectsLocationsTuningJobsGet(name: string): Promise<GoogleCloudAiplatformV1TuningJob>;
async projectsLocationsTuningJobsList(parent: string, opts?: ProjectsLocationsTuningJobsListOptions): Promise<GoogleCloudAiplatformV1ListTuningJobsResponse>;
async projectsLocationsTuningJobsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsTuningJobsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsTuningJobsOperationsList(name: string, opts?: ProjectsLocationsTuningJobsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async publishersModelsGet(name: string, opts?: PublishersModelsGetOptions): Promise<GoogleCloudAiplatformV1PublisherModel>;
}

§Constructors

§
new AIplatform(client?: CredentialsClient, baseUrl?: string)
[src]

§Properties

§
models
[src]

Generate content with multimodal inputs.

§
models
[src]

Generate content with multimodal inputs with streaming support.

§
models
[src]

Generate content with multimodal inputs.

§
models
[src]

Generate content with multimodal inputs with streaming support.

§Methods

§
projectsLocationsBatchPredictionJobsCancel(name: string, req: GoogleCloudAiplatformV1CancelBatchPredictionJobRequest): Promise<GoogleProtobufEmpty>
[src]

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 JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to CANCELLED. Any files already outputted by the job are not deleted.

@param name

Required. The name of the BatchPredictionJob to cancel. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

§
projectsLocationsBatchPredictionJobsCreate(parent: string, req: GoogleCloudAiplatformV1BatchPredictionJob): Promise<GoogleCloudAiplatformV1BatchPredictionJob>
[src]

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

@param parent

Required. The resource name of the Location to create the BatchPredictionJob in. Format: projects/{project}/locations/{location}

§
projectsLocationsBatchPredictionJobsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

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

@param name

Required. The name of the BatchPredictionJob resource to be deleted. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

§
projectsLocationsBatchPredictionJobsGet(name: string): Promise<GoogleCloudAiplatformV1BatchPredictionJob>
[src]

Gets a BatchPredictionJob

@param name

Required. The name of the BatchPredictionJob resource. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

§
projectsLocationsBatchPredictionJobsList(parent: string, opts?: ProjectsLocationsBatchPredictionJobsListOptions): Promise<GoogleCloudAiplatformV1ListBatchPredictionJobsResponse>
[src]

Lists BatchPredictionJobs in a Location.

@param parent

Required. The resource name of the Location to list the BatchPredictionJobs from. Format: projects/{project}/locations/{location}

§
projectsLocationsCustomJobsCancel(name: string, req: GoogleCloudAiplatformV1CancelCustomJobRequest): Promise<GoogleProtobufEmpty>
[src]

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 JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and CustomJob.state is set to CANCELLED.

@param name

Required. The name of the CustomJob to cancel. Format: projects/{project}/locations/{location}/customJobs/{custom_job}

§
projectsLocationsCustomJobsCreate(parent: string, req: GoogleCloudAiplatformV1CustomJob): Promise<GoogleCloudAiplatformV1CustomJob>
[src]

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

@param parent

Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}

§
projectsLocationsCustomJobsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a CustomJob.

@param name

Required. The name of the CustomJob resource to be deleted. Format: projects/{project}/locations/{location}/customJobs/{custom_job}

§
projectsLocationsCustomJobsGet(name: string): Promise<GoogleCloudAiplatformV1CustomJob>
[src]

Gets a CustomJob.

@param name

Required. The name of the CustomJob resource. Format: projects/{project}/locations/{location}/customJobs/{custom_job}

§
projectsLocationsCustomJobsList(parent: string, opts?: ProjectsLocationsCustomJobsListOptions): Promise<GoogleCloudAiplatformV1ListCustomJobsResponse>
[src]

Lists CustomJobs in a Location.

@param parent

Required. The resource name of the Location to list the CustomJobs from. Format: projects/{project}/locations/{location}

§
projectsLocationsCustomJobsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsCustomJobsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsCustomJobsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsCustomJobsOperationsList(name: string, opts?: ProjectsLocationsCustomJobsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsCustomJobsOperationsWait(name: string, opts?: ProjectsLocationsCustomJobsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsDataLabelingJobsCancel(name: string, req: GoogleCloudAiplatformV1CancelDataLabelingJobRequest): Promise<GoogleProtobufEmpty>
[src]

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

@param name

Required. The name of the DataLabelingJob. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

§
projectsLocationsDataLabelingJobsCreate(parent: string, req: GoogleCloudAiplatformV1DataLabelingJob): Promise<GoogleCloudAiplatformV1DataLabelingJob>
[src]

Creates a DataLabelingJob.

@param parent

Required. The parent of the DataLabelingJob. Format: projects/{project}/locations/{location}

§
projectsLocationsDataLabelingJobsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a DataLabelingJob.

@param name

Required. The name of the DataLabelingJob to be deleted. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

§
projectsLocationsDataLabelingJobsGet(name: string): Promise<GoogleCloudAiplatformV1DataLabelingJob>
[src]

Gets a DataLabelingJob.

@param name

Required. The name of the DataLabelingJob. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

§
projectsLocationsDataLabelingJobsList(parent: string, opts?: ProjectsLocationsDataLabelingJobsListOptions): Promise<GoogleCloudAiplatformV1ListDataLabelingJobsResponse>
[src]

Lists DataLabelingJobs in a Location.

@param parent

Required. The parent of the DataLabelingJob. Format: projects/{project}/locations/{location}

§
projectsLocationsDataLabelingJobsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsDataLabelingJobsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsDataLabelingJobsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsDataLabelingJobsOperationsList(name: string, opts?: ProjectsLocationsDataLabelingJobsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsDataLabelingJobsOperationsWait(name: string, opts?: ProjectsLocationsDataLabelingJobsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsDatasetsAnnotationSpecsGet(name: string, opts?: ProjectsLocationsDatasetsAnnotationSpecsGetOptions): Promise<GoogleCloudAiplatformV1AnnotationSpec>
[src]

Gets an AnnotationSpec.

@param name

Required. The name of the AnnotationSpec resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}

§
projectsLocationsDatasetsAnnotationSpecsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsDatasetsAnnotationSpecsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsDatasetsAnnotationSpecsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsDatasetsAnnotationSpecsOperationsList(name: string, opts?: ProjectsLocationsDatasetsAnnotationSpecsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsDatasetsAnnotationSpecsOperationsWait(name: string, opts?: ProjectsLocationsDatasetsAnnotationSpecsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsDatasetsCreate(parent: string, req: GoogleCloudAiplatformV1Dataset): Promise<GoogleLongrunningOperation>
[src]

Creates a Dataset.

@param parent

Required. The resource name of the Location to create the Dataset in. Format: projects/{project}/locations/{location}

§
projectsLocationsDatasetsDataItemsAnnotationsList(parent: string, opts?: ProjectsLocationsDatasetsDataItemsAnnotationsListOptions): Promise<GoogleCloudAiplatformV1ListAnnotationsResponse>
[src]

Lists Annotations belongs to a dataitem

@param parent

Required. The resource name of the DataItem to list Annotations from. Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}

§
projectsLocationsDatasetsDataItemsAnnotationsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsDatasetsDataItemsAnnotationsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsDatasetsDataItemsAnnotationsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsDatasetsDataItemsAnnotationsOperationsList(name: string, opts?: ProjectsLocationsDatasetsDataItemsAnnotationsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsDatasetsDataItemsAnnotationsOperationsWait(name: string, opts?: ProjectsLocationsDatasetsDataItemsAnnotationsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsDatasetsDataItemsList(parent: string, opts?: ProjectsLocationsDatasetsDataItemsListOptions): Promise<GoogleCloudAiplatformV1ListDataItemsResponse>
[src]

Lists DataItems in a Dataset.

@param parent

Required. The resource name of the Dataset to list DataItems from. Format: projects/{project}/locations/{location}/datasets/{dataset}

§
projectsLocationsDatasetsDataItemsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsDatasetsDataItemsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsDatasetsDataItemsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsDatasetsDataItemsOperationsList(name: string, opts?: ProjectsLocationsDatasetsDataItemsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsDatasetsDataItemsOperationsWait(name: string, opts?: ProjectsLocationsDatasetsDataItemsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsDatasetsDatasetVersionsCreate(parent: string, req: GoogleCloudAiplatformV1DatasetVersion): Promise<GoogleLongrunningOperation>
[src]

Create a version from a Dataset.

@param parent

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

§
projectsLocationsDatasetsDatasetVersionsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a Dataset version.

@param name

Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

§
projectsLocationsDatasetsDatasetVersionsGet(name: string, opts?: ProjectsLocationsDatasetsDatasetVersionsGetOptions): Promise<GoogleCloudAiplatformV1DatasetVersion>
[src]

Gets a Dataset version.

@param name

Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

§
projectsLocationsDatasetsDatasetVersionsList(parent: string, opts?: ProjectsLocationsDatasetsDatasetVersionsListOptions): Promise<GoogleCloudAiplatformV1ListDatasetVersionsResponse>
[src]

Lists DatasetVersions in a Dataset.

@param parent

Required. The resource name of the Dataset to list DatasetVersions from. Format: projects/{project}/locations/{location}/datasets/{dataset}

§
projectsLocationsDatasetsDatasetVersionsPatch(name: string, req: GoogleCloudAiplatformV1DatasetVersion, opts?: ProjectsLocationsDatasetsDatasetVersionsPatchOptions): Promise<GoogleCloudAiplatformV1DatasetVersion>
[src]

Updates a DatasetVersion.

@param name

Output only. The resource name of the DatasetVersion.

§
projectsLocationsDatasetsDatasetVersionsRestore(name: string): Promise<GoogleLongrunningOperation>
[src]

Restores a dataset version.

@param name

Required. The name of the DatasetVersion resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}

§
projectsLocationsDatasetsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a Dataset.

@param name

Required. The resource name of the Dataset to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}

§
projectsLocationsDatasetsExport(name: string, req: GoogleCloudAiplatformV1ExportDataRequest): Promise<GoogleLongrunningOperation>
[src]

Exports data from a Dataset.

@param name

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

§
projectsLocationsDatasetsGet(name: string, opts?: ProjectsLocationsDatasetsGetOptions): Promise<GoogleCloudAiplatformV1Dataset>
[src]

Gets a Dataset.

@param name

Required. The name of the Dataset resource.

§
projectsLocationsDatasetsImport(name: string, req: GoogleCloudAiplatformV1ImportDataRequest): Promise<GoogleLongrunningOperation>
[src]

Imports data into a Dataset.

@param name

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

§
projectsLocationsDatasetsList(parent: string, opts?: ProjectsLocationsDatasetsListOptions): Promise<GoogleCloudAiplatformV1ListDatasetsResponse>
[src]

Lists Datasets in a Location.

@param parent

Required. The name of the Dataset's parent resource. Format: projects/{project}/locations/{location}

§
projectsLocationsDatasetsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsDatasetsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsDatasetsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsDatasetsOperationsList(name: string, opts?: ProjectsLocationsDatasetsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsDatasetsOperationsWait(name: string, opts?: ProjectsLocationsDatasetsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsDatasetsPatch(name: string, req: GoogleCloudAiplatformV1Dataset, opts?: ProjectsLocationsDatasetsPatchOptions): Promise<GoogleCloudAiplatformV1Dataset>
[src]

Updates a Dataset.

@param name

Output only. The resource name of the Dataset.

§
projectsLocationsDatasetsSavedQueriesDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a SavedQuery.

@param name

Required. The resource name of the SavedQuery to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}

§
projectsLocationsDatasetsSavedQueriesList(parent: string, opts?: ProjectsLocationsDatasetsSavedQueriesListOptions): Promise<GoogleCloudAiplatformV1ListSavedQueriesResponse>
[src]

Lists SavedQueries in a Dataset.

@param parent

Required. The resource name of the Dataset to list SavedQueries from. Format: projects/{project}/locations/{location}/datasets/{dataset}

§
projectsLocationsDatasetsSavedQueriesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsDatasetsSavedQueriesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsDatasetsSavedQueriesOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsDatasetsSavedQueriesOperationsList(name: string, opts?: ProjectsLocationsDatasetsSavedQueriesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsDatasetsSavedQueriesOperationsWait(name: string, opts?: ProjectsLocationsDatasetsSavedQueriesOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsDatasetsSearchDataItems(dataset: string, opts?: ProjectsLocationsDatasetsSearchDataItemsOptions): Promise<GoogleCloudAiplatformV1SearchDataItemsResponse>
[src]

Searches DataItems in a Dataset.

@param dataset

Required. The resource name of the Dataset from which to search DataItems. Format: projects/{project}/locations/{location}/datasets/{dataset}

§
projectsLocationsDeploymentResourcePoolsCreate(parent: string, req: GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest): Promise<GoogleLongrunningOperation>
[src]

Create a DeploymentResourcePool.

@param parent

Required. The parent location resource where this DeploymentResourcePool will be created. Format: projects/{project}/locations/{location}

§
projectsLocationsDeploymentResourcePoolsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Delete a DeploymentResourcePool.

@param name

Required. The name of the DeploymentResourcePool to delete. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

§
projectsLocationsDeploymentResourcePoolsGet(name: string): Promise<GoogleCloudAiplatformV1DeploymentResourcePool>
[src]

Get a DeploymentResourcePool.

@param name

Required. The name of the DeploymentResourcePool to retrieve. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

§
projectsLocationsDeploymentResourcePoolsList(parent: string, opts?: ProjectsLocationsDeploymentResourcePoolsListOptions): Promise<GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse>
[src]

List DeploymentResourcePools in a location.

@param parent

Required. The parent Location which owns this collection of DeploymentResourcePools. Format: projects/{project}/locations/{location}

§
projectsLocationsDeploymentResourcePoolsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsDeploymentResourcePoolsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsDeploymentResourcePoolsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsDeploymentResourcePoolsOperationsList(name: string, opts?: ProjectsLocationsDeploymentResourcePoolsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsDeploymentResourcePoolsOperationsWait(name: string, opts?: ProjectsLocationsDeploymentResourcePoolsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsDeploymentResourcePoolsQueryDeployedModels(deploymentResourcePool: string, opts?: ProjectsLocationsDeploymentResourcePoolsQueryDeployedModelsOptions): Promise<GoogleCloudAiplatformV1QueryDeployedModelsResponse>
[src]

List DeployedModels that have been deployed on this DeploymentResourcePool.

@param deploymentResourcePool

Required. The name of the target DeploymentResourcePool to query. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

§
projectsLocationsEndpointsComputeTokens(endpoint: string, req: GoogleCloudAiplatformV1ComputeTokensRequest): Promise<GoogleCloudAiplatformV1ComputeTokensResponse>
[src]

Return a list of tokens based on the input text.

@param endpoint

Required. The name of the Endpoint requested to get lists of tokens and token ids.

§
projectsLocationsEndpointsCountTokens(endpoint: string, req: GoogleCloudAiplatformV1CountTokensRequest): Promise<GoogleCloudAiplatformV1CountTokensResponse>
[src]

Perform a token counting.

@param endpoint

Required. The name of the Endpoint requested to perform token counting. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsEndpointsCreate(parent: string, req: GoogleCloudAiplatformV1Endpoint, opts?: ProjectsLocationsEndpointsCreateOptions): Promise<GoogleLongrunningOperation>
[src]

Creates an Endpoint.

@param parent

Required. The resource name of the Location to create the Endpoint in. Format: projects/{project}/locations/{location}

§
projectsLocationsEndpointsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes an Endpoint.

@param name

Required. The name of the Endpoint resource to be deleted. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsEndpointsDeployModel(endpoint: string, req: GoogleCloudAiplatformV1DeployModelRequest): Promise<GoogleLongrunningOperation>
[src]

Deploys a Model into this Endpoint, creating a DeployedModel within it.

@param endpoint

Required. The name of the Endpoint resource into which to deploy a Model. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsEndpointsDirectPredict(endpoint: string, req: GoogleCloudAiplatformV1DirectPredictRequest): Promise<GoogleCloudAiplatformV1DirectPredictResponse>
[src]

Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.

@param endpoint

Required. The name of the Endpoint requested to serve the prediction. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsEndpointsDirectRawPredict(endpoint: string, req: GoogleCloudAiplatformV1DirectRawPredictRequest): Promise<GoogleCloudAiplatformV1DirectRawPredictResponse>
[src]

Perform an unary online prediction request to a gRPC model server for custom containers.

@param endpoint

Required. The name of the Endpoint requested to serve the prediction. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsEndpointsExplain(endpoint: string, req: GoogleCloudAiplatformV1ExplainRequest): Promise<GoogleCloudAiplatformV1ExplainResponse>
[src]

Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated.

@param endpoint

Required. The name of the Endpoint requested to serve the explanation. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsEndpointsGenerateContent(model: string, req: GoogleCloudAiplatformV1GenerateContentRequest): Promise<GoogleCloudAiplatformV1GenerateContentResponse>
[src]
§
projectsLocationsEndpointsGet(name: string): Promise<GoogleCloudAiplatformV1Endpoint>
[src]

Gets an Endpoint.

@param name

Required. The name of the Endpoint resource. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsEndpointsList(parent: string, opts?: ProjectsLocationsEndpointsListOptions): Promise<GoogleCloudAiplatformV1ListEndpointsResponse>
[src]

Lists Endpoints in a Location.

@param parent

Required. The resource name of the Location from which to list the Endpoints. Format: projects/{project}/locations/{location}

§
projectsLocationsEndpointsMutateDeployedModel(endpoint: string, req: GoogleCloudAiplatformV1MutateDeployedModelRequest): Promise<GoogleLongrunningOperation>
[src]

Updates an existing deployed model. Updatable fields include min_replica_count, max_replica_count, autoscaling_metric_specs, disable_container_logging (v1 only), and enable_container_logging (v1beta1 only).

@param endpoint

Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsEndpointsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsEndpointsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsEndpointsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsEndpointsOperationsList(name: string, opts?: ProjectsLocationsEndpointsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsEndpointsOperationsWait(name: string, opts?: ProjectsLocationsEndpointsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsEndpointsPatch(name: string, req: GoogleCloudAiplatformV1Endpoint, opts?: ProjectsLocationsEndpointsPatchOptions): Promise<GoogleCloudAiplatformV1Endpoint>
[src]

Updates an Endpoint.

@param name

Output only. The resource name of the Endpoint.

§
projectsLocationsEndpointsPredict(endpoint: string, req: GoogleCloudAiplatformV1PredictRequest): Promise<GoogleCloudAiplatformV1PredictResponse>
[src]

Perform an online prediction.

@param endpoint

Required. The name of the Endpoint requested to serve the prediction. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsEndpointsRawPredict(endpoint: string, req: GoogleCloudAiplatformV1RawPredictRequest): Promise<GoogleApiHttpBody>
[src]

Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * X-Vertex-AI-Endpoint-Id: ID of the Endpoint that served this prediction. * X-Vertex-AI-Deployed-Model-Id: ID of the Endpoint's DeployedModel that served this prediction.

@param endpoint

Required. The name of the Endpoint requested to serve the prediction. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsEndpointsServerStreamingPredict(endpoint: string, req: GoogleCloudAiplatformV1StreamingPredictRequest): Promise<GoogleCloudAiplatformV1StreamingPredictResponse>
[src]

Perform a server-side streaming online prediction request for Vertex LLM streaming.

@param endpoint

Required. The name of the Endpoint requested to serve the prediction. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsEndpointsStreamGenerateContent(model: string, req: GoogleCloudAiplatformV1GenerateContentRequest): Promise<GoogleCloudAiplatformV1GenerateContentResponse>
[src]
§
projectsLocationsEndpointsStreamRawPredict(endpoint: string, req: GoogleCloudAiplatformV1StreamRawPredictRequest): Promise<GoogleApiHttpBody>
[src]

Perform a streaming online prediction with an arbitrary HTTP payload.

@param endpoint

Required. The name of the Endpoint requested to serve the prediction. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsEndpointsUndeployModel(endpoint: string, req: GoogleCloudAiplatformV1UndeployModelRequest): Promise<GoogleLongrunningOperation>
[src]

Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.

@param endpoint

Required. The name of the Endpoint resource from which to undeploy a Model. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsFeatureGroupsCreate(parent: string, req: GoogleCloudAiplatformV1FeatureGroup, opts?: ProjectsLocationsFeatureGroupsCreateOptions): Promise<GoogleLongrunningOperation>
[src]

Creates a new FeatureGroup in a given project and location.

@param parent

Required. The resource name of the Location to create FeatureGroups. Format: projects/{project}/locations/{location}

§
projectsLocationsFeatureGroupsDelete(name: string, opts?: ProjectsLocationsFeatureGroupsDeleteOptions): Promise<GoogleLongrunningOperation>
[src]

Deletes a single FeatureGroup.

@param name

Required. The name of the FeatureGroup to be deleted. Format: projects/{project}/locations/{location}/featureGroups/{feature_group}

§
projectsLocationsFeatureGroupsFeaturesCreate(parent: string, req: GoogleCloudAiplatformV1Feature, opts?: ProjectsLocationsFeatureGroupsFeaturesCreateOptions): Promise<GoogleLongrunningOperation>
[src]

Creates a new Feature in a given FeatureGroup.

@param parent

Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} Format for feature_group as parent: projects/{project}/locations/{location}/featureGroups/{feature_group}

§
projectsLocationsFeatureGroupsFeaturesDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a single Feature.

@param name

Required. The name of the Features to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature} projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}

§
projectsLocationsFeatureGroupsFeaturesGet(name: string): Promise<GoogleCloudAiplatformV1Feature>
[src]

Gets details of a single Feature.

@param name

Required. The name of the Feature resource. Format for entity_type as parent: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} Format for feature_group as parent: projects/{project}/locations/{location}/featureGroups/{feature_group}

§
projectsLocationsFeatureGroupsFeaturesList(parent: string, opts?: ProjectsLocationsFeatureGroupsFeaturesListOptions): Promise<GoogleCloudAiplatformV1ListFeaturesResponse>
[src]

Lists Features in a given FeatureGroup.

@param parent

Required. The resource name of the Location to list Features. Format for entity_type as parent: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} Format for feature_group as parent: projects/{project}/locations/{location}/featureGroups/{feature_group}

§
projectsLocationsFeatureGroupsFeaturesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsFeatureGroupsFeaturesOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsFeatureGroupsFeaturesOperationsListWait(name: string, opts?: ProjectsLocationsFeatureGroupsFeaturesOperationsListWaitOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsFeatureGroupsFeaturesOperationsWait(name: string, opts?: ProjectsLocationsFeatureGroupsFeaturesOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsFeatureGroupsFeaturesPatch(name: string, req: GoogleCloudAiplatformV1Feature, opts?: ProjectsLocationsFeatureGroupsFeaturesPatchOptions): Promise<GoogleLongrunningOperation>
[src]

Updates the parameters of a single Feature.

@param name

Immutable. Name of the Feature. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature} projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature} The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.

§
projectsLocationsFeatureGroupsGet(name: string): Promise<GoogleCloudAiplatformV1FeatureGroup>
[src]

Gets details of a single FeatureGroup.

@param name

Required. The name of the FeatureGroup resource.

§
projectsLocationsFeatureGroupsList(parent: string, opts?: ProjectsLocationsFeatureGroupsListOptions): Promise<GoogleCloudAiplatformV1ListFeatureGroupsResponse>
[src]

Lists FeatureGroups in a given project and location.

@param parent

Required. The resource name of the Location to list FeatureGroups. Format: projects/{project}/locations/{location}

§
projectsLocationsFeatureGroupsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsFeatureGroupsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsFeatureGroupsOperationsListWait(name: string, opts?: ProjectsLocationsFeatureGroupsOperationsListWaitOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsFeatureGroupsOperationsWait(name: string, opts?: ProjectsLocationsFeatureGroupsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsFeatureGroupsPatch(name: string, req: GoogleCloudAiplatformV1FeatureGroup, opts?: ProjectsLocationsFeatureGroupsPatchOptions): Promise<GoogleLongrunningOperation>
[src]

Updates the parameters of a single FeatureGroup.

@param name

Identifier. Name of the FeatureGroup. Format: projects/{project}/locations/{location}/featureGroups/{featureGroup}

§
projectsLocationsFeatureOnlineStoresCreate(parent: string, req: GoogleCloudAiplatformV1FeatureOnlineStore, opts?: ProjectsLocationsFeatureOnlineStoresCreateOptions): Promise<GoogleLongrunningOperation>
[src]

Creates a new FeatureOnlineStore in a given project and location.

@param parent

Required. The resource name of the Location to create FeatureOnlineStores. Format: projects/{project}/locations/{location}

§
projectsLocationsFeatureOnlineStoresDelete(name: string, opts?: ProjectsLocationsFeatureOnlineStoresDeleteOptions): Promise<GoogleLongrunningOperation>
[src]

Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.

@param name

Required. The name of the FeatureOnlineStore to be deleted. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}

§
projectsLocationsFeatureOnlineStoresFeatureViewsCreate(parent: string, req: GoogleCloudAiplatformV1FeatureView, opts?: ProjectsLocationsFeatureOnlineStoresFeatureViewsCreateOptions): Promise<GoogleLongrunningOperation>
[src]

Creates a new FeatureView in a given FeatureOnlineStore.

@param parent

Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}

§
projectsLocationsFeatureOnlineStoresFeatureViewsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a single FeatureView.

@param name

Required. The name of the FeatureView to be deleted. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}

§
projectsLocationsFeatureOnlineStoresFeatureViewsFeatureViewSyncsGet(name: string): Promise<GoogleCloudAiplatformV1FeatureViewSync>
[src]

Gets details of a single FeatureViewSync.

@param name

Required. The name of the FeatureViewSync resource. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}

§
projectsLocationsFeatureOnlineStoresFeatureViewsFeatureViewSyncsList(parent: string, opts?: ProjectsLocationsFeatureOnlineStoresFeatureViewsFeatureViewSyncsListOptions): Promise<GoogleCloudAiplatformV1ListFeatureViewSyncsResponse>
[src]

Lists FeatureViewSyncs in a given FeatureView.

@param parent

Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}

§
projectsLocationsFeatureOnlineStoresFeatureViewsFetchFeatureValues(featureView: string, req: GoogleCloudAiplatformV1FetchFeatureValuesRequest): Promise<GoogleCloudAiplatformV1FetchFeatureValuesResponse>
[src]

Fetch feature values under a FeatureView.

@param featureView

Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}

§
projectsLocationsFeatureOnlineStoresFeatureViewsGet(name: string): Promise<GoogleCloudAiplatformV1FeatureView>
[src]

Gets details of a single FeatureView.

@param name

Required. The name of the FeatureView resource. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}

§
projectsLocationsFeatureOnlineStoresFeatureViewsList(parent: string, opts?: ProjectsLocationsFeatureOnlineStoresFeatureViewsListOptions): Promise<GoogleCloudAiplatformV1ListFeatureViewsResponse>
[src]

Lists FeatureViews in a given FeatureOnlineStore.

@param parent

Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}

§
projectsLocationsFeatureOnlineStoresFeatureViewsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsFeatureOnlineStoresFeatureViewsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsFeatureOnlineStoresFeatureViewsOperationsListWait(name: string, opts?: ProjectsLocationsFeatureOnlineStoresFeatureViewsOperationsListWaitOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsFeatureOnlineStoresFeatureViewsOperationsWait(name: string, opts?: ProjectsLocationsFeatureOnlineStoresFeatureViewsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsFeatureOnlineStoresFeatureViewsPatch(name: string, req: GoogleCloudAiplatformV1FeatureView, opts?: ProjectsLocationsFeatureOnlineStoresFeatureViewsPatchOptions): Promise<GoogleLongrunningOperation>
[src]

Updates the parameters of a single FeatureView.

@param name

Identifier. Name of the FeatureView. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}

§
projectsLocationsFeatureOnlineStoresFeatureViewsSearchNearestEntities(featureView: string, req: GoogleCloudAiplatformV1SearchNearestEntitiesRequest): Promise<GoogleCloudAiplatformV1SearchNearestEntitiesResponse>
[src]

Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.

@param featureView

Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}

§
projectsLocationsFeatureOnlineStoresFeatureViewsSync(featureView: string, req: GoogleCloudAiplatformV1SyncFeatureViewRequest): Promise<GoogleCloudAiplatformV1SyncFeatureViewResponse>
[src]

Triggers on-demand sync for the FeatureView.

@param featureView

Required. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}

§
projectsLocationsFeatureOnlineStoresGet(name: string): Promise<GoogleCloudAiplatformV1FeatureOnlineStore>
[src]

Gets details of a single FeatureOnlineStore.

@param name

Required. The name of the FeatureOnlineStore resource.

§
projectsLocationsFeatureOnlineStoresList(parent: string, opts?: ProjectsLocationsFeatureOnlineStoresListOptions): Promise<GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse>
[src]

Lists FeatureOnlineStores in a given project and location.

@param parent

Required. The resource name of the Location to list FeatureOnlineStores. Format: projects/{project}/locations/{location}

§
projectsLocationsFeatureOnlineStoresOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsFeatureOnlineStoresOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsFeatureOnlineStoresOperationsListWait(name: string, opts?: ProjectsLocationsFeatureOnlineStoresOperationsListWaitOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsFeatureOnlineStoresOperationsWait(name: string, opts?: ProjectsLocationsFeatureOnlineStoresOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsFeatureOnlineStoresPatch(name: string, req: GoogleCloudAiplatformV1FeatureOnlineStore, opts?: ProjectsLocationsFeatureOnlineStoresPatchOptions): Promise<GoogleLongrunningOperation>
[src]

Updates the parameters of a single FeatureOnlineStore.

@param name

Identifier. Name of the FeatureOnlineStore. Format: projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}

§
projectsLocationsFeaturestoresBatchReadFeatureValues(featurestore: string, req: GoogleCloudAiplatformV1BatchReadFeatureValuesRequest): Promise<GoogleLongrunningOperation>
[src]

Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.

@param featurestore

Required. The resource name of the Featurestore from which to query Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

§
projectsLocationsFeaturestoresCreate(parent: string, req: GoogleCloudAiplatformV1Featurestore, opts?: ProjectsLocationsFeaturestoresCreateOptions): Promise<GoogleLongrunningOperation>
[src]

Creates a new Featurestore in a given project and location.

@param parent

Required. The resource name of the Location to create Featurestores. Format: projects/{project}/locations/{location}

§
projectsLocationsFeaturestoresDelete(name: string, opts?: ProjectsLocationsFeaturestoresDeleteOptions): Promise<GoogleLongrunningOperation>
[src]

Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force must be set to true for the request to succeed.

@param name

Required. The name of the Featurestore to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

§
projectsLocationsFeaturestoresEntityTypesCreate(parent: string, req: GoogleCloudAiplatformV1EntityType, opts?: ProjectsLocationsFeaturestoresEntityTypesCreateOptions): Promise<GoogleLongrunningOperation>
[src]

Creates a new EntityType in a given Featurestore.

@param parent

Required. The resource name of the Featurestore to create EntityTypes. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

§
projectsLocationsFeaturestoresEntityTypesDelete(name: string, opts?: ProjectsLocationsFeaturestoresEntityTypesDeleteOptions): Promise<GoogleLongrunningOperation>
[src]

Deletes a single EntityType. The EntityType must not have any Features or force must be set to true for the request to succeed.

@param name

Required. The name of the EntityType to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

§
projectsLocationsFeaturestoresEntityTypesDeleteFeatureValues(entityType: string, req: GoogleCloudAiplatformV1DeleteFeatureValuesRequest): Promise<GoogleLongrunningOperation>
[src]

Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.

@param entityType

Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}

§
projectsLocationsFeaturestoresEntityTypesExportFeatureValues(entityType: string, req: GoogleCloudAiplatformV1ExportFeatureValuesRequest): Promise<GoogleLongrunningOperation>
[src]

Exports Feature values from all the entities of a target EntityType.

@param entityType

Required. The resource name of the EntityType from which to export Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

§
projectsLocationsFeaturestoresEntityTypesFeaturesBatchCreate(parent: string, req: GoogleCloudAiplatformV1BatchCreateFeaturesRequest): Promise<GoogleLongrunningOperation>
[src]

Creates a batch of Features in a given EntityType.

@param parent

Required. The resource name of the EntityType to create the batch of Features under. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

§
projectsLocationsFeaturestoresEntityTypesFeaturesCreate(parent: string, req: GoogleCloudAiplatformV1Feature, opts?: ProjectsLocationsFeaturestoresEntityTypesFeaturesCreateOptions): Promise<GoogleLongrunningOperation>
[src]

Creates a new Feature in a given EntityType.

@param parent

Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} Format for feature_group as parent: projects/{project}/locations/{location}/featureGroups/{feature_group}

§
projectsLocationsFeaturestoresEntityTypesFeaturesDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a single Feature.

@param name

Required. The name of the Features to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature} projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}

§
projectsLocationsFeaturestoresEntityTypesFeaturesGet(name: string): Promise<GoogleCloudAiplatformV1Feature>
[src]

Gets details of a single Feature.

@param name

Required. The name of the Feature resource. Format for entity_type as parent: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} Format for feature_group as parent: projects/{project}/locations/{location}/featureGroups/{feature_group}

§
projectsLocationsFeaturestoresEntityTypesFeaturesList(parent: string, opts?: ProjectsLocationsFeaturestoresEntityTypesFeaturesListOptions): Promise<GoogleCloudAiplatformV1ListFeaturesResponse>
[src]

Lists Features in a given EntityType.

@param parent

Required. The resource name of the Location to list Features. Format for entity_type as parent: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} Format for feature_group as parent: projects/{project}/locations/{location}/featureGroups/{feature_group}

§
projectsLocationsFeaturestoresEntityTypesFeaturesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsFeaturestoresEntityTypesFeaturesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsFeaturestoresEntityTypesFeaturesOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsFeaturestoresEntityTypesFeaturesOperationsList(name: string, opts?: ProjectsLocationsFeaturestoresEntityTypesFeaturesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsFeaturestoresEntityTypesFeaturesOperationsWait(name: string, opts?: ProjectsLocationsFeaturestoresEntityTypesFeaturesOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsFeaturestoresEntityTypesFeaturesPatch(name: string, req: GoogleCloudAiplatformV1Feature, opts?: ProjectsLocationsFeaturestoresEntityTypesFeaturesPatchOptions): Promise<GoogleCloudAiplatformV1Feature>
[src]

Updates the parameters of a single Feature.

@param name

Immutable. Name of the Feature. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature} projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature} The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.

§
projectsLocationsFeaturestoresEntityTypesGet(name: string): Promise<GoogleCloudAiplatformV1EntityType>
[src]

Gets details of a single EntityType.

@param name

Required. The name of the EntityType resource. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

§
projectsLocationsFeaturestoresEntityTypesGetIamPolicy(resource: string, opts?: ProjectsLocationsFeaturestoresEntityTypesGetIamPolicyOptions): Promise<GoogleIamV1Policy>
[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsFeaturestoresEntityTypesImportFeatureValues(entityType: string, req: GoogleCloudAiplatformV1ImportFeatureValuesRequest): Promise<GoogleLongrunningOperation>
[src]

Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.

@param entityType

Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}

§
projectsLocationsFeaturestoresEntityTypesList(parent: string, opts?: ProjectsLocationsFeaturestoresEntityTypesListOptions): Promise<GoogleCloudAiplatformV1ListEntityTypesResponse>
[src]

Lists EntityTypes in a given Featurestore.

@param parent

Required. The resource name of the Featurestore to list EntityTypes. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

§
projectsLocationsFeaturestoresEntityTypesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsFeaturestoresEntityTypesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsFeaturestoresEntityTypesOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsFeaturestoresEntityTypesOperationsList(name: string, opts?: ProjectsLocationsFeaturestoresEntityTypesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsFeaturestoresEntityTypesOperationsWait(name: string, opts?: ProjectsLocationsFeaturestoresEntityTypesOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsFeaturestoresEntityTypesPatch(name: string, req: GoogleCloudAiplatformV1EntityType, opts?: ProjectsLocationsFeaturestoresEntityTypesPatchOptions): Promise<GoogleCloudAiplatformV1EntityType>
[src]

Updates the parameters of a single EntityType.

@param name

Immutable. Name of the EntityType. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.

§
projectsLocationsFeaturestoresEntityTypesReadFeatureValues(entityType: string, req: GoogleCloudAiplatformV1ReadFeatureValuesRequest): Promise<GoogleCloudAiplatformV1ReadFeatureValuesResponse>
[src]

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

@param entityType

Required. The resource name of the EntityType for the entity being read. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

§
projectsLocationsFeaturestoresEntityTypesSetIamPolicy(resource: string, req: GoogleIamV1SetIamPolicyRequest): Promise<GoogleIamV1Policy>
[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

§
projectsLocationsFeaturestoresEntityTypesStreamingReadFeatureValues(entityType: string, req: GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest): Promise<GoogleCloudAiplatformV1ReadFeatureValuesResponse>
[src]

Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.

@param entityType

Required. The resource name of the entities' type. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

§
projectsLocationsFeaturestoresEntityTypesTestIamPermissions(resource: string, opts?: ProjectsLocationsFeaturestoresEntityTypesTestIamPermissionsOptions): Promise<GoogleIamV1TestIamPermissionsResponse>
[src]

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsFeaturestoresEntityTypesWriteFeatureValues(entityType: string, req: GoogleCloudAiplatformV1WriteFeatureValuesRequest): Promise<GoogleCloudAiplatformV1WriteFeatureValuesResponse>
[src]

Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

@param entityType

Required. The resource name of the EntityType for the entities being written. Value format: projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

§
projectsLocationsFeaturestoresGet(name: string): Promise<GoogleCloudAiplatformV1Featurestore>
[src]

Gets details of a single Featurestore.

@param name

Required. The name of the Featurestore resource.

§
projectsLocationsFeaturestoresGetIamPolicy(resource: string, opts?: ProjectsLocationsFeaturestoresGetIamPolicyOptions): Promise<GoogleIamV1Policy>
[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsFeaturestoresList(parent: string, opts?: ProjectsLocationsFeaturestoresListOptions): Promise<GoogleCloudAiplatformV1ListFeaturestoresResponse>
[src]

Lists Featurestores in a given project and location.

@param parent

Required. The resource name of the Location to list Featurestores. Format: projects/{project}/locations/{location}

§
projectsLocationsFeaturestoresOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsFeaturestoresOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsFeaturestoresOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsFeaturestoresOperationsList(name: string, opts?: ProjectsLocationsFeaturestoresOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsFeaturestoresOperationsWait(name: string, opts?: ProjectsLocationsFeaturestoresOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsFeaturestoresPatch(name: string, req: GoogleCloudAiplatformV1Featurestore, opts?: ProjectsLocationsFeaturestoresPatchOptions): Promise<GoogleLongrunningOperation>
[src]

Updates the parameters of a single Featurestore.

@param name

Output only. Name of the Featurestore. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

§
projectsLocationsFeaturestoresSearchFeatures(location: string, opts?: ProjectsLocationsFeaturestoresSearchFeaturesOptions): Promise<GoogleCloudAiplatformV1SearchFeaturesResponse>
[src]

Searches Features matching a query in a given project.

@param location

Required. The resource name of the Location to search Features. Format: projects/{project}/locations/{location}

§
projectsLocationsFeaturestoresSetIamPolicy(resource: string, req: GoogleIamV1SetIamPolicyRequest): Promise<GoogleIamV1Policy>
[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

§
projectsLocationsFeaturestoresTestIamPermissions(resource: string, opts?: ProjectsLocationsFeaturestoresTestIamPermissionsOptions): Promise<GoogleIamV1TestIamPermissionsResponse>
[src]

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsGet(name: string): Promise<GoogleCloudLocationLocation>
[src]

Gets information about a location.

@param name

Resource name for the location.

§
projectsLocationsHyperparameterTuningJobsCancel(name: string, req: GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest): Promise<GoogleProtobufEmpty>
[src]

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 JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and HyperparameterTuningJob.state is set to CANCELLED.

@param name

Required. The name of the HyperparameterTuningJob to cancel. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

§
projectsLocationsHyperparameterTuningJobsCreate(parent: string, req: GoogleCloudAiplatformV1HyperparameterTuningJob): Promise<GoogleCloudAiplatformV1HyperparameterTuningJob>
[src]

Creates a HyperparameterTuningJob

@param parent

Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: projects/{project}/locations/{location}

§
projectsLocationsHyperparameterTuningJobsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a HyperparameterTuningJob.

@param name

Required. The name of the HyperparameterTuningJob resource to be deleted. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

§
projectsLocationsHyperparameterTuningJobsGet(name: string): Promise<GoogleCloudAiplatformV1HyperparameterTuningJob>
[src]

Gets a HyperparameterTuningJob

@param name

Required. The name of the HyperparameterTuningJob resource. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

§
projectsLocationsHyperparameterTuningJobsList(parent: string, opts?: ProjectsLocationsHyperparameterTuningJobsListOptions): Promise<GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse>
[src]

Lists HyperparameterTuningJobs in a Location.

@param parent

Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: projects/{project}/locations/{location}

§
projectsLocationsHyperparameterTuningJobsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsHyperparameterTuningJobsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsHyperparameterTuningJobsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsHyperparameterTuningJobsOperationsList(name: string, opts?: ProjectsLocationsHyperparameterTuningJobsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsHyperparameterTuningJobsOperationsWait(name: string, opts?: ProjectsLocationsHyperparameterTuningJobsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsIndexEndpointsCreate(parent: string, req: GoogleCloudAiplatformV1IndexEndpoint): Promise<GoogleLongrunningOperation>
[src]

Creates an IndexEndpoint.

@param parent

Required. The resource name of the Location to create the IndexEndpoint in. Format: projects/{project}/locations/{location}

§
projectsLocationsIndexEndpointsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes an IndexEndpoint.

@param name

Required. The name of the IndexEndpoint resource to be deleted. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

§
projectsLocationsIndexEndpointsDeployIndex(indexEndpoint: string, req: GoogleCloudAiplatformV1DeployIndexRequest): Promise<GoogleLongrunningOperation>
[src]

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

@param indexEndpoint

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

§
projectsLocationsIndexEndpointsFindNeighbors(indexEndpoint: string, req: GoogleCloudAiplatformV1FindNeighborsRequest): Promise<GoogleCloudAiplatformV1FindNeighborsResponse>
[src]

Finds the nearest neighbors of each vector within the request.

@param indexEndpoint

Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

§
projectsLocationsIndexEndpointsGet(name: string): Promise<GoogleCloudAiplatformV1IndexEndpoint>
[src]

Gets an IndexEndpoint.

@param name

Required. The name of the IndexEndpoint resource. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

§
projectsLocationsIndexEndpointsList(parent: string, opts?: ProjectsLocationsIndexEndpointsListOptions): Promise<GoogleCloudAiplatformV1ListIndexEndpointsResponse>
[src]

Lists IndexEndpoints in a Location.

@param parent

Required. The resource name of the Location from which to list the IndexEndpoints. Format: projects/{project}/locations/{location}

§
projectsLocationsIndexEndpointsMutateDeployedIndex(indexEndpoint: string, req: GoogleCloudAiplatformV1DeployedIndex): Promise<GoogleLongrunningOperation>
[src]

Update an existing DeployedIndex under an IndexEndpoint.

@param indexEndpoint

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

§
projectsLocationsIndexEndpointsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsIndexEndpointsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsIndexEndpointsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsIndexEndpointsOperationsList(name: string, opts?: ProjectsLocationsIndexEndpointsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsIndexEndpointsOperationsWait(name: string, opts?: ProjectsLocationsIndexEndpointsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsIndexEndpointsPatch(name: string, req: GoogleCloudAiplatformV1IndexEndpoint, opts?: ProjectsLocationsIndexEndpointsPatchOptions): Promise<GoogleCloudAiplatformV1IndexEndpoint>
[src]

Updates an IndexEndpoint.

@param name

Output only. The resource name of the IndexEndpoint.

§
projectsLocationsIndexEndpointsReadIndexDatapoints(indexEndpoint: string, req: GoogleCloudAiplatformV1ReadIndexDatapointsRequest): Promise<GoogleCloudAiplatformV1ReadIndexDatapointsResponse>
[src]

Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.

@param indexEndpoint

Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

§
projectsLocationsIndexEndpointsUndeployIndex(indexEndpoint: string, req: GoogleCloudAiplatformV1UndeployIndexRequest): Promise<GoogleLongrunningOperation>
[src]

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

@param indexEndpoint

Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

§
projectsLocationsIndexesCreate(parent: string, req: GoogleCloudAiplatformV1Index): Promise<GoogleLongrunningOperation>
[src]

Creates an Index.

@param parent

Required. The resource name of the Location to create the Index in. Format: projects/{project}/locations/{location}

§
projectsLocationsIndexesDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.

@param name

Required. The name of the Index resource to be deleted. Format: projects/{project}/locations/{location}/indexes/{index}

§
projectsLocationsIndexesGet(name: string): Promise<GoogleCloudAiplatformV1Index>
[src]

Gets an Index.

@param name

Required. The name of the Index resource. Format: projects/{project}/locations/{location}/indexes/{index}

§
projectsLocationsIndexesList(parent: string, opts?: ProjectsLocationsIndexesListOptions): Promise<GoogleCloudAiplatformV1ListIndexesResponse>
[src]

Lists Indexes in a Location.

@param parent

Required. The resource name of the Location from which to list the Indexes. Format: projects/{project}/locations/{location}

§
projectsLocationsIndexesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsIndexesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsIndexesOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsIndexesOperationsList(name: string, opts?: ProjectsLocationsIndexesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsIndexesOperationsWait(name: string, opts?: ProjectsLocationsIndexesOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsIndexesPatch(name: string, req: GoogleCloudAiplatformV1Index, opts?: ProjectsLocationsIndexesPatchOptions): Promise<GoogleLongrunningOperation>
[src]

Updates an Index.

@param name

Output only. The resource name of the Index.

§
projectsLocationsIndexesRemoveDatapoints(index: string, req: GoogleCloudAiplatformV1RemoveDatapointsRequest): Promise<GoogleCloudAiplatformV1RemoveDatapointsResponse>
[src]

Remove Datapoints from an Index.

@param index

Required. The name of the Index resource to be updated. Format: projects/{project}/locations/{location}/indexes/{index}

§
projectsLocationsIndexesUpsertDatapoints(index: string, req: GoogleCloudAiplatformV1UpsertDatapointsRequest): Promise<GoogleCloudAiplatformV1UpsertDatapointsResponse>
[src]

Add/update Datapoints into an Index.

@param index

Required. The name of the Index resource to be updated. Format: projects/{project}/locations/{location}/indexes/{index}

§
projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<GoogleCloudLocationListLocationsResponse>
[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

§
projectsLocationsMetadataStoresArtifactsCreate(parent: string, req: GoogleCloudAiplatformV1Artifact, opts?: ProjectsLocationsMetadataStoresArtifactsCreateOptions): Promise<GoogleCloudAiplatformV1Artifact>
[src]

Creates an Artifact associated with a MetadataStore.

@param parent

Required. The resource name of the MetadataStore where the Artifact should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

§
projectsLocationsMetadataStoresArtifactsDelete(name: string, opts?: ProjectsLocationsMetadataStoresArtifactsDeleteOptions): Promise<GoogleLongrunningOperation>
[src]

Deletes an Artifact.

@param name

Required. The resource name of the Artifact to delete. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}

§
projectsLocationsMetadataStoresArtifactsGet(name: string): Promise<GoogleCloudAiplatformV1Artifact>
[src]

Retrieves a specific Artifact.

@param name

Required. The resource name of the Artifact to retrieve. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}

§
projectsLocationsMetadataStoresArtifactsList(parent: string, opts?: ProjectsLocationsMetadataStoresArtifactsListOptions): Promise<GoogleCloudAiplatformV1ListArtifactsResponse>
[src]

Lists Artifacts in the MetadataStore.

@param parent

Required. The MetadataStore whose Artifacts should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

§
projectsLocationsMetadataStoresArtifactsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsMetadataStoresArtifactsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsMetadataStoresArtifactsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsMetadataStoresArtifactsOperationsList(name: string, opts?: ProjectsLocationsMetadataStoresArtifactsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsMetadataStoresArtifactsOperationsWait(name: string, opts?: ProjectsLocationsMetadataStoresArtifactsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsMetadataStoresArtifactsPatch(name: string, req: GoogleCloudAiplatformV1Artifact, opts?: ProjectsLocationsMetadataStoresArtifactsPatchOptions): Promise<GoogleCloudAiplatformV1Artifact>
[src]

Updates a stored Artifact.

@param name

Output only. The resource name of the Artifact.

§
projectsLocationsMetadataStoresArtifactsPurge(parent: string, req: GoogleCloudAiplatformV1PurgeArtifactsRequest): Promise<GoogleLongrunningOperation>
[src]

Purges Artifacts.

@param parent

Required. The metadata store to purge Artifacts from. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

§
projectsLocationsMetadataStoresArtifactsQueryArtifactLineageSubgraph(artifact: string, opts?: ProjectsLocationsMetadataStoresArtifactsQueryArtifactLineageSubgraphOptions): Promise<GoogleCloudAiplatformV1LineageSubgraph>
[src]

Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.

@param artifact

Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.

§
projectsLocationsMetadataStoresContextsAddContextArtifactsAndExecutions(context: string, req: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest): Promise<GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse>
[src]

Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.

@param context

Required. The resource name of the Context that the Artifacts and Executions belong to. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}

§
projectsLocationsMetadataStoresContextsAddContextChildren(context: string, req: GoogleCloudAiplatformV1AddContextChildrenRequest): Promise<GoogleCloudAiplatformV1AddContextChildrenResponse>
[src]

Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.

@param context

Required. The resource name of the parent Context. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}

§
projectsLocationsMetadataStoresContextsCreate(parent: string, req: GoogleCloudAiplatformV1Context, opts?: ProjectsLocationsMetadataStoresContextsCreateOptions): Promise<GoogleCloudAiplatformV1Context>
[src]

Creates a Context associated with a MetadataStore.

@param parent

Required. The resource name of the MetadataStore where the Context should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

§
projectsLocationsMetadataStoresContextsDelete(name: string, opts?: ProjectsLocationsMetadataStoresContextsDeleteOptions): Promise<GoogleLongrunningOperation>
[src]

Deletes a stored Context.

@param name

Required. The resource name of the Context to delete. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}

§
projectsLocationsMetadataStoresContextsGet(name: string): Promise<GoogleCloudAiplatformV1Context>
[src]

Retrieves a specific Context.

@param name

Required. The resource name of the Context to retrieve. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}

§
projectsLocationsMetadataStoresContextsList(parent: string, opts?: ProjectsLocationsMetadataStoresContextsListOptions): Promise<GoogleCloudAiplatformV1ListContextsResponse>
[src]

Lists Contexts on the MetadataStore.

@param parent

Required. The MetadataStore whose Contexts should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

§
projectsLocationsMetadataStoresContextsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsMetadataStoresContextsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsMetadataStoresContextsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsMetadataStoresContextsOperationsList(name: string, opts?: ProjectsLocationsMetadataStoresContextsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsMetadataStoresContextsOperationsWait(name: string, opts?: ProjectsLocationsMetadataStoresContextsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsMetadataStoresContextsPatch(name: string, req: GoogleCloudAiplatformV1Context, opts?: ProjectsLocationsMetadataStoresContextsPatchOptions): Promise<GoogleCloudAiplatformV1Context>
[src]

Updates a stored Context.

@param name

Immutable. The resource name of the Context.

§
projectsLocationsMetadataStoresContextsPurge(parent: string, req: GoogleCloudAiplatformV1PurgeContextsRequest): Promise<GoogleLongrunningOperation>
[src]

Purges Contexts.

@param parent

Required. The metadata store to purge Contexts from. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

§
projectsLocationsMetadataStoresContextsQueryContextLineageSubgraph(context: string): Promise<GoogleCloudAiplatformV1LineageSubgraph>
[src]

Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.

@param context

Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context} The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.

§
projectsLocationsMetadataStoresContextsRemoveContextChildren(context: string, req: GoogleCloudAiplatformV1RemoveContextChildrenRequest): Promise<GoogleCloudAiplatformV1RemoveContextChildrenResponse>
[src]

Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.

@param context

Required. The resource name of the parent Context. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}

§
projectsLocationsMetadataStoresCreate(parent: string, req: GoogleCloudAiplatformV1MetadataStore, opts?: ProjectsLocationsMetadataStoresCreateOptions): Promise<GoogleLongrunningOperation>
[src]

Initializes a MetadataStore, including allocation of resources.

@param parent

Required. The resource name of the Location where the MetadataStore should be created. Format: projects/{project}/locations/{location}/

§
projectsLocationsMetadataStoresDelete(name: string, opts?: ProjectsLocationsMetadataStoresDeleteOptions): Promise<GoogleLongrunningOperation>
[src]

Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).

@param name

Required. The resource name of the MetadataStore to delete. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

§
projectsLocationsMetadataStoresExecutionsAddExecutionEvents(execution: string, req: GoogleCloudAiplatformV1AddExecutionEventsRequest): Promise<GoogleCloudAiplatformV1AddExecutionEventsResponse>
[src]

Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.

@param execution

Required. The resource name of the Execution that the Events connect Artifacts with. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}

§
projectsLocationsMetadataStoresExecutionsCreate(parent: string, req: GoogleCloudAiplatformV1Execution, opts?: ProjectsLocationsMetadataStoresExecutionsCreateOptions): Promise<GoogleCloudAiplatformV1Execution>
[src]

Creates an Execution associated with a MetadataStore.

@param parent

Required. The resource name of the MetadataStore where the Execution should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

§
projectsLocationsMetadataStoresExecutionsDelete(name: string, opts?: ProjectsLocationsMetadataStoresExecutionsDeleteOptions): Promise<GoogleLongrunningOperation>
[src]

Deletes an Execution.

@param name

Required. The resource name of the Execution to delete. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}

§
projectsLocationsMetadataStoresExecutionsGet(name: string): Promise<GoogleCloudAiplatformV1Execution>
[src]

Retrieves a specific Execution.

@param name

Required. The resource name of the Execution to retrieve. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}

§
projectsLocationsMetadataStoresExecutionsList(parent: string, opts?: ProjectsLocationsMetadataStoresExecutionsListOptions): Promise<GoogleCloudAiplatformV1ListExecutionsResponse>
[src]

Lists Executions in the MetadataStore.

@param parent

Required. The MetadataStore whose Executions should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

§
projectsLocationsMetadataStoresExecutionsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsMetadataStoresExecutionsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsMetadataStoresExecutionsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsMetadataStoresExecutionsOperationsList(name: string, opts?: ProjectsLocationsMetadataStoresExecutionsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsMetadataStoresExecutionsOperationsWait(name: string, opts?: ProjectsLocationsMetadataStoresExecutionsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsMetadataStoresExecutionsPatch(name: string, req: GoogleCloudAiplatformV1Execution, opts?: ProjectsLocationsMetadataStoresExecutionsPatchOptions): Promise<GoogleCloudAiplatformV1Execution>
[src]

Updates a stored Execution.

@param name

Output only. The resource name of the Execution.

§
projectsLocationsMetadataStoresExecutionsPurge(parent: string, req: GoogleCloudAiplatformV1PurgeExecutionsRequest): Promise<GoogleLongrunningOperation>
[src]

Purges Executions.

@param parent

Required. The metadata store to purge Executions from. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

§
projectsLocationsMetadataStoresExecutionsQueryExecutionInputsAndOutputs(execution: string): Promise<GoogleCloudAiplatformV1LineageSubgraph>
[src]

Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.

@param execution

Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}

§
projectsLocationsMetadataStoresGet(name: string): Promise<GoogleCloudAiplatformV1MetadataStore>
[src]

Retrieves a specific MetadataStore.

@param name

Required. The resource name of the MetadataStore to retrieve. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

§
projectsLocationsMetadataStoresList(parent: string, opts?: ProjectsLocationsMetadataStoresListOptions): Promise<GoogleCloudAiplatformV1ListMetadataStoresResponse>
[src]

Lists MetadataStores for a Location.

@param parent

Required. The Location whose MetadataStores should be listed. Format: projects/{project}/locations/{location}

§
projectsLocationsMetadataStoresMetadataSchemasCreate(parent: string, req: GoogleCloudAiplatformV1MetadataSchema, opts?: ProjectsLocationsMetadataStoresMetadataSchemasCreateOptions): Promise<GoogleCloudAiplatformV1MetadataSchema>
[src]

Creates a MetadataSchema.

@param parent

Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

§
projectsLocationsMetadataStoresMetadataSchemasGet(name: string): Promise<GoogleCloudAiplatformV1MetadataSchema>
[src]

Retrieves a specific MetadataSchema.

@param name

Required. The resource name of the MetadataSchema to retrieve. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}

§
projectsLocationsMetadataStoresMetadataSchemasList(parent: string, opts?: ProjectsLocationsMetadataStoresMetadataSchemasListOptions): Promise<GoogleCloudAiplatformV1ListMetadataSchemasResponse>
[src]

Lists MetadataSchemas.

@param parent

Required. The MetadataStore whose MetadataSchemas should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

§
projectsLocationsMetadataStoresOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsMetadataStoresOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsMetadataStoresOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsMetadataStoresOperationsList(name: string, opts?: ProjectsLocationsMetadataStoresOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsMetadataStoresOperationsWait(name: string, opts?: ProjectsLocationsMetadataStoresOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsMigratableResourcesBatchMigrate(parent: string, req: GoogleCloudAiplatformV1BatchMigrateResourcesRequest): Promise<GoogleLongrunningOperation>
[src]

Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.

@param parent

Required. The location of the migrated resource will live in. Format: projects/{project}/locations/{location}

§
projectsLocationsMigratableResourcesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsMigratableResourcesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsMigratableResourcesOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsMigratableResourcesOperationsList(name: string, opts?: ProjectsLocationsMigratableResourcesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsMigratableResourcesOperationsWait(name: string, opts?: ProjectsLocationsMigratableResourcesOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsMigratableResourcesSearch(parent: string, req: GoogleCloudAiplatformV1SearchMigratableResourcesRequest): Promise<GoogleCloudAiplatformV1SearchMigratableResourcesResponse>
[src]

Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

@param parent

Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: projects/{project}/locations/{location}

§
projectsLocationsModelDeploymentMonitoringJobsCreate(parent: string, req: GoogleCloudAiplatformV1ModelDeploymentMonitoringJob): Promise<GoogleCloudAiplatformV1ModelDeploymentMonitoringJob>
[src]

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

@param parent

Required. The parent of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}

§
projectsLocationsModelDeploymentMonitoringJobsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a ModelDeploymentMonitoringJob.

@param name

Required. The resource name of the model monitoring job to delete. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

§
projectsLocationsModelDeploymentMonitoringJobsGet(name: string): Promise<GoogleCloudAiplatformV1ModelDeploymentMonitoringJob>
[src]

Gets a ModelDeploymentMonitoringJob.

@param name

Required. The resource name of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

§
projectsLocationsModelDeploymentMonitoringJobsList(parent: string, opts?: ProjectsLocationsModelDeploymentMonitoringJobsListOptions): Promise<GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse>
[src]

Lists ModelDeploymentMonitoringJobs in a Location.

@param parent

Required. The parent of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}

§
projectsLocationsModelDeploymentMonitoringJobsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsModelDeploymentMonitoringJobsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsModelDeploymentMonitoringJobsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsModelDeploymentMonitoringJobsOperationsList(name: string, opts?: ProjectsLocationsModelDeploymentMonitoringJobsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsModelDeploymentMonitoringJobsOperationsWait(name: string, opts?: ProjectsLocationsModelDeploymentMonitoringJobsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsModelDeploymentMonitoringJobsPatch(name: string, req: GoogleCloudAiplatformV1ModelDeploymentMonitoringJob, opts?: ProjectsLocationsModelDeploymentMonitoringJobsPatchOptions): Promise<GoogleLongrunningOperation>
[src]

Updates a ModelDeploymentMonitoringJob.

@param name

Output only. Resource name of a ModelDeploymentMonitoringJob.

§
projectsLocationsModelDeploymentMonitoringJobsPause(name: string, req: GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest): Promise<GoogleProtobufEmpty>
[src]

Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.

@param name

Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

§
projectsLocationsModelDeploymentMonitoringJobsResume(name: string, req: GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest): Promise<GoogleProtobufEmpty>
[src]

Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

@param name

Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

§
projectsLocationsModelDeploymentMonitoringJobsSearchModelDeploymentMonitoringStatsAnomalies(modelDeploymentMonitoringJob: string, req: GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest): Promise<GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse>
[src]

Searches Model Monitoring Statistics generated within a given time window.

@param modelDeploymentMonitoringJob

Required. ModelDeploymentMonitoring Job resource name. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

§
projectsLocationsModelsCopy(parent: string, req: GoogleCloudAiplatformV1CopyModelRequest): Promise<GoogleLongrunningOperation>
[src]

Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.

@param parent

Required. The resource name of the Location into which to copy the Model. Format: projects/{project}/locations/{location}

§
projectsLocationsModelsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.

@param name

Required. The name of the Model resource to be deleted. Format: projects/{project}/locations/{location}/models/{model}

§
projectsLocationsModelsDeleteVersion(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.

@param name

Required. The name of the model version to be deleted, with a version ID explicitly included. Example: projects/{project}/locations/{location}/models/{model}@1234

§
projectsLocationsModelsEvaluationsGet(name: string): Promise<GoogleCloudAiplatformV1ModelEvaluation>
[src]

Gets a ModelEvaluation.

@param name

Required. The name of the ModelEvaluation resource. Format: projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}

§
projectsLocationsModelsEvaluationsImport(parent: string, req: GoogleCloudAiplatformV1ImportModelEvaluationRequest): Promise<GoogleCloudAiplatformV1ModelEvaluation>
[src]

Imports an externally generated ModelEvaluation.

@param parent

Required. The name of the parent model resource. Format: projects/{project}/locations/{location}/models/{model}

§
projectsLocationsModelsEvaluationsList(parent: string, opts?: ProjectsLocationsModelsEvaluationsListOptions): Promise<GoogleCloudAiplatformV1ListModelEvaluationsResponse>
[src]

Lists ModelEvaluations in a Model.

@param parent

Required. The resource name of the Model to list the ModelEvaluations from. Format: projects/{project}/locations/{location}/models/{model}

§
projectsLocationsModelsEvaluationsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsModelsEvaluationsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsModelsEvaluationsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsModelsEvaluationsOperationsList(name: string, opts?: ProjectsLocationsModelsEvaluationsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsModelsEvaluationsOperationsWait(name: string, opts?: ProjectsLocationsModelsEvaluationsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsModelsEvaluationsSlicesBatchImport(parent: string, req: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest): Promise<GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse>
[src]

Imports a list of externally generated EvaluatedAnnotations.

@param parent

Required. The name of the parent ModelEvaluationSlice resource. Format: projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}

§
projectsLocationsModelsEvaluationsSlicesGet(name: string): Promise<GoogleCloudAiplatformV1ModelEvaluationSlice>
[src]

Gets a ModelEvaluationSlice.

@param name

Required. The name of the ModelEvaluationSlice resource. Format: projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}

§
projectsLocationsModelsEvaluationsSlicesList(parent: string, opts?: ProjectsLocationsModelsEvaluationsSlicesListOptions): Promise<GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse>
[src]

Lists ModelEvaluationSlices in a ModelEvaluation.

@param parent

Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}

§
projectsLocationsModelsExport(name: string, req: GoogleCloudAiplatformV1ExportModelRequest): Promise<GoogleLongrunningOperation>
[src]

Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.

@param name

Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported.

§
projectsLocationsModelsGet(name: string): Promise<GoogleCloudAiplatformV1Model>
[src]

Gets a Model.

@param name

Required. The name of the Model resource. Format: projects/{project}/locations/{location}/models/{model} In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: projects/{project}/locations/{location}/models/{model}@2 or projects/{project}/locations/{location}/models/{model}@golden If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.

§
projectsLocationsModelsGetIamPolicy(resource: string, opts?: ProjectsLocationsModelsGetIamPolicyOptions): Promise<GoogleIamV1Policy>
[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsModelsList(parent: string, opts?: ProjectsLocationsModelsListOptions): Promise<GoogleCloudAiplatformV1ListModelsResponse>
[src]

Lists Models in a Location.

@param parent

Required. The resource name of the Location to list the Models from. Format: projects/{project}/locations/{location}

§
projectsLocationsModelsListVersions(name: string, opts?: ProjectsLocationsModelsListVersionsOptions): Promise<GoogleCloudAiplatformV1ListModelVersionsResponse>
[src]

Lists versions of the specified model.

@param name

Required. The name of the model to list versions for.

§
projectsLocationsModelsMergeVersionAliases(name: string, req: GoogleCloudAiplatformV1MergeVersionAliasesRequest): Promise<GoogleCloudAiplatformV1Model>
[src]

Merges a set of aliases for a Model version.

@param name

Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: projects/{project}/locations/{location}/models/{model}@1234

§
projectsLocationsModelsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsModelsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsModelsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsModelsOperationsList(name: string, opts?: ProjectsLocationsModelsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsModelsOperationsWait(name: string, opts?: ProjectsLocationsModelsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsModelsPatch(name: string, req: GoogleCloudAiplatformV1Model, opts?: ProjectsLocationsModelsPatchOptions): Promise<GoogleCloudAiplatformV1Model>
[src]

Updates a Model.

@param name

The resource name of the Model.

§
projectsLocationsModelsSetIamPolicy(resource: string, req: GoogleIamV1SetIamPolicyRequest): Promise<GoogleIamV1Policy>
[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

§
projectsLocationsModelsTestIamPermissions(resource: string, opts?: ProjectsLocationsModelsTestIamPermissionsOptions): Promise<GoogleIamV1TestIamPermissionsResponse>
[src]

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsModelsUpdateExplanationDataset(model: string, req: GoogleCloudAiplatformV1UpdateExplanationDatasetRequest): Promise<GoogleLongrunningOperation>
[src]

Incrementally update the dataset used for an examples model.

@param model

Required. The resource name of the Model to update. Format: projects/{project}/locations/{location}/models/{model}

§
projectsLocationsModelsUpload(parent: string, req: GoogleCloudAiplatformV1UploadModelRequest): Promise<GoogleLongrunningOperation>
[src]

Uploads a Model artifact into Vertex AI.

@param parent

Required. The resource name of the Location into which to upload the Model. Format: projects/{project}/locations/{location}

§
projectsLocationsNasJobsCancel(name: string, req: GoogleCloudAiplatformV1CancelNasJobRequest): Promise<GoogleProtobufEmpty>
[src]

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 JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and NasJob.state is set to CANCELLED.

@param name

Required. The name of the NasJob to cancel. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

§
projectsLocationsNasJobsCreate(parent: string, req: GoogleCloudAiplatformV1NasJob): Promise<GoogleCloudAiplatformV1NasJob>
[src]

Creates a NasJob

@param parent

Required. The resource name of the Location to create the NasJob in. Format: projects/{project}/locations/{location}

§
projectsLocationsNasJobsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a NasJob.

@param name

Required. The name of the NasJob resource to be deleted. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

§
projectsLocationsNasJobsGet(name: string): Promise<GoogleCloudAiplatformV1NasJob>
[src]

Gets a NasJob

@param name

Required. The name of the NasJob resource. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

§
projectsLocationsNasJobsList(parent: string, opts?: ProjectsLocationsNasJobsListOptions): Promise<GoogleCloudAiplatformV1ListNasJobsResponse>
[src]

Lists NasJobs in a Location.

@param parent

Required. The resource name of the Location to list the NasJobs from. Format: projects/{project}/locations/{location}

§
projectsLocationsNasJobsNasTrialDetailsGet(name: string): Promise<GoogleCloudAiplatformV1NasTrialDetail>
[src]

Gets a NasTrialDetail.

@param name

Required. The name of the NasTrialDetail resource. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}

§
projectsLocationsNasJobsNasTrialDetailsList(parent: string, opts?: ProjectsLocationsNasJobsNasTrialDetailsListOptions): Promise<GoogleCloudAiplatformV1ListNasTrialDetailsResponse>
[src]

List top NasTrialDetails of a NasJob.

@param parent

Required. The name of the NasJob resource. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

§
projectsLocationsNotebookRuntimesAssign(parent: string, req: GoogleCloudAiplatformV1AssignNotebookRuntimeRequest): Promise<GoogleLongrunningOperation>
[src]

Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.

@param parent

Required. The resource name of the Location to get the NotebookRuntime assignment. Format: projects/{project}/locations/{location}

§
projectsLocationsNotebookRuntimesDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a NotebookRuntime.

@param name

Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

§
projectsLocationsNotebookRuntimesGet(name: string): Promise<GoogleCloudAiplatformV1NotebookRuntime>
[src]

Gets a NotebookRuntime.

@param name

Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

§
projectsLocationsNotebookRuntimesList(parent: string, opts?: ProjectsLocationsNotebookRuntimesListOptions): Promise<GoogleCloudAiplatformV1ListNotebookRuntimesResponse>
[src]

Lists NotebookRuntimes in a Location.

@param parent

Required. The resource name of the Location from which to list the NotebookRuntimes. Format: projects/{project}/locations/{location}

§
projectsLocationsNotebookRuntimesStart(name: string, req: GoogleCloudAiplatformV1StartNotebookRuntimeRequest): Promise<GoogleLongrunningOperation>
[src]

Starts a NotebookRuntime.

@param name

Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

§
projectsLocationsNotebookRuntimesUpgrade(name: string, req: GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest): Promise<GoogleLongrunningOperation>
[src]

Upgrades a NotebookRuntime.

@param name

Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

§
projectsLocationsNotebookRuntimeTemplatesCreate(parent: string, req: GoogleCloudAiplatformV1NotebookRuntimeTemplate, opts?: ProjectsLocationsNotebookRuntimeTemplatesCreateOptions): Promise<GoogleLongrunningOperation>
[src]

Creates a NotebookRuntimeTemplate.

@param parent

Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: projects/{project}/locations/{location}

§
projectsLocationsNotebookRuntimeTemplatesDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a NotebookRuntimeTemplate.

@param name

Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}

§
projectsLocationsNotebookRuntimeTemplatesGet(name: string): Promise<GoogleCloudAiplatformV1NotebookRuntimeTemplate>
[src]

Gets a NotebookRuntimeTemplate.

@param name

Required. The name of the NotebookRuntimeTemplate resource. Format: projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}

§
projectsLocationsNotebookRuntimeTemplatesGetIamPolicy(resource: string, opts?: ProjectsLocationsNotebookRuntimeTemplatesGetIamPolicyOptions): Promise<GoogleIamV1Policy>
[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsNotebookRuntimeTemplatesList(parent: string, opts?: ProjectsLocationsNotebookRuntimeTemplatesListOptions): Promise<GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse>
[src]

Lists NotebookRuntimeTemplates in a Location.

@param parent

Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: projects/{project}/locations/{location}

§
projectsLocationsNotebookRuntimeTemplatesSetIamPolicy(resource: string, req: GoogleIamV1SetIamPolicyRequest): Promise<GoogleIamV1Policy>
[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

§
projectsLocationsNotebookRuntimeTemplatesTestIamPermissions(resource: string, opts?: ProjectsLocationsNotebookRuntimeTemplatesTestIamPermissionsOptions): Promise<GoogleIamV1TestIamPermissionsResponse>
[src]

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsOperationsWait(name: string, opts?: ProjectsLocationsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsPersistentResourcesCreate(parent: string, req: GoogleCloudAiplatformV1PersistentResource, opts?: ProjectsLocationsPersistentResourcesCreateOptions): Promise<GoogleLongrunningOperation>
[src]

Creates a PersistentResource.

@param parent

Required. The resource name of the Location to create the PersistentResource in. Format: projects/{project}/locations/{location}

§
projectsLocationsPersistentResourcesDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a PersistentResource.

@param name

Required. The name of the PersistentResource to be deleted. Format: projects/{project}/locations/{location}/persistentResources/{persistent_resource}

§
projectsLocationsPersistentResourcesGet(name: string): Promise<GoogleCloudAiplatformV1PersistentResource>
[src]

Gets a PersistentResource.

@param name

Required. The name of the PersistentResource resource. Format: projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}

§
projectsLocationsPersistentResourcesList(parent: string, opts?: ProjectsLocationsPersistentResourcesListOptions): Promise<GoogleCloudAiplatformV1ListPersistentResourcesResponse>
[src]

Lists PersistentResources in a Location.

@param parent

Required. The resource name of the Location to list the PersistentResources from. Format: projects/{project}/locations/{location}

§
projectsLocationsPersistentResourcesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsPersistentResourcesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsPersistentResourcesOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsPersistentResourcesOperationsList(name: string, opts?: ProjectsLocationsPersistentResourcesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsPersistentResourcesOperationsWait(name: string, opts?: ProjectsLocationsPersistentResourcesOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsPersistentResourcesPatch(name: string, req: GoogleCloudAiplatformV1PersistentResource, opts?: ProjectsLocationsPersistentResourcesPatchOptions): Promise<GoogleLongrunningOperation>
[src]

Updates a PersistentResource.

@param name

Immutable. Resource name of a PersistentResource.

§
projectsLocationsPersistentResourcesReboot(name: string, req: GoogleCloudAiplatformV1RebootPersistentResourceRequest): Promise<GoogleLongrunningOperation>
[src]

Reboots a PersistentResource.

@param name

Required. The name of the PersistentResource resource. Format: projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}

§
projectsLocationsPipelineJobsBatchCancel(parent: string, req: GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest): Promise<GoogleLongrunningOperation>
[src]

Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.

@param parent

Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}

§
projectsLocationsPipelineJobsBatchDelete(parent: string, req: GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest): Promise<GoogleLongrunningOperation>
[src]

Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.

@param parent

Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}

§
projectsLocationsPipelineJobsCancel(name: string, req: GoogleCloudAiplatformV1CancelPipelineJobRequest): Promise<GoogleProtobufEmpty>
[src]

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

@param name

Required. The name of the PipelineJob to cancel. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

§
projectsLocationsPipelineJobsCreate(parent: string, req: GoogleCloudAiplatformV1PipelineJob, opts?: ProjectsLocationsPipelineJobsCreateOptions): Promise<GoogleCloudAiplatformV1PipelineJob>
[src]

Creates a PipelineJob. A PipelineJob will run immediately when created.

@param parent

Required. The resource name of the Location to create the PipelineJob in. Format: projects/{project}/locations/{location}

§
projectsLocationsPipelineJobsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a PipelineJob.

@param name

Required. The name of the PipelineJob resource to be deleted. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

§
projectsLocationsPipelineJobsGet(name: string): Promise<GoogleCloudAiplatformV1PipelineJob>
[src]

Gets a PipelineJob.

@param name

Required. The name of the PipelineJob resource. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

§
projectsLocationsPipelineJobsList(parent: string, opts?: ProjectsLocationsPipelineJobsListOptions): Promise<GoogleCloudAiplatformV1ListPipelineJobsResponse>
[src]

Lists PipelineJobs in a Location.

@param parent

Required. The resource name of the Location to list the PipelineJobs from. Format: projects/{project}/locations/{location}

§
projectsLocationsPipelineJobsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsPipelineJobsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsPipelineJobsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsPipelineJobsOperationsList(name: string, opts?: ProjectsLocationsPipelineJobsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsPipelineJobsOperationsWait(name: string, opts?: ProjectsLocationsPipelineJobsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsPublishersModelsComputeTokens(endpoint: string, req: GoogleCloudAiplatformV1ComputeTokensRequest): Promise<GoogleCloudAiplatformV1ComputeTokensResponse>
[src]

Return a list of tokens based on the input text.

@param endpoint

Required. The name of the Endpoint requested to get lists of tokens and token ids.

§
projectsLocationsPublishersModelsCountTokens(endpoint: string, req: GoogleCloudAiplatformV1CountTokensRequest): Promise<GoogleCloudAiplatformV1CountTokensResponse>
[src]

Perform a token counting.

@param endpoint

Required. The name of the Endpoint requested to perform token counting. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsPublishersModelsGenerateContent(model: string, req: GoogleCloudAiplatformV1GenerateContentRequest): Promise<GoogleCloudAiplatformV1GenerateContentResponse>
[src]
§
projectsLocationsPublishersModelsPredict(endpoint: string, req: GoogleCloudAiplatformV1PredictRequest): Promise<GoogleCloudAiplatformV1PredictResponse>
[src]

Perform an online prediction.

@param endpoint

Required. The name of the Endpoint requested to serve the prediction. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsPublishersModelsRawPredict(endpoint: string, req: GoogleCloudAiplatformV1RawPredictRequest): Promise<GoogleApiHttpBody>
[src]

Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * X-Vertex-AI-Endpoint-Id: ID of the Endpoint that served this prediction. * X-Vertex-AI-Deployed-Model-Id: ID of the Endpoint's DeployedModel that served this prediction.

@param endpoint

Required. The name of the Endpoint requested to serve the prediction. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsPublishersModelsServerStreamingPredict(endpoint: string, req: GoogleCloudAiplatformV1StreamingPredictRequest): Promise<GoogleCloudAiplatformV1StreamingPredictResponse>
[src]

Perform a server-side streaming online prediction request for Vertex LLM streaming.

@param endpoint

Required. The name of the Endpoint requested to serve the prediction. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsPublishersModelsStreamGenerateContent(model: string, req: GoogleCloudAiplatformV1GenerateContentRequest): Promise<GoogleCloudAiplatformV1GenerateContentResponse>
[src]
§
projectsLocationsPublishersModelsStreamRawPredict(endpoint: string, req: GoogleCloudAiplatformV1StreamRawPredictRequest): Promise<GoogleApiHttpBody>
[src]

Perform a streaming online prediction with an arbitrary HTTP payload.

@param endpoint

Required. The name of the Endpoint requested to serve the prediction. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

§
projectsLocationsSchedulesCreate(parent: string, req: GoogleCloudAiplatformV1Schedule): Promise<GoogleCloudAiplatformV1Schedule>
[src]

Creates a Schedule.

@param parent

Required. The resource name of the Location to create the Schedule in. Format: projects/{project}/locations/{location}

§
projectsLocationsSchedulesDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a Schedule.

@param name

Required. The name of the Schedule resource to be deleted. Format: projects/{project}/locations/{location}/schedules/{schedule}

§
projectsLocationsSchedulesGet(name: string): Promise<GoogleCloudAiplatformV1Schedule>
[src]

Gets a Schedule.

@param name

Required. The name of the Schedule resource. Format: projects/{project}/locations/{location}/schedules/{schedule}

§
projectsLocationsSchedulesList(parent: string, opts?: ProjectsLocationsSchedulesListOptions): Promise<GoogleCloudAiplatformV1ListSchedulesResponse>
[src]

Lists Schedules in a Location.

@param parent

Required. The resource name of the Location to list the Schedules from. Format: projects/{project}/locations/{location}

§
projectsLocationsSchedulesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsSchedulesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsSchedulesOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsSchedulesOperationsList(name: string, opts?: ProjectsLocationsSchedulesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsSchedulesOperationsWait(name: string, opts?: ProjectsLocationsSchedulesOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsSchedulesPatch(name: string, req: GoogleCloudAiplatformV1Schedule, opts?: ProjectsLocationsSchedulesPatchOptions): Promise<GoogleCloudAiplatformV1Schedule>
[src]

Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.

@param name

Immutable. The resource name of the Schedule.

§
projectsLocationsSchedulesPause(name: string, req: GoogleCloudAiplatformV1PauseScheduleRequest): Promise<GoogleProtobufEmpty>
[src]

Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.

@param name

Required. The name of the Schedule resource to be paused. Format: projects/{project}/locations/{location}/schedules/{schedule}

§
projectsLocationsSchedulesResume(name: string, req: GoogleCloudAiplatformV1ResumeScheduleRequest): Promise<GoogleProtobufEmpty>
[src]

Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catchUp is set up true, all missed runs will be scheduled for backfill first.

@param name

Required. The name of the Schedule resource to be resumed. Format: projects/{project}/locations/{location}/schedules/{schedule}

§
projectsLocationsSpecialistPoolsCreate(parent: string, req: GoogleCloudAiplatformV1SpecialistPool): Promise<GoogleLongrunningOperation>
[src]

Creates a SpecialistPool.

@param parent

Required. The parent Project name for the new SpecialistPool. The form is projects/{project}/locations/{location}.

§
projectsLocationsSpecialistPoolsDelete(name: string, opts?: ProjectsLocationsSpecialistPoolsDeleteOptions): Promise<GoogleLongrunningOperation>
[src]

Deletes a SpecialistPool as well as all Specialists in the pool.

@param name

Required. The resource name of the SpecialistPool to delete. Format: projects/{project}/locations/{location}/specialistPools/{specialist_pool}

§
projectsLocationsSpecialistPoolsGet(name: string): Promise<GoogleCloudAiplatformV1SpecialistPool>
[src]

Gets a SpecialistPool.

@param name

Required. The name of the SpecialistPool resource. The form is projects/{project}/locations/{location}/specialistPools/{specialist_pool}.

§
projectsLocationsSpecialistPoolsList(parent: string, opts?: ProjectsLocationsSpecialistPoolsListOptions): Promise<GoogleCloudAiplatformV1ListSpecialistPoolsResponse>
[src]

Lists SpecialistPools in a Location.

@param parent

Required. The name of the SpecialistPool's parent resource. Format: projects/{project}/locations/{location}

§
projectsLocationsSpecialistPoolsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsSpecialistPoolsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsSpecialistPoolsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsSpecialistPoolsOperationsList(name: string, opts?: ProjectsLocationsSpecialistPoolsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsSpecialistPoolsOperationsWait(name: string, opts?: ProjectsLocationsSpecialistPoolsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsSpecialistPoolsPatch(name: string, req: GoogleCloudAiplatformV1SpecialistPool, opts?: ProjectsLocationsSpecialistPoolsPatchOptions): Promise<GoogleLongrunningOperation>
[src]

Updates a SpecialistPool.

@param name

Required. The resource name of the SpecialistPool.

§
projectsLocationsStudiesCreate(parent: string, req: GoogleCloudAiplatformV1Study): Promise<GoogleCloudAiplatformV1Study>
[src]

Creates a Study. A resource name will be generated after creation of the Study.

@param parent

Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}

§
projectsLocationsStudiesDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a Study.

@param name

Required. The name of the Study resource to be deleted. Format: projects/{project}/locations/{location}/studies/{study}

§
projectsLocationsStudiesGet(name: string): Promise<GoogleCloudAiplatformV1Study>
[src]

Gets a Study by name.

@param name

Required. The name of the Study resource. Format: projects/{project}/locations/{location}/studies/{study}

§
projectsLocationsStudiesList(parent: string, opts?: ProjectsLocationsStudiesListOptions): Promise<GoogleCloudAiplatformV1ListStudiesResponse>
[src]

Lists all the studies in a region for an associated project.

@param parent

Required. The resource name of the Location to list the Study from. Format: projects/{project}/locations/{location}

§
projectsLocationsStudiesLookup(parent: string, req: GoogleCloudAiplatformV1LookupStudyRequest): Promise<GoogleCloudAiplatformV1Study>
[src]

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

@param parent

Required. The resource name of the Location to get the Study from. Format: projects/{project}/locations/{location}

§
projectsLocationsStudiesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsStudiesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsStudiesOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsStudiesOperationsList(name: string, opts?: ProjectsLocationsStudiesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsStudiesOperationsWait(name: string, opts?: ProjectsLocationsStudiesOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsStudiesTrialsAddTrialMeasurement(trialName: string, req: GoogleCloudAiplatformV1AddTrialMeasurementRequest): Promise<GoogleCloudAiplatformV1Trial>
[src]

Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.

@param trialName

Required. The name of the trial to add measurement. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

§
projectsLocationsStudiesTrialsCheckTrialEarlyStoppingState(trialName: string, req: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest): Promise<GoogleLongrunningOperation>
[src]

Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.

@param trialName

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

§
projectsLocationsStudiesTrialsComplete(name: string, req: GoogleCloudAiplatformV1CompleteTrialRequest): Promise<GoogleCloudAiplatformV1Trial>
[src]

Marks a Trial as complete.

@param name

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

§
projectsLocationsStudiesTrialsCreate(parent: string, req: GoogleCloudAiplatformV1Trial): Promise<GoogleCloudAiplatformV1Trial>
[src]

Adds a user provided Trial to a Study.

@param parent

Required. The resource name of the Study to create the Trial in. Format: projects/{project}/locations/{location}/studies/{study}

§
projectsLocationsStudiesTrialsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a Trial.

@param name

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

§
projectsLocationsStudiesTrialsGet(name: string): Promise<GoogleCloudAiplatformV1Trial>
[src]

Gets a Trial.

@param name

Required. The name of the Trial resource. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

§
projectsLocationsStudiesTrialsList(parent: string, opts?: ProjectsLocationsStudiesTrialsListOptions): Promise<GoogleCloudAiplatformV1ListTrialsResponse>
[src]

Lists the Trials associated with a Study.

@param parent

Required. The resource name of the Study to list the Trial from. Format: projects/{project}/locations/{location}/studies/{study}

§
projectsLocationsStudiesTrialsListOptimalTrials(parent: string, req: GoogleCloudAiplatformV1ListOptimalTrialsRequest): Promise<GoogleCloudAiplatformV1ListOptimalTrialsResponse>
[src]

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

@param parent

Required. The name of the Study that the optimal Trial belongs to.

§
projectsLocationsStudiesTrialsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsStudiesTrialsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsStudiesTrialsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsStudiesTrialsOperationsList(name: string, opts?: ProjectsLocationsStudiesTrialsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsStudiesTrialsOperationsWait(name: string, opts?: ProjectsLocationsStudiesTrialsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsStudiesTrialsStop(name: string, req: GoogleCloudAiplatformV1StopTrialRequest): Promise<GoogleCloudAiplatformV1Trial>
[src]

Stops a Trial.

@param name

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

§
projectsLocationsStudiesTrialsSuggest(parent: string, req: GoogleCloudAiplatformV1SuggestTrialsRequest): Promise<GoogleLongrunningOperation>
[src]

Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.

@param parent

Required. The project and location that the Study belongs to. Format: projects/{project}/locations/{location}/studies/{study}

§
projectsLocationsTensorboardsBatchRead(tensorboard: string, opts?: ProjectsLocationsTensorboardsBatchReadOptions): Promise<GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse>
[src]

Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.

@param tensorboard

Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.

§
projectsLocationsTensorboardsCreate(parent: string, req: GoogleCloudAiplatformV1Tensorboard): Promise<GoogleLongrunningOperation>
[src]

Creates a Tensorboard.

@param parent

Required. The resource name of the Location to create the Tensorboard in. Format: projects/{project}/locations/{location}

§
projectsLocationsTensorboardsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a Tensorboard.

@param name

Required. The name of the Tensorboard to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

§
projectsLocationsTensorboardsExperimentsBatchCreate(parent: string, req: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest): Promise<GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse>
[src]

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

@param parent

Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.

§
projectsLocationsTensorboardsExperimentsCreate(parent: string, req: GoogleCloudAiplatformV1TensorboardExperiment, opts?: ProjectsLocationsTensorboardsExperimentsCreateOptions): Promise<GoogleCloudAiplatformV1TensorboardExperiment>
[src]

Creates a TensorboardExperiment.

@param parent

Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

§
projectsLocationsTensorboardsExperimentsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a TensorboardExperiment.

@param name

Required. The name of the TensorboardExperiment to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

§
projectsLocationsTensorboardsExperimentsGet(name: string): Promise<GoogleCloudAiplatformV1TensorboardExperiment>
[src]

Gets a TensorboardExperiment.

@param name

Required. The name of the TensorboardExperiment resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

§
projectsLocationsTensorboardsExperimentsList(parent: string, opts?: ProjectsLocationsTensorboardsExperimentsListOptions): Promise<GoogleCloudAiplatformV1ListTensorboardExperimentsResponse>
[src]

Lists TensorboardExperiments in a Location.

@param parent

Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

§
projectsLocationsTensorboardsExperimentsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsTensorboardsExperimentsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsTensorboardsExperimentsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsTensorboardsExperimentsOperationsList(name: string, opts?: ProjectsLocationsTensorboardsExperimentsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsTensorboardsExperimentsOperationsWait(name: string, opts?: ProjectsLocationsTensorboardsExperimentsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsTensorboardsExperimentsPatch(name: string, req: GoogleCloudAiplatformV1TensorboardExperiment, opts?: ProjectsLocationsTensorboardsExperimentsPatchOptions): Promise<GoogleCloudAiplatformV1TensorboardExperiment>
[src]

Updates a TensorboardExperiment.

@param name

Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

§
projectsLocationsTensorboardsExperimentsRunsBatchCreate(parent: string, req: GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest): Promise<GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse>
[src]

Batch create TensorboardRuns.

@param parent

Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} The parent field in the CreateTensorboardRunRequest messages must match this field.

§
projectsLocationsTensorboardsExperimentsRunsCreate(parent: string, req: GoogleCloudAiplatformV1TensorboardRun, opts?: ProjectsLocationsTensorboardsExperimentsRunsCreateOptions): Promise<GoogleCloudAiplatformV1TensorboardRun>
[src]

Creates a TensorboardRun.

@param parent

Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

§
projectsLocationsTensorboardsExperimentsRunsDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a TensorboardRun.

@param name

Required. The name of the TensorboardRun to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

§
projectsLocationsTensorboardsExperimentsRunsGet(name: string): Promise<GoogleCloudAiplatformV1TensorboardRun>
[src]

Gets a TensorboardRun.

@param name

Required. The name of the TensorboardRun resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

§
projectsLocationsTensorboardsExperimentsRunsList(parent: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsListOptions): Promise<GoogleCloudAiplatformV1ListTensorboardRunsResponse>
[src]

Lists TensorboardRuns in a Location.

@param parent

Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

§
projectsLocationsTensorboardsExperimentsRunsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsTensorboardsExperimentsRunsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsTensorboardsExperimentsRunsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsTensorboardsExperimentsRunsOperationsList(name: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsTensorboardsExperimentsRunsOperationsWait(name: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsTensorboardsExperimentsRunsPatch(name: string, req: GoogleCloudAiplatformV1TensorboardRun, opts?: ProjectsLocationsTensorboardsExperimentsRunsPatchOptions): Promise<GoogleCloudAiplatformV1TensorboardRun>
[src]

Updates a TensorboardRun.

@param name

Output only. Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

§
projectsLocationsTensorboardsExperimentsRunsTimeSeriesCreate(parent: string, req: GoogleCloudAiplatformV1TensorboardTimeSeries, opts?: ProjectsLocationsTensorboardsExperimentsRunsTimeSeriesCreateOptions): Promise<GoogleCloudAiplatformV1TensorboardTimeSeries>
[src]

Creates a TensorboardTimeSeries.

@param parent

Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

§
projectsLocationsTensorboardsExperimentsRunsTimeSeriesDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a TensorboardTimeSeries.

@param name

Required. The name of the TensorboardTimeSeries to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

§
projectsLocationsTensorboardsExperimentsRunsTimeSeriesExportTensorboardTimeSeries(tensorboardTimeSeries: string, req: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest): Promise<GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse>
[src]

Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.

@param tensorboardTimeSeries

Required. The resource name of the TensorboardTimeSeries to export data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

§
projectsLocationsTensorboardsExperimentsRunsTimeSeriesGet(name: string): Promise<GoogleCloudAiplatformV1TensorboardTimeSeries>
[src]

Gets a TensorboardTimeSeries.

@param name

Required. The name of the TensorboardTimeSeries resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

§
projectsLocationsTensorboardsExperimentsRunsTimeSeriesList(parent: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsTimeSeriesListOptions): Promise<GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse>
[src]

Lists TensorboardTimeSeries in a Location.

@param parent

Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

§
projectsLocationsTensorboardsExperimentsRunsTimeSeriesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsTensorboardsExperimentsRunsTimeSeriesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsTensorboardsExperimentsRunsTimeSeriesOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsTensorboardsExperimentsRunsTimeSeriesOperationsList(name: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsTimeSeriesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsTensorboardsExperimentsRunsTimeSeriesOperationsWait(name: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsTimeSeriesOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsTensorboardsExperimentsRunsTimeSeriesPatch(name: string, req: GoogleCloudAiplatformV1TensorboardTimeSeries, opts?: ProjectsLocationsTensorboardsExperimentsRunsTimeSeriesPatchOptions): Promise<GoogleCloudAiplatformV1TensorboardTimeSeries>
[src]

Updates a TensorboardTimeSeries.

@param name

Output only. Name of the TensorboardTimeSeries.

§
projectsLocationsTensorboardsExperimentsRunsTimeSeriesRead(tensorboardTimeSeries: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsTimeSeriesReadOptions): Promise<GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse>
[src]

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

@param tensorboardTimeSeries

Required. The resource name of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

§
projectsLocationsTensorboardsExperimentsRunsTimeSeriesReadBlobData(timeSeries: string, opts?: ProjectsLocationsTensorboardsExperimentsRunsTimeSeriesReadBlobDataOptions): Promise<GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse>
[src]

Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.

@param timeSeries

Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

§
projectsLocationsTensorboardsExperimentsRunsWrite(tensorboardRun: string, req: GoogleCloudAiplatformV1WriteTensorboardRunDataRequest): Promise<GoogleCloudAiplatformV1WriteTensorboardRunDataResponse>
[src]

Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.

@param tensorboardRun

Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

§
projectsLocationsTensorboardsExperimentsWrite(tensorboardExperiment: string, req: GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest): Promise<GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse>
[src]

Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.

@param tensorboardExperiment

Required. The resource name of the TensorboardExperiment to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

§
projectsLocationsTensorboardsGet(name: string): Promise<GoogleCloudAiplatformV1Tensorboard>
[src]

Gets a Tensorboard.

@param name

Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

§
projectsLocationsTensorboardsList(parent: string, opts?: ProjectsLocationsTensorboardsListOptions): Promise<GoogleCloudAiplatformV1ListTensorboardsResponse>
[src]

Lists Tensorboards in a Location.

@param parent

Required. The resource name of the Location to list Tensorboards. Format: projects/{project}/locations/{location}

§
projectsLocationsTensorboardsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsTensorboardsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsTensorboardsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsTensorboardsOperationsList(name: string, opts?: ProjectsLocationsTensorboardsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsTensorboardsOperationsWait(name: string, opts?: ProjectsLocationsTensorboardsOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsTensorboardsPatch(name: string, req: GoogleCloudAiplatformV1Tensorboard, opts?: ProjectsLocationsTensorboardsPatchOptions): Promise<GoogleLongrunningOperation>
[src]

Updates a Tensorboard.

@param name

Output only. Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

§
projectsLocationsTensorboardsReadSize(tensorboard: string): Promise<GoogleCloudAiplatformV1ReadTensorboardSizeResponse>
[src]

Returns the storage size for a given TensorBoard instance.

@param tensorboard

Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

§
projectsLocationsTensorboardsReadUsage(tensorboard: string): Promise<GoogleCloudAiplatformV1ReadTensorboardUsageResponse>
[src]

Returns a list of monthly active users for a given TensorBoard instance.

@param tensorboard

Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

§
projectsLocationsTrainingPipelinesCancel(name: string, req: GoogleCloudAiplatformV1CancelTrainingPipelineRequest): Promise<GoogleProtobufEmpty>
[src]

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

@param name

Required. The name of the TrainingPipeline to cancel. Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

§
projectsLocationsTrainingPipelinesCreate(parent: string, req: GoogleCloudAiplatformV1TrainingPipeline): Promise<GoogleCloudAiplatformV1TrainingPipeline>
[src]

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

@param parent

Required. The resource name of the Location to create the TrainingPipeline in. Format: projects/{project}/locations/{location}

§
projectsLocationsTrainingPipelinesDelete(name: string): Promise<GoogleLongrunningOperation>
[src]

Deletes a TrainingPipeline.

@param name

Required. The name of the TrainingPipeline resource to be deleted. Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

§
projectsLocationsTrainingPipelinesGet(name: string): Promise<GoogleCloudAiplatformV1TrainingPipeline>
[src]

Gets a TrainingPipeline.

@param name

Required. The name of the TrainingPipeline resource. Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

§
projectsLocationsTrainingPipelinesList(parent: string, opts?: ProjectsLocationsTrainingPipelinesListOptions): Promise<GoogleCloudAiplatformV1ListTrainingPipelinesResponse>
[src]

Lists TrainingPipelines in a Location.

@param parent

Required. The resource name of the Location to list the TrainingPipelines from. Format: projects/{project}/locations/{location}

§
projectsLocationsTrainingPipelinesOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsTrainingPipelinesOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsTrainingPipelinesOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsTrainingPipelinesOperationsList(name: string, opts?: ProjectsLocationsTrainingPipelinesOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsTrainingPipelinesOperationsWait(name: string, opts?: ProjectsLocationsTrainingPipelinesOperationsWaitOptions): Promise<GoogleLongrunningOperation>
[src]

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

@param name

The name of the operation resource to wait on.

§
projectsLocationsTuningJobsCancel(name: string, req: GoogleCloudAiplatformV1CancelTuningJobRequest): Promise<GoogleProtobufEmpty>
[src]

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

@param name

Required. The name of the TuningJob to cancel. Format: projects/{project}/locations/{location}/tuningJobs/{tuning_job}

§
projectsLocationsTuningJobsCreate(parent: string, req: GoogleCloudAiplatformV1TuningJob): Promise<GoogleCloudAiplatformV1TuningJob>
[src]

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

@param parent

Required. The resource name of the Location to create the TuningJob in. Format: projects/{project}/locations/{location}

§
projectsLocationsTuningJobsGet(name: string): Promise<GoogleCloudAiplatformV1TuningJob>
[src]

Gets a TuningJob.

@param name

Required. The name of the TuningJob resource. Format: projects/{project}/locations/{location}/tuningJobs/{tuning_job}

§
projectsLocationsTuningJobsList(parent: string, opts?: ProjectsLocationsTuningJobsListOptions): Promise<GoogleCloudAiplatformV1ListTuningJobsResponse>
[src]

Lists TuningJobs in a Location.

@param parent

Required. The resource name of the Location to list the TuningJobs from. Format: projects/{project}/locations/{location}

§
projectsLocationsTuningJobsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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 Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsTuningJobsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsTuningJobsOperationsList(name: string, opts?: ProjectsLocationsTuningJobsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
publishersModelsGet(name: string, opts?: PublishersModelsGetOptions): Promise<GoogleCloudAiplatformV1PublisherModel>
[src]

Gets a Model Garden publisher model.

@param name

Required. The name of the PublisherModel resource. Format: publishers/{publisher}/models/{publisher_model}