The google-aiplatform1 library allows access to all features of the Google Aiplatform service.

This documentation was generated from Aiplatform crate version 6.0.0+20240715, where 20240715 is the exact revision of the aiplatform:v1 schema built by the mako code generator v6.0.0.

Everything else about the Aiplatform v1 API can be found at the official documentation site.

Features

Handle the following Resources with ease from the central hub ...

• projects

• locations batch prediction jobs cancel, locations batch prediction jobs create, locations batch prediction jobs delete, locations batch prediction jobs get, locations batch prediction jobs list, locations custom jobs cancel, locations custom jobs create, locations custom jobs delete, locations custom jobs get, locations custom jobs list, locations custom jobs operations cancel, locations custom jobs operations delete, locations custom jobs operations get, locations custom jobs operations list, locations custom jobs operations wait, locations data labeling jobs cancel, locations data labeling jobs create, locations data labeling jobs delete, locations data labeling jobs get, locations data labeling jobs list, locations data labeling jobs operations cancel, locations data labeling jobs operations delete, locations data labeling jobs operations get, locations data labeling jobs operations list, locations data labeling jobs operations wait, locations datasets annotation specs get, locations datasets annotation specs operations cancel, locations datasets annotation specs operations delete, locations datasets annotation specs operations get, locations datasets annotation specs operations list, locations datasets annotation specs operations wait, locations datasets create, locations datasets data items annotations list, locations datasets data items annotations operations cancel, locations datasets data items annotations operations delete, locations datasets data items annotations operations get, locations datasets data items annotations operations list, locations datasets data items annotations operations wait, locations datasets data items list, locations datasets data items operations cancel, locations datasets data items operations delete, locations datasets data items operations get, locations datasets data items operations list, locations datasets data items operations wait, locations datasets dataset versions create, locations datasets dataset versions delete, locations datasets dataset versions get, locations datasets dataset versions list, locations datasets dataset versions patch, locations datasets dataset versions restore, locations datasets delete, locations datasets export, locations datasets get, locations datasets import, locations datasets list, locations datasets operations cancel, locations datasets operations delete, locations datasets operations get, locations datasets operations list, locations datasets operations wait, locations datasets patch, locations datasets saved queries delete, locations datasets saved queries list, locations datasets saved queries operations cancel, locations datasets saved queries operations delete, locations datasets saved queries operations get, locations datasets saved queries operations list, locations datasets saved queries operations wait, locations datasets search data items, locations deployment resource pools create, locations deployment resource pools delete, locations deployment resource pools get, locations deployment resource pools list, locations deployment resource pools operations cancel, locations deployment resource pools operations delete, locations deployment resource pools operations get, locations deployment resource pools operations list, locations deployment resource pools operations wait, locations deployment resource pools patch, locations deployment resource pools query deployed models, locations endpoints compute tokens, locations endpoints count tokens, locations endpoints create, locations endpoints delete, locations endpoints deploy model, locations endpoints direct predict, locations endpoints direct raw predict, locations endpoints explain, locations endpoints generate content, locations endpoints get, locations endpoints list, locations endpoints mutate deployed model, locations endpoints operations cancel, locations endpoints operations delete, locations endpoints operations get, locations endpoints operations list, locations endpoints operations wait, locations endpoints patch, locations endpoints predict, locations endpoints raw predict, locations endpoints server streaming predict, locations endpoints stream generate content, locations endpoints stream raw predict, locations endpoints undeploy model, locations evaluate instances, locations feature groups create, locations feature groups delete, locations feature groups features create, locations feature groups features delete, locations feature groups features get, locations feature groups features list, locations feature groups features operations delete, locations feature groups features operations get, locations feature groups features operations list wait, locations feature groups features operations wait, locations feature groups features patch, locations feature groups get, locations feature groups list, locations feature groups operations delete, locations feature groups operations get, locations feature groups operations list wait, locations feature groups operations wait, locations feature groups patch, locations feature online stores create, locations feature online stores delete, locations feature online stores feature views create, locations feature online stores feature views delete, locations feature online stores feature views feature view syncs get, locations feature online stores feature views feature view syncs list, locations feature online stores feature views fetch feature values, locations feature online stores feature views get, locations feature online stores feature views list, locations feature online stores feature views operations delete, locations feature online stores feature views operations get, locations feature online stores feature views operations list wait, locations feature online stores feature views operations wait, locations feature online stores feature views patch, locations feature online stores feature views search nearest entities, locations feature online stores feature views sync, locations feature online stores get, locations feature online stores list, locations feature online stores operations delete, locations feature online stores operations get, locations feature online stores operations list wait, locations feature online stores operations wait, locations feature online stores patch, locations featurestores batch read feature values, locations featurestores create, locations featurestores delete, locations featurestores entity types create, locations featurestores entity types delete, locations featurestores entity types delete feature values, locations featurestores entity types export feature values, locations featurestores entity types features batch create, locations featurestores entity types features create, locations featurestores entity types features delete, locations featurestores entity types features get, locations featurestores entity types features list, locations featurestores entity types features operations cancel, locations featurestores entity types features operations delete, locations featurestores entity types features operations get, locations featurestores entity types features operations list, locations featurestores entity types features operations wait, locations featurestores entity types features patch, locations featurestores entity types get, locations featurestores entity types get iam policy, locations featurestores entity types import feature values, locations featurestores entity types list, locations featurestores entity types operations cancel, locations featurestores entity types operations delete, locations featurestores entity types operations get, locations featurestores entity types operations list, locations featurestores entity types operations wait, locations featurestores entity types patch, locations featurestores entity types read feature values, locations featurestores entity types set iam policy, locations featurestores entity types streaming read feature values, locations featurestores entity types test iam permissions, locations featurestores entity types write feature values, locations featurestores get, locations featurestores get iam policy, locations featurestores list, locations featurestores operations cancel, locations featurestores operations delete, locations featurestores operations get, locations featurestores operations list, locations featurestores operations wait, locations featurestores patch, locations featurestores search features, locations featurestores set iam policy, locations featurestores test iam permissions, locations get, locations hyperparameter tuning jobs cancel, locations hyperparameter tuning jobs create, locations hyperparameter tuning jobs delete, locations hyperparameter tuning jobs get, locations hyperparameter tuning jobs list, locations hyperparameter tuning jobs operations cancel, locations hyperparameter tuning jobs operations delete, locations hyperparameter tuning jobs operations get, locations hyperparameter tuning jobs operations list, locations hyperparameter tuning jobs operations wait, locations index endpoints create, locations index endpoints delete, locations index endpoints deploy index, locations index endpoints find neighbors, locations index endpoints get, locations index endpoints list, locations index endpoints mutate deployed index, locations index endpoints operations cancel, locations index endpoints operations delete, locations index endpoints operations get, locations index endpoints operations list, locations index endpoints operations wait, locations index endpoints patch, locations index endpoints read index datapoints, locations index endpoints undeploy index, locations indexes create, locations indexes delete, locations indexes get, locations indexes list, locations indexes operations cancel, locations indexes operations delete, locations indexes operations get, locations indexes operations list, locations indexes operations wait, locations indexes patch, locations indexes remove datapoints, locations indexes upsert datapoints, locations list, locations metadata stores artifacts create, locations metadata stores artifacts delete, locations metadata stores artifacts get, locations metadata stores artifacts list, locations metadata stores artifacts operations cancel, locations metadata stores artifacts operations delete, locations metadata stores artifacts operations get, locations metadata stores artifacts operations list, locations metadata stores artifacts operations wait, locations metadata stores artifacts patch, locations metadata stores artifacts purge, locations metadata stores artifacts query artifact lineage subgraph, locations metadata stores contexts add context artifacts and executions, locations metadata stores contexts add context children, locations metadata stores contexts create, locations metadata stores contexts delete, locations metadata stores contexts get, locations metadata stores contexts list, locations metadata stores contexts operations cancel, locations metadata stores contexts operations delete, locations metadata stores contexts operations get, locations metadata stores contexts operations list, locations metadata stores contexts operations wait, locations metadata stores contexts patch, locations metadata stores contexts purge, locations metadata stores contexts query context lineage subgraph, locations metadata stores contexts remove context children, locations metadata stores create, locations metadata stores delete, locations metadata stores executions add execution events, locations metadata stores executions create, locations metadata stores executions delete, locations metadata stores executions get, locations metadata stores executions list, locations metadata stores executions operations cancel, locations metadata stores executions operations delete, locations metadata stores executions operations get, locations metadata stores executions operations list, locations metadata stores executions operations wait, locations metadata stores executions patch, locations metadata stores executions purge, locations metadata stores executions query execution inputs and outputs, locations metadata stores get, locations metadata stores list, locations metadata stores metadata schemas create, locations metadata stores metadata schemas get, locations metadata stores metadata schemas list, locations metadata stores operations cancel, locations metadata stores operations delete, locations metadata stores operations get, locations metadata stores operations list, locations metadata stores operations wait, locations migratable resources batch migrate, locations migratable resources operations cancel, locations migratable resources operations delete, locations migratable resources operations get, locations migratable resources operations list, locations migratable resources operations wait, locations migratable resources search, locations model deployment monitoring jobs create, locations model deployment monitoring jobs delete, locations model deployment monitoring jobs get, locations model deployment monitoring jobs list, locations model deployment monitoring jobs operations cancel, locations model deployment monitoring jobs operations delete, locations model deployment monitoring jobs operations get, locations model deployment monitoring jobs operations list, locations model deployment monitoring jobs operations wait, locations model deployment monitoring jobs patch, locations model deployment monitoring jobs pause, locations model deployment monitoring jobs resume, locations model deployment monitoring jobs search model deployment monitoring stats anomalies, locations models copy, locations models delete, locations models delete version, locations models evaluations get, locations models evaluations import, locations models evaluations list, locations models evaluations operations cancel, locations models evaluations operations delete, locations models evaluations operations get, locations models evaluations operations list, locations models evaluations operations wait, locations models evaluations slices batch import, locations models evaluations slices get, locations models evaluations slices list, locations models export, locations models get, locations models get iam policy, locations models list, locations models list versions, locations models merge version aliases, locations models operations cancel, locations models operations delete, locations models operations get, locations models operations list, locations models operations wait, locations models patch, locations models set iam policy, locations models test iam permissions, locations models update explanation dataset, locations models upload, locations nas jobs cancel, locations nas jobs create, locations nas jobs delete, locations nas jobs get, locations nas jobs list, locations nas jobs nas trial details get, locations nas jobs nas trial details list, locations notebook execution jobs create, locations notebook execution jobs delete, locations notebook execution jobs get, locations notebook execution jobs list, locations notebook execution jobs operations cancel, locations notebook execution jobs operations delete, locations notebook execution jobs operations get, locations notebook execution jobs operations list, locations notebook execution jobs operations wait, locations notebook runtime templates create, locations notebook runtime templates delete, locations notebook runtime templates get, locations notebook runtime templates get iam policy, locations notebook runtime templates list, locations notebook runtime templates operations cancel, locations notebook runtime templates operations delete, locations notebook runtime templates operations get, locations notebook runtime templates operations list, locations notebook runtime templates operations wait, locations notebook runtime templates patch, locations notebook runtime templates set iam policy, locations notebook runtime templates test iam permissions, locations notebook runtimes assign, locations notebook runtimes delete, locations notebook runtimes get, locations notebook runtimes list, locations notebook runtimes operations cancel, locations notebook runtimes operations delete, locations notebook runtimes operations get, locations notebook runtimes operations list, locations notebook runtimes operations wait, locations notebook runtimes start, locations notebook runtimes upgrade, locations operations cancel, locations operations delete, locations operations get, locations operations list, locations operations wait, locations persistent resources create, locations persistent resources delete, locations persistent resources get, locations persistent resources list, locations persistent resources operations cancel, locations persistent resources operations delete, locations persistent resources operations get, locations persistent resources operations list, locations persistent resources operations wait, locations persistent resources patch, locations persistent resources reboot, locations pipeline jobs batch cancel, locations pipeline jobs batch delete, locations pipeline jobs cancel, locations pipeline jobs create, locations pipeline jobs delete, locations pipeline jobs get, locations pipeline jobs list, locations pipeline jobs operations cancel, locations pipeline jobs operations delete, locations pipeline jobs operations get, locations pipeline jobs operations list, locations pipeline jobs operations wait, locations publishers models compute tokens, locations publishers models count tokens, locations publishers models generate content, locations publishers models predict, locations publishers models raw predict, locations publishers models server streaming predict, locations publishers models stream generate content, locations publishers models stream raw predict, locations schedules create, locations schedules delete, locations schedules get, locations schedules list, locations schedules operations cancel, locations schedules operations delete, locations schedules operations get, locations schedules operations list, locations schedules operations wait, locations schedules patch, locations schedules pause, locations schedules resume, locations specialist pools create, locations specialist pools delete, locations specialist pools get, locations specialist pools list, locations specialist pools operations cancel, locations specialist pools operations delete, locations specialist pools operations get, locations specialist pools operations list, locations specialist pools operations wait, locations specialist pools patch, locations studies create, locations studies delete, locations studies get, locations studies list, locations studies lookup, locations studies operations cancel, locations studies operations delete, locations studies operations get, locations studies operations list, locations studies operations wait, locations studies trials add trial measurement, locations studies trials check trial early stopping state, locations studies trials complete, locations studies trials create, locations studies trials delete, locations studies trials get, locations studies trials list, locations studies trials list optimal trials, locations studies trials operations cancel, locations studies trials operations delete, locations studies trials operations get, locations studies trials operations list, locations studies trials operations wait, locations studies trials stop, locations studies trials suggest, locations tensorboards batch read, locations tensorboards create, locations tensorboards delete, locations tensorboards experiments batch create, locations tensorboards experiments create, locations tensorboards experiments delete, locations tensorboards experiments get, locations tensorboards experiments list, locations tensorboards experiments operations cancel, locations tensorboards experiments operations delete, locations tensorboards experiments operations get, locations tensorboards experiments operations list, locations tensorboards experiments operations wait, locations tensorboards experiments patch, locations tensorboards experiments runs batch create, locations tensorboards experiments runs create, locations tensorboards experiments runs delete, locations tensorboards experiments runs get, locations tensorboards experiments runs list, locations tensorboards experiments runs operations cancel, locations tensorboards experiments runs operations delete, locations tensorboards experiments runs operations get, locations tensorboards experiments runs operations list, locations tensorboards experiments runs operations wait, locations tensorboards experiments runs patch, locations tensorboards experiments runs time series create, locations tensorboards experiments runs time series delete, locations tensorboards experiments runs time series export tensorboard time series, locations tensorboards experiments runs time series get, locations tensorboards experiments runs time series list, locations tensorboards experiments runs time series operations cancel, locations tensorboards experiments runs time series operations delete, locations tensorboards experiments runs time series operations get, locations tensorboards experiments runs time series operations list, locations tensorboards experiments runs time series operations wait, locations tensorboards experiments runs time series patch, locations tensorboards experiments runs time series read, locations tensorboards experiments runs time series read blob data, locations tensorboards experiments runs write, locations tensorboards experiments write, locations tensorboards get, locations tensorboards list, locations tensorboards operations cancel, locations tensorboards operations delete, locations tensorboards operations get, locations tensorboards operations list, locations tensorboards operations wait, locations tensorboards patch, locations tensorboards read size, locations tensorboards read usage, locations training pipelines cancel, locations training pipelines create, locations training pipelines delete, locations training pipelines get, locations training pipelines list, locations training pipelines operations cancel, locations training pipelines operations delete, locations training pipelines operations get, locations training pipelines operations list, locations training pipelines operations wait, locations tuning jobs cancel, locations tuning jobs create, locations tuning jobs get, locations tuning jobs list, locations tuning jobs operations cancel, locations tuning jobs operations get and locations tuning jobs operations list

