google-cloud-aiplatform overview (3.25.0) Stay organized with collections Save and categorize content based on your preferences.
- 3.84.0 (latest)
- 3.83.0
- 3.82.0
- 3.81.0
- 3.79.0
- 3.77.0
- 3.76.0
- 3.75.0
- 3.74.0
- 3.73.0
- 3.71.0
- 3.69.0
- 3.68.0
- 3.65.0
- 3.64.0
- 3.63.0
- 3.61.0
- 3.60.0
- 3.59.0
- 3.58.0
- 3.57.0
- 3.56.0
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
com.google.cloud.aiplatform.util
com.google.cloud.aiplatform.v1
A client to Vertex AI API
The interfaces provided are listed below, along with usage samples.
DatasetServiceClient
Service Description: The service that manages Vertex AI Dataset and its child resources.
Sample for DatasetServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(DatasetServiceClientdatasetServiceClient=DatasetServiceClient.create()){DatasetNamename=DatasetName.of("[PROJECT]","[LOCATION]","[DATASET]");Datasetresponse=datasetServiceClient.getDataset(name);}EndpointServiceClient
Service Description: A service for managing Vertex AI's Endpoints.
Sample for EndpointServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(EndpointServiceClientendpointServiceClient=EndpointServiceClient.create()){EndpointNamename=EndpointName.ofProjectLocationEndpointName("[PROJECT]","[LOCATION]","[ENDPOINT]");Endpointresponse=endpointServiceClient.getEndpoint(name);}FeaturestoreOnlineServingServiceClient
Service Description: A service for serving online feature values.
Sample for FeaturestoreOnlineServingServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(FeaturestoreOnlineServingServiceClientfeaturestoreOnlineServingServiceClient=FeaturestoreOnlineServingServiceClient.create()){EntityTypeNameentityType=EntityTypeName.of("[PROJECT]","[LOCATION]","[FEATURESTORE]","[ENTITY_TYPE]");ReadFeatureValuesResponseresponse=featurestoreOnlineServingServiceClient.readFeatureValues(entityType);}FeaturestoreServiceClient
Service Description: The service that handles CRUD and List for resources for Featurestore.
Sample for FeaturestoreServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(FeaturestoreServiceClientfeaturestoreServiceClient=FeaturestoreServiceClient.create()){FeaturestoreNamename=FeaturestoreName.of("[PROJECT]","[LOCATION]","[FEATURESTORE]");Featurestoreresponse=featurestoreServiceClient.getFeaturestore(name);}IndexEndpointServiceClient
Service Description: A service for managing Vertex AI's IndexEndpoints.
Sample for IndexEndpointServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(IndexEndpointServiceClientindexEndpointServiceClient=IndexEndpointServiceClient.create()){IndexEndpointNamename=IndexEndpointName.of("[PROJECT]","[LOCATION]","[INDEX_ENDPOINT]");IndexEndpointresponse=indexEndpointServiceClient.getIndexEndpoint(name);}IndexServiceClient
Service Description: A service for creating and managing Vertex AI's Index resources.
Sample for IndexServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(IndexServiceClientindexServiceClient=IndexServiceClient.create()){IndexNamename=IndexName.of("[PROJECT]","[LOCATION]","[INDEX]");Indexresponse=indexServiceClient.getIndex(name);}JobServiceClient
Service Description: A service for creating and managing Vertex AI's jobs.
Sample for JobServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(JobServiceClientjobServiceClient=JobServiceClient.create()){LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");CustomJobcustomJob=CustomJob.newBuilder().build();CustomJobresponse=jobServiceClient.createCustomJob(parent,customJob);}MatchServiceClient
Service Description: MatchService is a Google managed service for efficient vector similarity search at scale.
Sample for MatchServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(MatchServiceClientmatchServiceClient=MatchServiceClient.create()){FindNeighborsRequestrequest=FindNeighborsRequest.newBuilder().setIndexEndpoint(IndexEndpointName.of("[PROJECT]","[LOCATION]","[INDEX_ENDPOINT]").toString()).setDeployedIndexId("deployedIndexId-1101212953").addAllQueries(newArrayList<FindNeighborsRequest.Query>()).setReturnFullDatapoint(true).build();FindNeighborsResponseresponse=matchServiceClient.findNeighbors(request);}MetadataServiceClient
Service Description: Service for reading and writing metadata entries.
Sample for MetadataServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(MetadataServiceClientmetadataServiceClient=MetadataServiceClient.create()){MetadataStoreNamename=MetadataStoreName.of("[PROJECT]","[LOCATION]","[METADATA_STORE]");MetadataStoreresponse=metadataServiceClient.getMetadataStore(name);}MigrationServiceClient
Service Description: A service that migrates resources from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.
Sample for MigrationServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){GetLocationRequestrequest=GetLocationRequest.newBuilder().setName("name3373707").build();Locationresponse=migrationServiceClient.getLocation(request);}ModelServiceClient
Service Description: A service for managing Vertex AI's machine learning Models.
Sample for ModelServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(ModelServiceClientmodelServiceClient=ModelServiceClient.create()){ModelNamename=ModelName.of("[PROJECT]","[LOCATION]","[MODEL]");Modelresponse=modelServiceClient.getModel(name);}ModelGardenServiceClient
Service Description: The interface of Model Garden Service.
Sample for ModelGardenServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(ModelGardenServiceClientmodelGardenServiceClient=ModelGardenServiceClient.create()){PublisherModelNamename=PublisherModelName.of("[PUBLISHER]","[MODEL]");PublisherModelresponse=modelGardenServiceClient.getPublisherModel(name);}PipelineServiceClient
Service Description: A service for creating and managing Vertex AI's pipelines. This includes bothTrainingPipeline resources (used for AutoML and custom training) andPipelineJob resources (used for Vertex AI Pipelines).
Sample for PipelineServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(PipelineServiceClientpipelineServiceClient=PipelineServiceClient.create()){LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");TrainingPipelinetrainingPipeline=TrainingPipeline.newBuilder().build();TrainingPipelineresponse=pipelineServiceClient.createTrainingPipeline(parent,trainingPipeline);}PredictionServiceClient
Service Description: A service for online predictions and explanations.
Sample for PredictionServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(PredictionServiceClientpredictionServiceClient=PredictionServiceClient.create()){EndpointNameendpoint=EndpointName.ofProjectLocationEndpointName("[PROJECT]","[LOCATION]","[ENDPOINT]");List<Value>instances=newArrayList<>();Valueparameters=Value.newBuilder().setBoolValue(true).build();PredictResponseresponse=predictionServiceClient.predict(endpoint,instances,parameters);}ScheduleServiceClient
Service Description: A service for creating and managing Vertex AI's Schedule resources to periodically launch shceudled runs to make API calls.
Sample for ScheduleServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(ScheduleServiceClientscheduleServiceClient=ScheduleServiceClient.create()){LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");Scheduleschedule=Schedule.newBuilder().build();Scheduleresponse=scheduleServiceClient.createSchedule(parent,schedule);}SpecialistPoolServiceClient
Service Description: A service for creating and managing Customer SpecialistPools. When customers start Data Labeling jobs, they can reuse/create Specialist Pools to bring their own Specialists to label the data. Customers can add/remove Managers for the Specialist Pool on Cloud console, then Managers will get email notifications to manage Specialists and tasks on CrowdCompute console.
Sample for SpecialistPoolServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(SpecialistPoolServiceClientspecialistPoolServiceClient=SpecialistPoolServiceClient.create()){SpecialistPoolNamename=SpecialistPoolName.of("[PROJECT]","[LOCATION]","[SPECIALIST_POOL]");SpecialistPoolresponse=specialistPoolServiceClient.getSpecialistPool(name);}TensorboardServiceClient
Service Description: TensorboardService
Sample for TensorboardServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(TensorboardServiceClienttensorboardServiceClient=TensorboardServiceClient.create()){TensorboardNamename=TensorboardName.of("[PROJECT]","[LOCATION]","[TENSORBOARD]");Tensorboardresponse=tensorboardServiceClient.getTensorboard(name);}VizierServiceClient
Service Description: Vertex AI Vizier API.
Vertex AI Vizier is a service to solve blackbox optimization problems, such as tuning machine learning hyperparameters and searching over deep learning architectures.
Sample for VizierServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(VizierServiceClientvizierServiceClient=VizierServiceClient.create()){LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");Studystudy=Study.newBuilder().build();Studyresponse=vizierServiceClient.createStudy(parent,study);}com.google.cloud.aiplatform.v1.schema.predict.instance
com.google.cloud.aiplatform.v1.schema.predict.params
com.google.cloud.aiplatform.v1.schema.predict.prediction
com.google.cloud.aiplatform.v1.schema.trainingjob.definition
com.google.cloud.aiplatform.v1.stub
com.google.cloud.aiplatform.v1beta1
A client to Vertex AI API
The interfaces provided are listed below, along with usage samples.
DatasetServiceClient
Service Description: The service that manages Vertex AI Dataset and its child resources.
Sample for DatasetServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(DatasetServiceClientdatasetServiceClient=DatasetServiceClient.create()){DatasetNamename=DatasetName.of("[PROJECT]","[LOCATION]","[DATASET]");Datasetresponse=datasetServiceClient.getDataset(name);}DeploymentResourcePoolServiceClient
Service Description: A service that manages the DeploymentResourcePool resource.
Sample for DeploymentResourcePoolServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(DeploymentResourcePoolServiceClientdeploymentResourcePoolServiceClient=DeploymentResourcePoolServiceClient.create()){DeploymentResourcePoolNamename=DeploymentResourcePoolName.of("[PROJECT]","[LOCATION]","[DEPLOYMENT_RESOURCE_POOL]");DeploymentResourcePoolresponse=deploymentResourcePoolServiceClient.getDeploymentResourcePool(name);}EndpointServiceClient
Service Description: A service for managing Vertex AI's Endpoints.
Sample for EndpointServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(EndpointServiceClientendpointServiceClient=EndpointServiceClient.create()){EndpointNamename=EndpointName.ofProjectLocationEndpointName("[PROJECT]","[LOCATION]","[ENDPOINT]");Endpointresponse=endpointServiceClient.getEndpoint(name);}FeaturestoreOnlineServingServiceClient
Service Description: A service for serving online feature values.
Sample for FeaturestoreOnlineServingServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(FeaturestoreOnlineServingServiceClientfeaturestoreOnlineServingServiceClient=FeaturestoreOnlineServingServiceClient.create()){EntityTypeNameentityType=EntityTypeName.of("[PROJECT]","[LOCATION]","[FEATURESTORE]","[ENTITY_TYPE]");ReadFeatureValuesResponseresponse=featurestoreOnlineServingServiceClient.readFeatureValues(entityType);}FeaturestoreServiceClient
Service Description: The service that handles CRUD and List for resources for Featurestore.
Sample for FeaturestoreServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(FeaturestoreServiceClientfeaturestoreServiceClient=FeaturestoreServiceClient.create()){FeaturestoreNamename=FeaturestoreName.of("[PROJECT]","[LOCATION]","[FEATURESTORE]");Featurestoreresponse=featurestoreServiceClient.getFeaturestore(name);}IndexEndpointServiceClient
Service Description: A service for managing Vertex AI's IndexEndpoints.
Sample for IndexEndpointServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(IndexEndpointServiceClientindexEndpointServiceClient=IndexEndpointServiceClient.create()){IndexEndpointNamename=IndexEndpointName.of("[PROJECT]","[LOCATION]","[INDEX_ENDPOINT]");IndexEndpointresponse=indexEndpointServiceClient.getIndexEndpoint(name);}IndexServiceClient
Service Description: A service for creating and managing Vertex AI's Index resources.
Sample for IndexServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(IndexServiceClientindexServiceClient=IndexServiceClient.create()){IndexNamename=IndexName.of("[PROJECT]","[LOCATION]","[INDEX]");Indexresponse=indexServiceClient.getIndex(name);}JobServiceClient
Service Description: A service for creating and managing Vertex AI's jobs.
Sample for JobServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(JobServiceClientjobServiceClient=JobServiceClient.create()){LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");CustomJobcustomJob=CustomJob.newBuilder().build();CustomJobresponse=jobServiceClient.createCustomJob(parent,customJob);}MatchServiceClient
Service Description: MatchService is a Google managed service for efficient vector similarity search at scale.
Sample for MatchServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(MatchServiceClientmatchServiceClient=MatchServiceClient.create()){FindNeighborsRequestrequest=FindNeighborsRequest.newBuilder().setIndexEndpoint(IndexEndpointName.of("[PROJECT]","[LOCATION]","[INDEX_ENDPOINT]").toString()).setDeployedIndexId("deployedIndexId-1101212953").addAllQueries(newArrayList<FindNeighborsRequest.Query>()).setReturnFullDatapoint(true).build();FindNeighborsResponseresponse=matchServiceClient.findNeighbors(request);}MetadataServiceClient
Service Description: Service for reading and writing metadata entries.
Sample for MetadataServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(MetadataServiceClientmetadataServiceClient=MetadataServiceClient.create()){MetadataStoreNamename=MetadataStoreName.of("[PROJECT]","[LOCATION]","[METADATA_STORE]");MetadataStoreresponse=metadataServiceClient.getMetadataStore(name);}MigrationServiceClient
Service Description: A service that migrates resources from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.
Sample for MigrationServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(MigrationServiceClientmigrationServiceClient=MigrationServiceClient.create()){GetLocationRequestrequest=GetLocationRequest.newBuilder().setName("name3373707").build();Locationresponse=migrationServiceClient.getLocation(request);}ModelGardenServiceClient
Service Description: The interface of Model Garden Service.
Sample for ModelGardenServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(ModelGardenServiceClientmodelGardenServiceClient=ModelGardenServiceClient.create()){PublisherModelNamename=PublisherModelName.of("[PUBLISHER]","[MODEL]");PublisherModelresponse=modelGardenServiceClient.getPublisherModel(name);}ModelServiceClient
Service Description: A service for managing Vertex AI's machine learning Models.
Sample for ModelServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(ModelServiceClientmodelServiceClient=ModelServiceClient.create()){ModelNamename=ModelName.of("[PROJECT]","[LOCATION]","[MODEL]");Modelresponse=modelServiceClient.getModel(name);}PersistentResourceServiceClient
Service Description: A service for managing Vertex AI's machine learning PersistentResource.
Sample for PersistentResourceServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(PersistentResourceServiceClientpersistentResourceServiceClient=PersistentResourceServiceClient.create()){PersistentResourceNamename=PersistentResourceName.of("[PROJECT]","[LOCATION]","[PERSISTENT_RESOURCE]");PersistentResourceresponse=persistentResourceServiceClient.getPersistentResource(name);}PipelineServiceClient
Service Description: A service for creating and managing Vertex AI's pipelines. This includes bothTrainingPipeline resources (used for AutoML and custom training) andPipelineJob resources (used for Vertex AI Pipelines).
Sample for PipelineServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(PipelineServiceClientpipelineServiceClient=PipelineServiceClient.create()){LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");TrainingPipelinetrainingPipeline=TrainingPipeline.newBuilder().build();TrainingPipelineresponse=pipelineServiceClient.createTrainingPipeline(parent,trainingPipeline);}PredictionServiceClient
Service Description: A service for online predictions and explanations.
Sample for PredictionServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(PredictionServiceClientpredictionServiceClient=PredictionServiceClient.create()){EndpointNameendpoint=EndpointName.ofProjectLocationEndpointName("[PROJECT]","[LOCATION]","[ENDPOINT]");List<Value>instances=newArrayList<>();Valueparameters=Value.newBuilder().setBoolValue(true).build();PredictResponseresponse=predictionServiceClient.predict(endpoint,instances,parameters);}ScheduleServiceClient
Service Description: A service for creating and managing Vertex AI's Schedule resources to periodically launch shceudled runs to make API calls.
Sample for ScheduleServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(ScheduleServiceClientscheduleServiceClient=ScheduleServiceClient.create()){LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");Scheduleschedule=Schedule.newBuilder().build();Scheduleresponse=scheduleServiceClient.createSchedule(parent,schedule);}SpecialistPoolServiceClient
Service Description: A service for creating and managing Customer SpecialistPools. When customers start Data Labeling jobs, they can reuse/create Specialist Pools to bring their own Specialists to label the data. Customers can add/remove Managers for the Specialist Pool on Cloud console, then Managers will get email notifications to manage Specialists and tasks on CrowdCompute console.
Sample for SpecialistPoolServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(SpecialistPoolServiceClientspecialistPoolServiceClient=SpecialistPoolServiceClient.create()){SpecialistPoolNamename=SpecialistPoolName.of("[PROJECT]","[LOCATION]","[SPECIALIST_POOL]");SpecialistPoolresponse=specialistPoolServiceClient.getSpecialistPool(name);}TensorboardServiceClient
Service Description: TensorboardService
Sample for TensorboardServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(TensorboardServiceClienttensorboardServiceClient=TensorboardServiceClient.create()){TensorboardNamename=TensorboardName.of("[PROJECT]","[LOCATION]","[TENSORBOARD]");Tensorboardresponse=tensorboardServiceClient.getTensorboard(name);}VizierServiceClient
Service Description: Vertex AI Vizier API.
Vertex AI Vizier is a service to solve blackbox optimization problems, such as tuning machine learning hyperparameters and searching over deep learning architectures.
Sample for VizierServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_librarytry(VizierServiceClientvizierServiceClient=VizierServiceClient.create()){LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");Studystudy=Study.newBuilder().build();Studyresponse=vizierServiceClient.createStudy(parent,study);}com.google.cloud.aiplatform.v1beta1.schema.predict.instance
com.google.cloud.aiplatform.v1beta1.schema.predict.params
com.google.cloud.aiplatform.v1beta1.schema.predict.prediction
com.google.cloud.aiplatform.v1beta1.schema.trainingjob.definition
com.google.cloud.aiplatform.v1beta1.stub
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-31 UTC.