Namespace com.google.cloud.aiplatform.v1.stub (2.4.0)

Version 2.4.0

• 3.52.0 (latest)
• 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

Classes

DatasetServiceStub

Base stub class for the DatasetService service API.

This class is for advanced usage and reflects the underlying API directly.

DatasetServiceStubSettings

Settings class to configure an instance of DatasetServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getDataset to 30 seconds:

 DatasetServiceStubSettings.Builder datasetServiceSettingsBuilder =
     DatasetServiceStubSettings.newBuilder();
 datasetServiceSettingsBuilder
     .getDatasetSettings()
     .setRetrySettings(
         datasetServiceSettingsBuilder
             .getDatasetSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DatasetServiceStubSettings datasetServiceSettings = datasetServiceSettingsBuilder.build();
 

DatasetServiceStubSettings.Builder

Builder for DatasetServiceStubSettings.

EndpointServiceStub

Base stub class for the EndpointService service API.

This class is for advanced usage and reflects the underlying API directly.

EndpointServiceStubSettings

Settings class to configure an instance of EndpointServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getEndpoint to 30 seconds:

 EndpointServiceStubSettings.Builder endpointServiceSettingsBuilder =
     EndpointServiceStubSettings.newBuilder();
 endpointServiceSettingsBuilder
     .getEndpointSettings()
     .setRetrySettings(
         endpointServiceSettingsBuilder
             .getEndpointSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 EndpointServiceStubSettings endpointServiceSettings = endpointServiceSettingsBuilder.build();
 

EndpointServiceStubSettings.Builder

Builder for EndpointServiceStubSettings.

FeaturestoreOnlineServingServiceStub

Base stub class for the FeaturestoreOnlineServingService service API.

This class is for advanced usage and reflects the underlying API directly.

FeaturestoreOnlineServingServiceStubSettings

Settings class to configure an instance of FeaturestoreOnlineServingServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of readFeatureValues to 30 seconds:

 FeaturestoreOnlineServingServiceStubSettings.Builder
     featurestoreOnlineServingServiceSettingsBuilder =
         FeaturestoreOnlineServingServiceStubSettings.newBuilder();
 featurestoreOnlineServingServiceSettingsBuilder
     .readFeatureValuesSettings()
     .setRetrySettings(
         featurestoreOnlineServingServiceSettingsBuilder
             .readFeatureValuesSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 FeaturestoreOnlineServingServiceStubSettings featurestoreOnlineServingServiceSettings =
     featurestoreOnlineServingServiceSettingsBuilder.build();
 

FeaturestoreOnlineServingServiceStubSettings.Builder

Builder for FeaturestoreOnlineServingServiceStubSettings.

FeaturestoreServiceStub

Base stub class for the FeaturestoreService service API.

This class is for advanced usage and reflects the underlying API directly.

FeaturestoreServiceStubSettings

Settings class to configure an instance of FeaturestoreServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getFeaturestore to 30 seconds:

 FeaturestoreServiceStubSettings.Builder featurestoreServiceSettingsBuilder =
     FeaturestoreServiceStubSettings.newBuilder();
 featurestoreServiceSettingsBuilder
     .getFeaturestoreSettings()
     .setRetrySettings(
         featurestoreServiceSettingsBuilder
             .getFeaturestoreSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 FeaturestoreServiceStubSettings featurestoreServiceSettings =
     featurestoreServiceSettingsBuilder.build();
 

FeaturestoreServiceStubSettings.Builder

Builder for FeaturestoreServiceStubSettings.

GrpcDatasetServiceCallableFactory

gRPC callable factory implementation for the DatasetService service API.

This class is for advanced usage.

GrpcDatasetServiceStub

gRPC stub implementation for the DatasetService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcEndpointServiceCallableFactory

gRPC callable factory implementation for the EndpointService service API.

This class is for advanced usage.

GrpcEndpointServiceStub

gRPC stub implementation for the EndpointService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcFeaturestoreOnlineServingServiceCallableFactory

gRPC callable factory implementation for the FeaturestoreOnlineServingService service API.

This class is for advanced usage.

GrpcFeaturestoreOnlineServingServiceStub

gRPC stub implementation for the FeaturestoreOnlineServingService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcFeaturestoreServiceCallableFactory

gRPC callable factory implementation for the FeaturestoreService service API.

This class is for advanced usage.

GrpcFeaturestoreServiceStub

gRPC stub implementation for the FeaturestoreService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcIndexEndpointServiceCallableFactory

gRPC callable factory implementation for the IndexEndpointService service API.

This class is for advanced usage.

GrpcIndexEndpointServiceStub

gRPC stub implementation for the IndexEndpointService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcIndexServiceCallableFactory

gRPC callable factory implementation for the IndexService service API.

This class is for advanced usage.

GrpcIndexServiceStub

gRPC stub implementation for the IndexService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcJobServiceCallableFactory

gRPC callable factory implementation for the JobService service API.

This class is for advanced usage.

GrpcJobServiceStub

gRPC stub implementation for the JobService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcMetadataServiceCallableFactory

gRPC callable factory implementation for the MetadataService service API.

This class is for advanced usage.

GrpcMetadataServiceStub

gRPC stub implementation for the MetadataService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcMigrationServiceCallableFactory

gRPC callable factory implementation for the MigrationService service API.

This class is for advanced usage.

GrpcMigrationServiceStub

gRPC stub implementation for the MigrationService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcModelServiceCallableFactory

gRPC callable factory implementation for the ModelService service API.

This class is for advanced usage.

GrpcModelServiceStub

gRPC stub implementation for the ModelService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcPipelineServiceCallableFactory

gRPC callable factory implementation for the PipelineService service API.

This class is for advanced usage.

GrpcPipelineServiceStub

gRPC stub implementation for the PipelineService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcPredictionServiceCallableFactory

gRPC callable factory implementation for the PredictionService service API.

This class is for advanced usage.

GrpcPredictionServiceStub

gRPC stub implementation for the PredictionService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcSpecialistPoolServiceCallableFactory

gRPC callable factory implementation for the SpecialistPoolService service API.

This class is for advanced usage.

GrpcSpecialistPoolServiceStub

gRPC stub implementation for the SpecialistPoolService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcTensorboardServiceCallableFactory

gRPC callable factory implementation for the TensorboardService service API.

This class is for advanced usage.

GrpcTensorboardServiceStub

gRPC stub implementation for the TensorboardService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcVizierServiceCallableFactory

gRPC callable factory implementation for the VizierService service API.

This class is for advanced usage.

GrpcVizierServiceStub

gRPC stub implementation for the VizierService service API.

This class is for advanced usage and reflects the underlying API directly.

IndexEndpointServiceStub

Base stub class for the IndexEndpointService service API.

This class is for advanced usage and reflects the underlying API directly.

IndexEndpointServiceStubSettings

Settings class to configure an instance of IndexEndpointServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getIndexEndpoint to 30 seconds:

 IndexEndpointServiceStubSettings.Builder indexEndpointServiceSettingsBuilder =
     IndexEndpointServiceStubSettings.newBuilder();
 indexEndpointServiceSettingsBuilder
     .getIndexEndpointSettings()
     .setRetrySettings(
         indexEndpointServiceSettingsBuilder
             .getIndexEndpointSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 IndexEndpointServiceStubSettings indexEndpointServiceSettings =
     indexEndpointServiceSettingsBuilder.build();
 

IndexEndpointServiceStubSettings.Builder

Builder for IndexEndpointServiceStubSettings.

IndexServiceStub

Base stub class for the IndexService service API.

This class is for advanced usage and reflects the underlying API directly.

IndexServiceStubSettings

Settings class to configure an instance of IndexServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getIndex to 30 seconds:

 IndexServiceStubSettings.Builder indexServiceSettingsBuilder =
     IndexServiceStubSettings.newBuilder();
 indexServiceSettingsBuilder
     .getIndexSettings()
     .setRetrySettings(
         indexServiceSettingsBuilder
             .getIndexSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 IndexServiceStubSettings indexServiceSettings = indexServiceSettingsBuilder.build();
 

IndexServiceStubSettings.Builder

Builder for IndexServiceStubSettings.

JobServiceStub

Base stub class for the JobService service API.

This class is for advanced usage and reflects the underlying API directly.

JobServiceStubSettings

Settings class to configure an instance of JobServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createCustomJob to 30 seconds:

 JobServiceStubSettings.Builder jobServiceSettingsBuilder = JobServiceStubSettings.newBuilder();
 jobServiceSettingsBuilder
     .createCustomJobSettings()
     .setRetrySettings(
         jobServiceSettingsBuilder
             .createCustomJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 JobServiceStubSettings jobServiceSettings = jobServiceSettingsBuilder.build();
 

JobServiceStubSettings.Builder

Builder for JobServiceStubSettings.

MetadataServiceStub

Base stub class for the MetadataService service API.

This class is for advanced usage and reflects the underlying API directly.

MetadataServiceStubSettings

Settings class to configure an instance of MetadataServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getMetadataStore to 30 seconds:

 MetadataServiceStubSettings.Builder metadataServiceSettingsBuilder =
     MetadataServiceStubSettings.newBuilder();
 metadataServiceSettingsBuilder
     .getMetadataStoreSettings()
     .setRetrySettings(
         metadataServiceSettingsBuilder
             .getMetadataStoreSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 MetadataServiceStubSettings metadataServiceSettings = metadataServiceSettingsBuilder.build();
 

MetadataServiceStubSettings.Builder

Builder for MetadataServiceStubSettings.

MigrationServiceStub

Base stub class for the MigrationService service API.

This class is for advanced usage and reflects the underlying API directly.

MigrationServiceStubSettings

Settings class to configure an instance of MigrationServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of searchMigratableResources to 30 seconds:

 MigrationServiceStubSettings.Builder migrationServiceSettingsBuilder =
     MigrationServiceStubSettings.newBuilder();
 migrationServiceSettingsBuilder
     .searchMigratableResourcesSettings()
     .setRetrySettings(
         migrationServiceSettingsBuilder
             .searchMigratableResourcesSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 MigrationServiceStubSettings migrationServiceSettings = migrationServiceSettingsBuilder.build();
 

MigrationServiceStubSettings.Builder

Builder for MigrationServiceStubSettings.

ModelServiceStub

Base stub class for the ModelService service API.

This class is for advanced usage and reflects the underlying API directly.

ModelServiceStubSettings

Settings class to configure an instance of ModelServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getModel to 30 seconds:

 ModelServiceStubSettings.Builder modelServiceSettingsBuilder =
     ModelServiceStubSettings.newBuilder();
 modelServiceSettingsBuilder
     .getModelSettings()
     .setRetrySettings(
         modelServiceSettingsBuilder
             .getModelSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ModelServiceStubSettings modelServiceSettings = modelServiceSettingsBuilder.build();
 

ModelServiceStubSettings.Builder

Builder for ModelServiceStubSettings.

PipelineServiceStub

Base stub class for the PipelineService service API.

This class is for advanced usage and reflects the underlying API directly.

PipelineServiceStubSettings

Settings class to configure an instance of PipelineServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createTrainingPipeline to 30 seconds:

 PipelineServiceStubSettings.Builder pipelineServiceSettingsBuilder =
     PipelineServiceStubSettings.newBuilder();
 pipelineServiceSettingsBuilder
     .createTrainingPipelineSettings()
     .setRetrySettings(
         pipelineServiceSettingsBuilder
             .createTrainingPipelineSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PipelineServiceStubSettings pipelineServiceSettings = pipelineServiceSettingsBuilder.build();
 

PipelineServiceStubSettings.Builder

Builder for PipelineServiceStubSettings.

PredictionServiceStub

Base stub class for the PredictionService service API.

This class is for advanced usage and reflects the underlying API directly.

PredictionServiceStubSettings

Settings class to configure an instance of PredictionServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of predict to 30 seconds:

 PredictionServiceStubSettings.Builder predictionServiceSettingsBuilder =
     PredictionServiceStubSettings.newBuilder();
 predictionServiceSettingsBuilder
     .predictSettings()
     .setRetrySettings(
         predictionServiceSettingsBuilder
             .predictSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PredictionServiceStubSettings predictionServiceSettings =
     predictionServiceSettingsBuilder.build();
 

PredictionServiceStubSettings.Builder

Builder for PredictionServiceStubSettings.

SpecialistPoolServiceStub

Base stub class for the SpecialistPoolService service API.

This class is for advanced usage and reflects the underlying API directly.

SpecialistPoolServiceStubSettings

Settings class to configure an instance of SpecialistPoolServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getSpecialistPool to 30 seconds:

 SpecialistPoolServiceStubSettings.Builder specialistPoolServiceSettingsBuilder =
     SpecialistPoolServiceStubSettings.newBuilder();
 specialistPoolServiceSettingsBuilder
     .getSpecialistPoolSettings()
     .setRetrySettings(
         specialistPoolServiceSettingsBuilder
             .getSpecialistPoolSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SpecialistPoolServiceStubSettings specialistPoolServiceSettings =
     specialistPoolServiceSettingsBuilder.build();
 

SpecialistPoolServiceStubSettings.Builder

Builder for SpecialistPoolServiceStubSettings.

TensorboardServiceStub

Base stub class for the TensorboardService service API.

This class is for advanced usage and reflects the underlying API directly.

TensorboardServiceStubSettings

Settings class to configure an instance of TensorboardServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getTensorboard to 30 seconds:

 TensorboardServiceStubSettings.Builder tensorboardServiceSettingsBuilder =
     TensorboardServiceStubSettings.newBuilder();
 tensorboardServiceSettingsBuilder
     .getTensorboardSettings()
     .setRetrySettings(
         tensorboardServiceSettingsBuilder
             .getTensorboardSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TensorboardServiceStubSettings tensorboardServiceSettings =
     tensorboardServiceSettingsBuilder.build();
 

TensorboardServiceStubSettings.Builder

Builder for TensorboardServiceStubSettings.

VizierServiceStub

Base stub class for the VizierService service API.

This class is for advanced usage and reflects the underlying API directly.

VizierServiceStubSettings

Settings class to configure an instance of VizierServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createStudy to 30 seconds:

 VizierServiceStubSettings.Builder vizierServiceSettingsBuilder =
     VizierServiceStubSettings.newBuilder();
 vizierServiceSettingsBuilder
     .createStudySettings()
     .setRetrySettings(
         vizierServiceSettingsBuilder
             .createStudySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 VizierServiceStubSettings vizierServiceSettings = vizierServiceSettingsBuilder.build();
 

VizierServiceStubSettings.Builder

Builder for VizierServiceStubSettings.