• publishers

• models get

Structure of this Library

The API is structured into the following primary items:

• Hub
  • a central object to maintain state and allow accessing all Activities
  • creates Method Builders which in turn allow access to individual Call Builders
• Resources
  • primary types that you can apply Activities to
  • a collection of properties and Parts
  • Parts
    • a collection of properties
    • never directly used in Activities
• Activities
  • operations to apply to Resources

All structures are marked with applicable traits to further categorize them and ease browsing.

Generally speaking, you can invoke Activities like this:

let r = hub.resource().activity(...).doit().await

Or specifically ...

let r = hub.projects().locations_data_labeling_jobs_operations_wait(...).doit().await
let r = hub.projects().locations_data_labeling_jobs_operations_get(...).doit().await
let r = hub.projects().locations_data_labeling_jobs_delete(...).doit().await
let r = hub.projects().locations_notebook_execution_jobs_operations_wait(...).doit().await
let r = hub.projects().locations_notebook_execution_jobs_operations_get(...).doit().await
let r = hub.projects().locations_notebook_execution_jobs_create(...).doit().await
let r = hub.projects().locations_notebook_execution_jobs_delete(...).doit().await
let r = hub.projects().locations_training_pipelines_operations_wait(...).doit().await
let r = hub.projects().locations_training_pipelines_operations_get(...).doit().await
let r = hub.projects().locations_training_pipelines_delete(...).doit().await
let r = hub.projects().locations_indexes_operations_get(...).doit().await
let r = hub.projects().locations_indexes_operations_wait(...).doit().await
let r = hub.projects().locations_indexes_delete(...).doit().await
let r = hub.projects().locations_indexes_patch(...).doit().await
let r = hub.projects().locations_indexes_create(...).doit().await
let r = hub.projects().locations_studies_trials_operations_get(...).doit().await
let r = hub.projects().locations_studies_trials_operations_wait(...).doit().await
let r = hub.projects().locations_studies_trials_check_trial_early_stopping_state(...).doit().await
let r = hub.projects().locations_studies_trials_suggest(...).doit().await
let r = hub.projects().locations_studies_operations_wait(...).doit().await
let r = hub.projects().locations_studies_operations_get(...).doit().await
let r = hub.projects().locations_migratable_resources_operations_wait(...).doit().await
let r = hub.projects().locations_migratable_resources_operations_get(...).doit().await
let r = hub.projects().locations_migratable_resources_batch_migrate(...).doit().await
let r = hub.projects().locations_nas_jobs_delete(...).doit().await
let r = hub.projects().locations_schedules_operations_get(...).doit().await
let r = hub.projects().locations_schedules_operations_wait(...).doit().await
let r = hub.projects().locations_schedules_delete(...).doit().await
let r = hub.projects().locations_tensorboards_operations_wait(...).doit().await
let r = hub.projects().locations_tensorboards_operations_get(...).doit().await
let r = hub.projects().locations_tensorboards_experiments_runs_time_series_operations_wait(...).doit().await
let r = hub.projects().locations_tensorboards_experiments_runs_time_series_operations_get(...).doit().await
let r = hub.projects().locations_tensorboards_experiments_runs_time_series_delete(...).doit().await
let r = hub.projects().locations_tensorboards_experiments_runs_operations_get(...).doit().await
let r = hub.projects().locations_tensorboards_experiments_runs_operations_wait(...).doit().await
let r = hub.projects().locations_tensorboards_experiments_runs_delete(...).doit().await
let r = hub.projects().locations_tensorboards_experiments_operations_get(...).doit().await
let r = hub.projects().locations_tensorboards_experiments_operations_wait(...).doit().await
let r = hub.projects().locations_tensorboards_experiments_delete(...).doit().await
let r = hub.projects().locations_tensorboards_delete(...).doit().await
let r = hub.projects().locations_tensorboards_create(...).doit().await
let r = hub.projects().locations_tensorboards_patch(...).doit().await
let r = hub.projects().locations_feature_groups_operations_wait(...).doit().await
let r = hub.projects().locations_feature_groups_operations_get(...).doit().await
let r = hub.projects().locations_feature_groups_features_operations_wait(...).doit().await
let r = hub.projects().locations_feature_groups_features_operations_get(...).doit().await
let r = hub.projects().locations_feature_groups_features_patch(...).doit().await
let r = hub.projects().locations_feature_groups_features_create(...).doit().await
let r = hub.projects().locations_feature_groups_features_delete(...).doit().await
let r = hub.projects().locations_feature_groups_delete(...).doit().await
let r = hub.projects().locations_feature_groups_patch(...).doit().await
let r = hub.projects().locations_feature_groups_create(...).doit().await
let r = hub.projects().locations_feature_online_stores_feature_views_operations_get(...).doit().await
let r = hub.projects().locations_feature_online_stores_feature_views_operations_wait(...).doit().await
let r = hub.projects().locations_feature_online_stores_feature_views_patch(...).doit().await
let r = hub.projects().locations_feature_online_stores_feature_views_create(...).doit().await
let r = hub.projects().locations_feature_online_stores_feature_views_delete(...).doit().await
let r = hub.projects().locations_feature_online_stores_operations_get(...).doit().await
let r = hub.projects().locations_feature_online_stores_operations_wait(...).doit().await
let r = hub.projects().locations_feature_online_stores_patch(...).doit().await
let r = hub.projects().locations_feature_online_stores_create(...).doit().await
let r = hub.projects().locations_feature_online_stores_delete(...).doit().await
let r = hub.projects().locations_index_endpoints_operations_get(...).doit().await
let r = hub.projects().locations_index_endpoints_operations_wait(...).doit().await
let r = hub.projects().locations_index_endpoints_mutate_deployed_index(...).doit().await
let r = hub.projects().locations_index_endpoints_undeploy_index(...).doit().await
let r = hub.projects().locations_index_endpoints_deploy_index(...).doit().await
let r = hub.projects().locations_index_endpoints_delete(...).doit().await
let r = hub.projects().locations_index_endpoints_create(...).doit().await
let r = hub.projects().locations_endpoints_operations_get(...).doit().await
let r = hub.projects().locations_endpoints_operations_wait(...).doit().await
let r = hub.projects().locations_endpoints_undeploy_model(...).doit().await
let r = hub.projects().locations_endpoints_deploy_model(...).doit().await
let r = hub.projects().locations_endpoints_delete(...).doit().await
let r = hub.projects().locations_endpoints_mutate_deployed_model(...).doit().await
let r = hub.projects().locations_endpoints_create(...).doit().await
let r = hub.projects().locations_specialist_pools_operations_get(...).doit().await
let r = hub.projects().locations_specialist_pools_operations_wait(...).doit().await
let r = hub.projects().locations_specialist_pools_patch(...).doit().await
let r = hub.projects().locations_specialist_pools_delete(...).doit().await
let r = hub.projects().locations_specialist_pools_create(...).doit().await
let r = hub.projects().locations_custom_jobs_operations_get(...).doit().await
let r = hub.projects().locations_custom_jobs_operations_wait(...).doit().await
let r = hub.projects().locations_custom_jobs_delete(...).doit().await
let r = hub.projects().locations_model_deployment_monitoring_jobs_operations_get(...).doit().await
let r = hub.projects().locations_model_deployment_monitoring_jobs_operations_wait(...).doit().await
let r = hub.projects().locations_model_deployment_monitoring_jobs_patch(...).doit().await
let r = hub.projects().locations_model_deployment_monitoring_jobs_delete(...).doit().await
let r = hub.projects().locations_datasets_data_items_operations_wait(...).doit().await
let r = hub.projects().locations_datasets_data_items_operations_get(...).doit().await
let r = hub.projects().locations_datasets_data_items_annotations_operations_get(...).doit().await
let r = hub.projects().locations_datasets_data_items_annotations_operations_wait(...).doit().await
let r = hub.projects().locations_datasets_annotation_specs_operations_wait(...).doit().await
let r = hub.projects().locations_datasets_annotation_specs_operations_get(...).doit().await
let r = hub.projects().locations_datasets_dataset_versions_delete(...).doit().await
let r = hub.projects().locations_datasets_dataset_versions_create(...).doit().await
let r = hub.projects().locations_datasets_dataset_versions_restore(...).doit().await
let r = hub.projects().locations_datasets_saved_queries_operations_wait(...).doit().await
let r = hub.projects().locations_datasets_saved_queries_operations_get(...).doit().await
let r = hub.projects().locations_datasets_saved_queries_delete(...).doit().await
let r = hub.projects().locations_datasets_operations_wait(...).doit().await
let r = hub.projects().locations_datasets_operations_get(...).doit().await
let r = hub.projects().locations_datasets_delete(...).doit().await
let r = hub.projects().locations_datasets_export(...).doit().await
let r = hub.projects().locations_datasets_import(...).doit().await
let r = hub.projects().locations_datasets_create(...).doit().await
let r = hub.projects().locations_featurestores_operations_wait(...).doit().await
let r = hub.projects().locations_featurestores_operations_get(...).doit().await
let r = hub.projects().locations_featurestores_entity_types_operations_get(...).doit().await
let r = hub.projects().locations_featurestores_entity_types_operations_wait(...).doit().await
let r = hub.projects().locations_featurestores_entity_types_features_operations_get(...).doit().await
let r = hub.projects().locations_featurestores_entity_types_features_operations_wait(...).doit().await
let r = hub.projects().locations_featurestores_entity_types_features_delete(...).doit().await
let r = hub.projects().locations_featurestores_entity_types_features_create(...).doit().await
let r = hub.projects().locations_featurestores_entity_types_features_batch_create(...).doit().await
let r = hub.projects().locations_featurestores_entity_types_delete(...).doit().await
let r = hub.projects().locations_featurestores_entity_types_export_feature_values(...).doit().await
let r = hub.projects().locations_featurestores_entity_types_create(...).doit().await
let r = hub.projects().locations_featurestores_entity_types_delete_feature_values(...).doit().await
let r = hub.projects().locations_featurestores_entity_types_import_feature_values(...).doit().await
let r = hub.projects().locations_featurestores_patch(...).doit().await
let r = hub.projects().locations_featurestores_create(...).doit().await
let r = hub.projects().locations_featurestores_delete(...).doit().await
let r = hub.projects().locations_featurestores_batch_read_feature_values(...).doit().await
let r = hub.projects().locations_notebook_runtimes_operations_wait(...).doit().await
let r = hub.projects().locations_notebook_runtimes_operations_get(...).doit().await
let r = hub.projects().locations_notebook_runtimes_upgrade(...).doit().await
let r = hub.projects().locations_notebook_runtimes_delete(...).doit().await
let r = hub.projects().locations_notebook_runtimes_start(...).doit().await
let r = hub.projects().locations_notebook_runtimes_assign(...).doit().await
let r = hub.projects().locations_metadata_stores_executions_operations_wait(...).doit().await
let r = hub.projects().locations_metadata_stores_executions_operations_get(...).doit().await
let r = hub.projects().locations_metadata_stores_executions_purge(...).doit().await
let r = hub.projects().locations_metadata_stores_executions_delete(...).doit().await
let r = hub.projects().locations_metadata_stores_contexts_operations_get(...).doit().await
let r = hub.projects().locations_metadata_stores_contexts_operations_wait(...).doit().await
let r = hub.projects().locations_metadata_stores_contexts_delete(...).doit().await
let r = hub.projects().locations_metadata_stores_contexts_purge(...).doit().await
let r = hub.projects().locations_metadata_stores_artifacts_operations_wait(...).doit().await
let r = hub.projects().locations_metadata_stores_artifacts_operations_get(...).doit().await
let r = hub.projects().locations_metadata_stores_artifacts_delete(...).doit().await
let r = hub.projects().locations_metadata_stores_artifacts_purge(...).doit().await
let r = hub.projects().locations_metadata_stores_operations_get(...).doit().await
let r = hub.projects().locations_metadata_stores_operations_wait(...).doit().await
let r = hub.projects().locations_metadata_stores_delete(...).doit().await
let r = hub.projects().locations_metadata_stores_create(...).doit().await
let r = hub.projects().locations_operations_wait(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_hyperparameter_tuning_jobs_operations_get(...).doit().await
let r = hub.projects().locations_hyperparameter_tuning_jobs_operations_wait(...).doit().await
let r = hub.projects().locations_hyperparameter_tuning_jobs_delete(...).doit().await
let r = hub.projects().locations_persistent_resources_operations_get(...).doit().await
let r = hub.projects().locations_persistent_resources_operations_wait(...).doit().await
let r = hub.projects().locations_persistent_resources_patch(...).doit().await
let r = hub.projects().locations_persistent_resources_reboot(...).doit().await
let r = hub.projects().locations_persistent_resources_delete(...).doit().await
let r = hub.projects().locations_persistent_resources_create(...).doit().await
let r = hub.projects().locations_models_evaluations_operations_wait(...).doit().await
let r = hub.projects().locations_models_evaluations_operations_get(...).doit().await
let r = hub.projects().locations_models_operations_wait(...).doit().await
let r = hub.projects().locations_models_operations_get(...).doit().await
let r = hub.projects().locations_models_delete(...).doit().await
let r = hub.projects().locations_models_update_explanation_dataset(...).doit().await
let r = hub.projects().locations_models_copy(...).doit().await
let r = hub.projects().locations_models_upload(...).doit().await
let r = hub.projects().locations_models_export(...).doit().await
let r = hub.projects().locations_models_delete_version(...).doit().await
let r = hub.projects().locations_notebook_runtime_templates_operations_get(...).doit().await
let r = hub.projects().locations_notebook_runtime_templates_operations_wait(...).doit().await
let r = hub.projects().locations_notebook_runtime_templates_create(...).doit().await
let r = hub.projects().locations_notebook_runtime_templates_delete(...).doit().await
let r = hub.projects().locations_batch_prediction_jobs_delete(...).doit().await
let r = hub.projects().locations_tuning_jobs_operations_get(...).doit().await
let r = hub.projects().locations_deployment_resource_pools_operations_get(...).doit().await
let r = hub.projects().locations_deployment_resource_pools_operations_wait(...).doit().await
let r = hub.projects().locations_deployment_resource_pools_patch(...).doit().await
let r = hub.projects().locations_deployment_resource_pools_create(...).doit().await
let r = hub.projects().locations_deployment_resource_pools_delete(...).doit().await
let r = hub.projects().locations_pipeline_jobs_operations_get(...).doit().await
let r = hub.projects().locations_pipeline_jobs_operations_wait(...).doit().await
let r = hub.projects().locations_pipeline_jobs_delete(...).doit().await
let r = hub.projects().locations_pipeline_jobs_batch_delete(...).doit().await
let r = hub.projects().locations_pipeline_jobs_batch_cancel(...).doit().await

The resource() and activity(...) calls create builders. The second one dealing with Activities supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be specified right away (i.e. (...)), whereas all optional ones can be build up as desired. The doit() method performs the actual communication with the server and returns the respective result.

Usage

Setting up your Project

To use this library, you would put the following lines into your Cargo.toml file:

[dependencies]
google-aiplatform1 = "*"
serde = "1"
serde_json = "1"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate google_aiplatform1 as aiplatform1;
use aiplatform1::api::GoogleCloudAiplatformV1FeatureView;
use aiplatform1::{Result, Error};
use aiplatform1::{Aiplatform, FieldMask, hyper_rustls, hyper_util, yup_oauth2};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// `client_secret`, among other things.
let secret: yup_oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you,
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = yup_oauth2::InstalledFlowAuthenticator::builder(
    secret,
    yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();

let client = hyper_util::client::legacy::Client::builder(
    hyper_util::rt::TokioExecutor::new()
)
.build(
    hyper_rustls::HttpsConnectorBuilder::new()
        .with_native_roots()
        .unwrap()
        .https_or_http()
        .enable_http1()
        .build()
);
let mut hub = Aiplatform::new(client, auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = GoogleCloudAiplatformV1FeatureView::default();

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().locations_feature_online_stores_feature_views_create(req, "parent")
             .run_sync_immediately(true)
             .feature_view_id("voluptua.")
             .doit().await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

Handling Errors

All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.

When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors.

Uploads and Downloads

If a method supports downloads, the response body, which is part of the Result, should be read by you to obtain the media. If such a method also supports a Response Result, it will return that by default. You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making this call: .param("alt", "media").

Methods supporting uploads can do so using up to 2 different protocols: simple and resumable. The distinctiveness of each is represented by customized doit(...) methods, which are then named upload(...) and upload_resumable(...) respectively.

Customization and Callbacks

You may alter the way an doit() method is called by providing a delegate to the Method Builder before making the final doit() call. Respective methods will be called to provide progress information, as well as determine whether the system should retry on failure.

The delegate trait is default-implemented, allowing you to customize it with minimal effort.

Optional Parts in Server-Requests

All structures provided by this library are made to be encodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response.

Builder Arguments

Using method builders, you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true.

• PODs are handed by copy
• strings are passed as &str
• request values are moved

Arguments will always be copied or cloned into the builder, to make them independent of their original life times.

Cargo Features

• utoipa - Add support for utoipa and derive utoipa::ToSchema on all the types. You'll have to import and register the required types in #[openapi(schemas(...))], otherwise the generated openapi spec would be invalid.

License

The aiplatform1 library was generated by Sebastian Thiel, and is placed under the MIT license. You can read the full text at the repository's license file.