google-cloud-ai_platform-v1 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +149 -0
- data/LICENSE.md +201 -0
- data/README.md +139 -0
- data/lib/google/cloud/ai_platform/v1/dataset_service/client.rb +1364 -0
- data/lib/google/cloud/ai_platform/v1/dataset_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/dataset_service/operations.rb +767 -0
- data/lib/google/cloud/ai_platform/v1/dataset_service/paths.rb +111 -0
- data/lib/google/cloud/ai_platform/v1/dataset_service.rb +51 -0
- data/lib/google/cloud/ai_platform/v1/endpoint_service/client.rb +1076 -0
- data/lib/google/cloud/ai_platform/v1/endpoint_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/endpoint_service/operations.rb +767 -0
- data/lib/google/cloud/ai_platform/v1/endpoint_service/paths.rb +124 -0
- data/lib/google/cloud/ai_platform/v1/endpoint_service.rb +50 -0
- data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb +508 -0
- data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/paths.rb +54 -0
- data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service.rb +49 -0
- data/lib/google/cloud/ai_platform/v1/featurestore_service/client.rb +2707 -0
- data/lib/google/cloud/ai_platform/v1/featurestore_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/featurestore_service/operations.rb +767 -0
- data/lib/google/cloud/ai_platform/v1/featurestore_service/paths.rb +113 -0
- data/lib/google/cloud/ai_platform/v1/featurestore_service.rb +50 -0
- data/lib/google/cloud/ai_platform/v1/index_endpoint_service/client.rb +1146 -0
- data/lib/google/cloud/ai_platform/v1/index_endpoint_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/index_endpoint_service/operations.rb +767 -0
- data/lib/google/cloud/ai_platform/v1/index_endpoint_service/paths.rb +88 -0
- data/lib/google/cloud/ai_platform/v1/index_endpoint_service.rb +50 -0
- data/lib/google/cloud/ai_platform/v1/index_service/client.rb +823 -0
- data/lib/google/cloud/ai_platform/v1/index_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/index_service/operations.rb +767 -0
- data/lib/google/cloud/ai_platform/v1/index_service/paths.rb +88 -0
- data/lib/google/cloud/ai_platform/v1/index_service.rb +50 -0
- data/lib/google/cloud/ai_platform/v1/job_service/client.rb +3236 -0
- data/lib/google/cloud/ai_platform/v1/job_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/job_service/operations.rb +767 -0
- data/lib/google/cloud/ai_platform/v1/job_service/paths.rb +259 -0
- data/lib/google/cloud/ai_platform/v1/job_service.rb +50 -0
- data/lib/google/cloud/ai_platform/v1/metadata_service/client.rb +3654 -0
- data/lib/google/cloud/ai_platform/v1/metadata_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/metadata_service/operations.rb +767 -0
- data/lib/google/cloud/ai_platform/v1/metadata_service/paths.rb +153 -0
- data/lib/google/cloud/ai_platform/v1/metadata_service.rb +50 -0
- data/lib/google/cloud/ai_platform/v1/migration_service/client.rb +538 -0
- data/lib/google/cloud/ai_platform/v1/migration_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/migration_service/operations.rb +767 -0
- data/lib/google/cloud/ai_platform/v1/migration_service/paths.rb +148 -0
- data/lib/google/cloud/ai_platform/v1/migration_service.rb +51 -0
- data/lib/google/cloud/ai_platform/v1/model_service/client.rb +1355 -0
- data/lib/google/cloud/ai_platform/v1/model_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/model_service/operations.rb +767 -0
- data/lib/google/cloud/ai_platform/v1/model_service/paths.rb +151 -0
- data/lib/google/cloud/ai_platform/v1/model_service.rb +50 -0
- data/lib/google/cloud/ai_platform/v1/pipeline_service/client.rb +1384 -0
- data/lib/google/cloud/ai_platform/v1/pipeline_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/pipeline_service/operations.rb +767 -0
- data/lib/google/cloud/ai_platform/v1/pipeline_service/paths.rb +225 -0
- data/lib/google/cloud/ai_platform/v1/pipeline_service.rb +52 -0
- data/lib/google/cloud/ai_platform/v1/prediction_service/client.rb +650 -0
- data/lib/google/cloud/ai_platform/v1/prediction_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/prediction_service/paths.rb +52 -0
- data/lib/google/cloud/ai_platform/v1/prediction_service.rb +49 -0
- data/lib/google/cloud/ai_platform/v1/specialist_pool_service/client.rb +826 -0
- data/lib/google/cloud/ai_platform/v1/specialist_pool_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/specialist_pool_service/operations.rb +767 -0
- data/lib/google/cloud/ai_platform/v1/specialist_pool_service/paths.rb +69 -0
- data/lib/google/cloud/ai_platform/v1/specialist_pool_service.rb +55 -0
- data/lib/google/cloud/ai_platform/v1/tensorboard_service/client.rb +3224 -0
- data/lib/google/cloud/ai_platform/v1/tensorboard_service/credentials.rb +48 -0
- data/lib/google/cloud/ai_platform/v1/tensorboard_service/operations.rb +767 -0
- data/lib/google/cloud/ai_platform/v1/tensorboard_service/paths.rb +138 -0
- data/lib/google/cloud/ai_platform/v1/tensorboard_service.rb +50 -0
- data/lib/google/cloud/ai_platform/v1/version.rb +28 -0
- data/lib/google/cloud/ai_platform/v1/vizier_service/client.rb +1793 -0
- data/lib/google/cloud/ai_platform/v1/vizier_service/credentials.rb +47 -0
- data/lib/google/cloud/ai_platform/v1/vizier_service/operations.rb +767 -0
- data/lib/google/cloud/ai_platform/v1/vizier_service/paths.rb +109 -0
- data/lib/google/cloud/ai_platform/v1/vizier_service.rb +54 -0
- data/lib/google/cloud/ai_platform/v1.rb +52 -0
- data/lib/google/cloud/aiplatform/v1/accelerator_type_pb.rb +29 -0
- data/lib/google/cloud/aiplatform/v1/annotation_pb.rb +35 -0
- data/lib/google/cloud/aiplatform/v1/annotation_spec_pb.rb +30 -0
- data/lib/google/cloud/aiplatform/v1/artifact_pb.rb +45 -0
- data/lib/google/cloud/aiplatform/v1/batch_prediction_job_pb.rb +83 -0
- data/lib/google/cloud/aiplatform/v1/completion_stats_pb.rb +27 -0
- data/lib/google/cloud/aiplatform/v1/context_pb.rb +38 -0
- data/lib/google/cloud/aiplatform/v1/custom_job_pb.rb +84 -0
- data/lib/google/cloud/aiplatform/v1/data_item_pb.rb +32 -0
- data/lib/google/cloud/aiplatform/v1/data_labeling_job_pb.rb +78 -0
- data/lib/google/cloud/aiplatform/v1/dataset_pb.rb +53 -0
- data/lib/google/cloud/aiplatform/v1/dataset_service_pb.rb +126 -0
- data/lib/google/cloud/aiplatform/v1/dataset_service_services_pb.rb +64 -0
- data/lib/google/cloud/aiplatform/v1/deployed_index_ref_pb.rb +26 -0
- data/lib/google/cloud/aiplatform/v1/deployed_model_ref_pb.rb +26 -0
- data/lib/google/cloud/aiplatform/v1/encryption_spec_pb.rb +24 -0
- data/lib/google/cloud/aiplatform/v1/endpoint_pb.rb +67 -0
- data/lib/google/cloud/aiplatform/v1/endpoint_service_pb.rb +90 -0
- data/lib/google/cloud/aiplatform/v1/endpoint_service_services_pb.rb +58 -0
- data/lib/google/cloud/aiplatform/v1/entity_type_pb.rb +32 -0
- data/lib/google/cloud/aiplatform/v1/env_var_pb.rb +25 -0
- data/lib/google/cloud/aiplatform/v1/event_pb.rb +36 -0
- data/lib/google/cloud/aiplatform/v1/execution_pb.rb +48 -0
- data/lib/google/cloud/aiplatform/v1/explanation_metadata_pb.rb +107 -0
- data/lib/google/cloud/aiplatform/v1/explanation_pb.rb +106 -0
- data/lib/google/cloud/aiplatform/v1/feature_monitoring_stats_pb.rb +30 -0
- data/lib/google/cloud/aiplatform/v1/feature_pb.rb +46 -0
- data/lib/google/cloud/aiplatform/v1/feature_selector_pb.rb +28 -0
- data/lib/google/cloud/aiplatform/v1/featurestore_online_service_pb.rb +86 -0
- data/lib/google/cloud/aiplatform/v1/featurestore_online_service_services_pb.rb +51 -0
- data/lib/google/cloud/aiplatform/v1/featurestore_pb.rb +44 -0
- data/lib/google/cloud/aiplatform/v1/featurestore_service_pb.rb +280 -0
- data/lib/google/cloud/aiplatform/v1/featurestore_service_services_pb.rb +109 -0
- data/lib/google/cloud/aiplatform/v1/hyperparameter_tuning_job_pb.rb +46 -0
- data/lib/google/cloud/aiplatform/v1/index_endpoint_pb.rb +66 -0
- data/lib/google/cloud/aiplatform/v1/index_endpoint_service_pb.rb +101 -0
- data/lib/google/cloud/aiplatform/v1/index_endpoint_service_services_pb.rb +62 -0
- data/lib/google/cloud/aiplatform/v1/index_pb.rb +38 -0
- data/lib/google/cloud/aiplatform/v1/index_service_pb.rb +98 -0
- data/lib/google/cloud/aiplatform/v1/index_service_services_pb.rb +55 -0
- data/lib/google/cloud/aiplatform/v1/io_pb.rb +56 -0
- data/lib/google/cloud/aiplatform/v1/job_service_pb.rb +217 -0
- data/lib/google/cloud/aiplatform/v1/job_service_services_pb.rb +134 -0
- data/lib/google/cloud/aiplatform/v1/job_state_pb.rb +32 -0
- data/lib/google/cloud/aiplatform/v1/lineage_subgraph_pb.rb +28 -0
- data/lib/google/cloud/aiplatform/v1/machine_resources_pb.rb +59 -0
- data/lib/google/cloud/aiplatform/v1/manual_batch_tuning_parameters_pb.rb +24 -0
- data/lib/google/cloud/aiplatform/v1/metadata_schema_pb.rb +38 -0
- data/lib/google/cloud/aiplatform/v1/metadata_service_pb.rb +272 -0
- data/lib/google/cloud/aiplatform/v1/metadata_service_services_pb.rb +119 -0
- data/lib/google/cloud/aiplatform/v1/metadata_store_pb.rb +36 -0
- data/lib/google/cloud/aiplatform/v1/migratable_resource_pb.rb +59 -0
- data/lib/google/cloud/aiplatform/v1/migration_service_pb.rb +106 -0
- data/lib/google/cloud/aiplatform/v1/migration_service_services_pb.rb +51 -0
- data/lib/google/cloud/aiplatform/v1/model_deployment_monitoring_job_pb.rb +111 -0
- data/lib/google/cloud/aiplatform/v1/model_evaluation_pb.rb +33 -0
- data/lib/google/cloud/aiplatform/v1/model_evaluation_slice_pb.rb +36 -0
- data/lib/google/cloud/aiplatform/v1/model_monitoring_pb.rb +93 -0
- data/lib/google/cloud/aiplatform/v1/model_pb.rb +88 -0
- data/lib/google/cloud/aiplatform/v1/model_service_pb.rb +129 -0
- data/lib/google/cloud/aiplatform/v1/model_service_services_pb.rb +69 -0
- data/lib/google/cloud/aiplatform/v1/operation_pb.rb +32 -0
- data/lib/google/cloud/aiplatform/v1/pipeline_job_pb.rb +115 -0
- data/lib/google/cloud/aiplatform/v1/pipeline_service_pb.rb +88 -0
- data/lib/google/cloud/aiplatform/v1/pipeline_service_services_pb.rb +84 -0
- data/lib/google/cloud/aiplatform/v1/pipeline_state_pb.rb +31 -0
- data/lib/google/cloud/aiplatform/v1/prediction_service_pb.rb +57 -0
- data/lib/google/cloud/aiplatform/v1/prediction_service_services_pb.rb +66 -0
- data/lib/google/cloud/aiplatform/v1/specialist_pool_pb.rb +30 -0
- data/lib/google/cloud/aiplatform/v1/specialist_pool_service_pb.rb +66 -0
- data/lib/google/cloud/aiplatform/v1/specialist_pool_service_services_pb.rb +58 -0
- data/lib/google/cloud/aiplatform/v1/study_pb.rb +191 -0
- data/lib/google/cloud/aiplatform/v1/tensorboard_data_pb.rb +56 -0
- data/lib/google/cloud/aiplatform/v1/tensorboard_experiment_pb.rb +33 -0
- data/lib/google/cloud/aiplatform/v1/tensorboard_pb.rb +36 -0
- data/lib/google/cloud/aiplatform/v1/tensorboard_run_pb.rb +32 -0
- data/lib/google/cloud/aiplatform/v1/tensorboard_service_pb.rb +244 -0
- data/lib/google/cloud/aiplatform/v1/tensorboard_service_services_pb.rb +115 -0
- data/lib/google/cloud/aiplatform/v1/tensorboard_time_series_pb.rb +48 -0
- data/lib/google/cloud/aiplatform/v1/training_pipeline_pb.rb +95 -0
- data/lib/google/cloud/aiplatform/v1/types_pb.rb +35 -0
- data/lib/google/cloud/aiplatform/v1/unmanaged_container_model_pb.rb +27 -0
- data/lib/google/cloud/aiplatform/v1/user_action_reference_pb.rb +27 -0
- data/lib/google/cloud/aiplatform/v1/value_pb.rb +27 -0
- data/lib/google/cloud/aiplatform/v1/vizier_service_pb.rb +136 -0
- data/lib/google/cloud/aiplatform/v1/vizier_service_services_pb.rb +90 -0
- data/lib/google-cloud-ai_platform-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +71 -0
- data/proto_docs/google/api/httpbody.rb +80 -0
- data/proto_docs/google/api/resource.rb +222 -0
- data/proto_docs/google/cloud/aiplatform/v1/accelerator_type.rb +50 -0
- data/proto_docs/google/cloud/aiplatform/v1/annotation.rb +92 -0
- data/proto_docs/google/cloud/aiplatform/v1/annotation_spec.rb +50 -0
- data/proto_docs/google/cloud/aiplatform/v1/artifact.rb +112 -0
- data/proto_docs/google/cloud/aiplatform/v1/batch_prediction_job.rb +278 -0
- data/proto_docs/google/cloud/aiplatform/v1/completion_stats.rb +46 -0
- data/proto_docs/google/cloud/aiplatform/v1/context.rb +92 -0
- data/proto_docs/google/cloud/aiplatform/v1/custom_job.rb +272 -0
- data/proto_docs/google/cloud/aiplatform/v1/data_item.rb +73 -0
- data/proto_docs/google/cloud/aiplatform/v1/data_labeling_job.rb +207 -0
- data/proto_docs/google/cloud/aiplatform/v1/dataset.rb +154 -0
- data/proto_docs/google/cloud/aiplatform/v1/dataset_service.rb +301 -0
- data/proto_docs/google/cloud/aiplatform/v1/deployed_index_ref.rb +38 -0
- data/proto_docs/google/cloud/aiplatform/v1/deployed_model_ref.rb +38 -0
- data/proto_docs/google/cloud/aiplatform/v1/encryption_spec.rb +40 -0
- data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +227 -0
- data/proto_docs/google/cloud/aiplatform/v1/endpoint_service.rb +258 -0
- data/proto_docs/google/cloud/aiplatform/v1/entity_type.rb +79 -0
- data/proto_docs/google/cloud/aiplatform/v1/env_var.rb +44 -0
- data/proto_docs/google/cloud/aiplatform/v1/event.rb +79 -0
- data/proto_docs/google/cloud/aiplatform/v1/execution.rb +118 -0
- data/proto_docs/google/cloud/aiplatform/v1/explanation.rb +445 -0
- data/proto_docs/google/cloud/aiplatform/v1/explanation_metadata.rb +419 -0
- data/proto_docs/google/cloud/aiplatform/v1/feature.rb +115 -0
- data/proto_docs/google/cloud/aiplatform/v1/feature_monitoring_stats.rb +88 -0
- data/proto_docs/google/cloud/aiplatform/v1/feature_selector.rb +49 -0
- data/proto_docs/google/cloud/aiplatform/v1/featurestore.rb +115 -0
- data/proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb +203 -0
- data/proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb +978 -0
- data/proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb +109 -0
- data/proto_docs/google/cloud/aiplatform/v1/index.rb +98 -0
- data/proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb +252 -0
- data/proto_docs/google/cloud/aiplatform/v1/index_endpoint_service.rb +240 -0
- data/proto_docs/google/cloud/aiplatform/v1/index_service.rb +220 -0
- data/proto_docs/google/cloud/aiplatform/v1/io.rb +134 -0
- data/proto_docs/google/cloud/aiplatform/v1/job_service.rb +660 -0
- data/proto_docs/google/cloud/aiplatform/v1/job_state.rb +60 -0
- data/proto_docs/google/cloud/aiplatform/v1/lineage_subgraph.rb +42 -0
- data/proto_docs/google/cloud/aiplatform/v1/machine_resources.rb +194 -0
- data/proto_docs/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.rb +41 -0
- data/proto_docs/google/cloud/aiplatform/v1/metadata_schema.rb +74 -0
- data/proto_docs/google/cloud/aiplatform/v1/metadata_service.rb +912 -0
- data/proto_docs/google/cloud/aiplatform/v1/metadata_store.rb +62 -0
- data/proto_docs/google/cloud/aiplatform/v1/migratable_resource.rb +133 -0
- data/proto_docs/google/cloud/aiplatform/v1/migration_service.rb +260 -0
- data/proto_docs/google/cloud/aiplatform/v1/model.rb +562 -0
- data/proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb +293 -0
- data/proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb +60 -0
- data/proto_docs/google/cloud/aiplatform/v1/model_evaluation_slice.rb +68 -0
- data/proto_docs/google/cloud/aiplatform/v1/model_monitoring.rb +257 -0
- data/proto_docs/google/cloud/aiplatform/v1/model_service.rb +329 -0
- data/proto_docs/google/cloud/aiplatform/v1/operation.rb +55 -0
- data/proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb +347 -0
- data/proto_docs/google/cloud/aiplatform/v1/pipeline_service.rb +258 -0
- data/proto_docs/google/cloud/aiplatform/v1/pipeline_state.rb +59 -0
- data/proto_docs/google/cloud/aiplatform/v1/prediction_service.rb +165 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.rb +52 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.rb +52 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.rb +47 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/text_classification.rb +46 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/text_extraction.rb +53 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/text_sentiment.rb +46 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/video_action_recognition.rb +59 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/video_classification.rb +59 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/video_object_tracking.rb +59 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/image_classification.rb +47 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/image_object_detection.rb +47 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/image_segmentation.rb +44 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/video_action_recognition.rb +47 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/video_classification.rb +72 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/video_object_tracking.rb +51 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/classification.rb +49 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/image_object_detection.rb +58 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/image_segmentation.rb +53 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_classification.rb +47 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_regression.rb +47 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/text_extraction.rb +60 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/text_sentiment.rb +45 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/video_action_recognition.rb +60 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/video_classification.rb +73 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/video_object_tracking.rb +91 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_classification.rb +142 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_object_detection.rb +134 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_segmentation.rb +120 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_tables.rb +315 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_classification.rb +48 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_extraction.rb +46 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_sentiment.rb +55 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_action_recognition.rb +73 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_classification.rb +67 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_object_tracking.rb +78 -0
- data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/export_evaluated_data_items_config.rb +51 -0
- data/proto_docs/google/cloud/aiplatform/v1/specialist_pool.rb +58 -0
- data/proto_docs/google/cloud/aiplatform/v1/specialist_pool_service.rb +136 -0
- data/proto_docs/google/cloud/aiplatform/v1/study.rb +543 -0
- data/proto_docs/google/cloud/aiplatform/v1/tensorboard.rb +89 -0
- data/proto_docs/google/cloud/aiplatform/v1/tensorboard_data.rb +110 -0
- data/proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb +82 -0
- data/proto_docs/google/cloud/aiplatform/v1/tensorboard_run.rb +85 -0
- data/proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb +706 -0
- data/proto_docs/google/cloud/aiplatform/v1/tensorboard_time_series.rb +101 -0
- data/proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb +381 -0
- data/proto_docs/google/cloud/aiplatform/v1/types.rb +62 -0
- data/proto_docs/google/cloud/aiplatform/v1/unmanaged_container_model.rb +44 -0
- data/proto_docs/google/cloud/aiplatform/v1/user_action_reference.rb +49 -0
- data/proto_docs/google/cloud/aiplatform/v1/value.rb +41 -0
- data/proto_docs/google/cloud/aiplatform/v1/vizier_service.rb +332 -0
- data/proto_docs/google/longrunning/operations.rb +164 -0
- data/proto_docs/google/protobuf/any.rb +141 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/struct.rb +96 -0
- data/proto_docs/google/protobuf/timestamp.rb +129 -0
- data/proto_docs/google/protobuf/wrappers.rb +121 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- data/proto_docs/google/type/money.rb +43 -0
- metadata +479 -0
|
@@ -0,0 +1,3654 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2022 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
require "google/cloud/errors"
|
|
20
|
+
require "google/cloud/aiplatform/v1/metadata_service_pb"
|
|
21
|
+
|
|
22
|
+
module Google
|
|
23
|
+
module Cloud
|
|
24
|
+
module AIPlatform
|
|
25
|
+
module V1
|
|
26
|
+
module MetadataService
|
|
27
|
+
##
|
|
28
|
+
# Client for the MetadataService service.
|
|
29
|
+
#
|
|
30
|
+
# Service for reading and writing metadata entries.
|
|
31
|
+
#
|
|
32
|
+
class Client
|
|
33
|
+
include Paths
|
|
34
|
+
|
|
35
|
+
# @private
|
|
36
|
+
attr_reader :metadata_service_stub
|
|
37
|
+
|
|
38
|
+
##
|
|
39
|
+
# Configure the MetadataService Client class.
|
|
40
|
+
#
|
|
41
|
+
# See {::Google::Cloud::AIPlatform::V1::MetadataService::Client::Configuration}
|
|
42
|
+
# for a description of the configuration fields.
|
|
43
|
+
#
|
|
44
|
+
# @example
|
|
45
|
+
#
|
|
46
|
+
# # Modify the configuration for all MetadataService clients
|
|
47
|
+
# ::Google::Cloud::AIPlatform::V1::MetadataService::Client.configure do |config|
|
|
48
|
+
# config.timeout = 10.0
|
|
49
|
+
# end
|
|
50
|
+
#
|
|
51
|
+
# @yield [config] Configure the Client client.
|
|
52
|
+
# @yieldparam config [Client::Configuration]
|
|
53
|
+
#
|
|
54
|
+
# @return [Client::Configuration]
|
|
55
|
+
#
|
|
56
|
+
def self.configure
|
|
57
|
+
@configure ||= begin
|
|
58
|
+
namespace = ["Google", "Cloud", "AIPlatform", "V1"]
|
|
59
|
+
parent_config = while namespace.any?
|
|
60
|
+
parent_name = namespace.join "::"
|
|
61
|
+
parent_const = const_get parent_name
|
|
62
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
|
63
|
+
namespace.pop
|
|
64
|
+
end
|
|
65
|
+
default_config = Client::Configuration.new parent_config
|
|
66
|
+
|
|
67
|
+
default_config
|
|
68
|
+
end
|
|
69
|
+
yield @configure if block_given?
|
|
70
|
+
@configure
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
##
|
|
74
|
+
# Configure the MetadataService Client instance.
|
|
75
|
+
#
|
|
76
|
+
# The configuration is set to the derived mode, meaning that values can be changed,
|
|
77
|
+
# but structural changes (adding new fields, etc.) are not allowed. Structural changes
|
|
78
|
+
# should be made on {Client.configure}.
|
|
79
|
+
#
|
|
80
|
+
# See {::Google::Cloud::AIPlatform::V1::MetadataService::Client::Configuration}
|
|
81
|
+
# for a description of the configuration fields.
|
|
82
|
+
#
|
|
83
|
+
# @yield [config] Configure the Client client.
|
|
84
|
+
# @yieldparam config [Client::Configuration]
|
|
85
|
+
#
|
|
86
|
+
# @return [Client::Configuration]
|
|
87
|
+
#
|
|
88
|
+
def configure
|
|
89
|
+
yield @config if block_given?
|
|
90
|
+
@config
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
##
|
|
94
|
+
# Create a new MetadataService client object.
|
|
95
|
+
#
|
|
96
|
+
# @example
|
|
97
|
+
#
|
|
98
|
+
# # Create a client using the default configuration
|
|
99
|
+
# client = ::Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
100
|
+
#
|
|
101
|
+
# # Create a client using a custom configuration
|
|
102
|
+
# client = ::Google::Cloud::AIPlatform::V1::MetadataService::Client.new do |config|
|
|
103
|
+
# config.timeout = 10.0
|
|
104
|
+
# end
|
|
105
|
+
#
|
|
106
|
+
# @yield [config] Configure the MetadataService client.
|
|
107
|
+
# @yieldparam config [Client::Configuration]
|
|
108
|
+
#
|
|
109
|
+
def initialize
|
|
110
|
+
# These require statements are intentionally placed here to initialize
|
|
111
|
+
# the gRPC module only when it's required.
|
|
112
|
+
# See https://github.com/googleapis/toolkit/issues/446
|
|
113
|
+
require "gapic/grpc"
|
|
114
|
+
require "google/cloud/aiplatform/v1/metadata_service_services_pb"
|
|
115
|
+
|
|
116
|
+
# Create the configuration object
|
|
117
|
+
@config = Configuration.new Client.configure
|
|
118
|
+
|
|
119
|
+
# Yield the configuration if needed
|
|
120
|
+
yield @config if block_given?
|
|
121
|
+
|
|
122
|
+
# Create credentials
|
|
123
|
+
credentials = @config.credentials
|
|
124
|
+
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
125
|
+
# but only if the default endpoint does not have a region prefix.
|
|
126
|
+
enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
|
|
127
|
+
!@config.endpoint.split(".").first.include?("-")
|
|
128
|
+
credentials ||= Credentials.default scope: @config.scope,
|
|
129
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
|
130
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
131
|
+
credentials = Credentials.new credentials, scope: @config.scope
|
|
132
|
+
end
|
|
133
|
+
@quota_project_id = @config.quota_project
|
|
134
|
+
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
135
|
+
|
|
136
|
+
@operations_client = Operations.new do |config|
|
|
137
|
+
config.credentials = credentials
|
|
138
|
+
config.quota_project = @quota_project_id
|
|
139
|
+
config.endpoint = @config.endpoint
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
@metadata_service_stub = ::Gapic::ServiceStub.new(
|
|
143
|
+
::Google::Cloud::AIPlatform::V1::MetadataService::Stub,
|
|
144
|
+
credentials: credentials,
|
|
145
|
+
endpoint: @config.endpoint,
|
|
146
|
+
channel_args: @config.channel_args,
|
|
147
|
+
interceptors: @config.interceptors
|
|
148
|
+
)
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
##
|
|
152
|
+
# Get the associated client for long-running operations.
|
|
153
|
+
#
|
|
154
|
+
# @return [::Google::Cloud::AIPlatform::V1::MetadataService::Operations]
|
|
155
|
+
#
|
|
156
|
+
attr_reader :operations_client
|
|
157
|
+
|
|
158
|
+
# Service calls
|
|
159
|
+
|
|
160
|
+
##
|
|
161
|
+
# Initializes a MetadataStore, including allocation of resources.
|
|
162
|
+
#
|
|
163
|
+
# @overload create_metadata_store(request, options = nil)
|
|
164
|
+
# Pass arguments to `create_metadata_store` via a request object, either of type
|
|
165
|
+
# {::Google::Cloud::AIPlatform::V1::CreateMetadataStoreRequest} or an equivalent Hash.
|
|
166
|
+
#
|
|
167
|
+
# @param request [::Google::Cloud::AIPlatform::V1::CreateMetadataStoreRequest, ::Hash]
|
|
168
|
+
# A request object representing the call parameters. Required. To specify no
|
|
169
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
170
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
171
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
172
|
+
#
|
|
173
|
+
# @overload create_metadata_store(parent: nil, metadata_store: nil, metadata_store_id: nil)
|
|
174
|
+
# Pass arguments to `create_metadata_store` via keyword arguments. Note that at
|
|
175
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
176
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
177
|
+
#
|
|
178
|
+
# @param parent [::String]
|
|
179
|
+
# Required. The resource name of the Location where the MetadataStore should
|
|
180
|
+
# be created.
|
|
181
|
+
# Format: `projects/{project}/locations/{location}/`
|
|
182
|
+
# @param metadata_store [::Google::Cloud::AIPlatform::V1::MetadataStore, ::Hash]
|
|
183
|
+
# Required. The MetadataStore to create.
|
|
184
|
+
# @param metadata_store_id [::String]
|
|
185
|
+
# The \\{metadatastore} portion of the resource name with the format:
|
|
186
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
|
187
|
+
# If not provided, the MetadataStore's ID will be a UUID generated by the
|
|
188
|
+
# service.
|
|
189
|
+
# Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
|
|
190
|
+
# Must be unique across all MetadataStores in the parent Location.
|
|
191
|
+
# (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
|
|
192
|
+
# if the caller can't view the preexisting MetadataStore.)
|
|
193
|
+
#
|
|
194
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
195
|
+
# @yieldparam response [::Gapic::Operation]
|
|
196
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
197
|
+
#
|
|
198
|
+
# @return [::Gapic::Operation]
|
|
199
|
+
#
|
|
200
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
201
|
+
#
|
|
202
|
+
# @example Basic example
|
|
203
|
+
# require "google/cloud/ai_platform/v1"
|
|
204
|
+
#
|
|
205
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
206
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
207
|
+
#
|
|
208
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
209
|
+
# request = Google::Cloud::AIPlatform::V1::CreateMetadataStoreRequest.new
|
|
210
|
+
#
|
|
211
|
+
# # Call the create_metadata_store method.
|
|
212
|
+
# result = client.create_metadata_store request
|
|
213
|
+
#
|
|
214
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
|
215
|
+
# # object to check the status of an operation, cancel it, or wait
|
|
216
|
+
# # for results. Here is how to block until completion:
|
|
217
|
+
# result.wait_until_done! timeout: 60
|
|
218
|
+
# if result.response?
|
|
219
|
+
# p result.response
|
|
220
|
+
# else
|
|
221
|
+
# puts "Error!"
|
|
222
|
+
# end
|
|
223
|
+
#
|
|
224
|
+
def create_metadata_store request, options = nil
|
|
225
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
226
|
+
|
|
227
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateMetadataStoreRequest
|
|
228
|
+
|
|
229
|
+
# Converts hash and nil to an options object
|
|
230
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
231
|
+
|
|
232
|
+
# Customize the options with defaults
|
|
233
|
+
metadata = @config.rpcs.create_metadata_store.metadata.to_h
|
|
234
|
+
|
|
235
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
236
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
237
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
238
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
239
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
240
|
+
|
|
241
|
+
header_params = {}
|
|
242
|
+
if request.parent
|
|
243
|
+
header_params["parent"] = request.parent
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
247
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
248
|
+
|
|
249
|
+
options.apply_defaults timeout: @config.rpcs.create_metadata_store.timeout,
|
|
250
|
+
metadata: metadata,
|
|
251
|
+
retry_policy: @config.rpcs.create_metadata_store.retry_policy
|
|
252
|
+
|
|
253
|
+
options.apply_defaults timeout: @config.timeout,
|
|
254
|
+
metadata: @config.metadata,
|
|
255
|
+
retry_policy: @config.retry_policy
|
|
256
|
+
|
|
257
|
+
@metadata_service_stub.call_rpc :create_metadata_store, request, options: options do |response, operation|
|
|
258
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
|
259
|
+
yield response, operation if block_given?
|
|
260
|
+
return response
|
|
261
|
+
end
|
|
262
|
+
rescue ::GRPC::BadStatus => e
|
|
263
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
264
|
+
end
|
|
265
|
+
|
|
266
|
+
##
|
|
267
|
+
# Retrieves a specific MetadataStore.
|
|
268
|
+
#
|
|
269
|
+
# @overload get_metadata_store(request, options = nil)
|
|
270
|
+
# Pass arguments to `get_metadata_store` via a request object, either of type
|
|
271
|
+
# {::Google::Cloud::AIPlatform::V1::GetMetadataStoreRequest} or an equivalent Hash.
|
|
272
|
+
#
|
|
273
|
+
# @param request [::Google::Cloud::AIPlatform::V1::GetMetadataStoreRequest, ::Hash]
|
|
274
|
+
# A request object representing the call parameters. Required. To specify no
|
|
275
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
276
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
277
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
278
|
+
#
|
|
279
|
+
# @overload get_metadata_store(name: nil)
|
|
280
|
+
# Pass arguments to `get_metadata_store` via keyword arguments. Note that at
|
|
281
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
282
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
283
|
+
#
|
|
284
|
+
# @param name [::String]
|
|
285
|
+
# Required. The resource name of the MetadataStore to retrieve.
|
|
286
|
+
# Format:
|
|
287
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
|
288
|
+
#
|
|
289
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
290
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::MetadataStore]
|
|
291
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
292
|
+
#
|
|
293
|
+
# @return [::Google::Cloud::AIPlatform::V1::MetadataStore]
|
|
294
|
+
#
|
|
295
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
296
|
+
#
|
|
297
|
+
# @example Basic example
|
|
298
|
+
# require "google/cloud/ai_platform/v1"
|
|
299
|
+
#
|
|
300
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
301
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
302
|
+
#
|
|
303
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
304
|
+
# request = Google::Cloud::AIPlatform::V1::GetMetadataStoreRequest.new
|
|
305
|
+
#
|
|
306
|
+
# # Call the get_metadata_store method.
|
|
307
|
+
# result = client.get_metadata_store request
|
|
308
|
+
#
|
|
309
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::MetadataStore.
|
|
310
|
+
# p result
|
|
311
|
+
#
|
|
312
|
+
def get_metadata_store request, options = nil
|
|
313
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
314
|
+
|
|
315
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetMetadataStoreRequest
|
|
316
|
+
|
|
317
|
+
# Converts hash and nil to an options object
|
|
318
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
319
|
+
|
|
320
|
+
# Customize the options with defaults
|
|
321
|
+
metadata = @config.rpcs.get_metadata_store.metadata.to_h
|
|
322
|
+
|
|
323
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
324
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
325
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
326
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
327
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
328
|
+
|
|
329
|
+
header_params = {}
|
|
330
|
+
if request.name
|
|
331
|
+
header_params["name"] = request.name
|
|
332
|
+
end
|
|
333
|
+
|
|
334
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
335
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
336
|
+
|
|
337
|
+
options.apply_defaults timeout: @config.rpcs.get_metadata_store.timeout,
|
|
338
|
+
metadata: metadata,
|
|
339
|
+
retry_policy: @config.rpcs.get_metadata_store.retry_policy
|
|
340
|
+
|
|
341
|
+
options.apply_defaults timeout: @config.timeout,
|
|
342
|
+
metadata: @config.metadata,
|
|
343
|
+
retry_policy: @config.retry_policy
|
|
344
|
+
|
|
345
|
+
@metadata_service_stub.call_rpc :get_metadata_store, request, options: options do |response, operation|
|
|
346
|
+
yield response, operation if block_given?
|
|
347
|
+
return response
|
|
348
|
+
end
|
|
349
|
+
rescue ::GRPC::BadStatus => e
|
|
350
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
351
|
+
end
|
|
352
|
+
|
|
353
|
+
##
|
|
354
|
+
# Lists MetadataStores for a Location.
|
|
355
|
+
#
|
|
356
|
+
# @overload list_metadata_stores(request, options = nil)
|
|
357
|
+
# Pass arguments to `list_metadata_stores` via a request object, either of type
|
|
358
|
+
# {::Google::Cloud::AIPlatform::V1::ListMetadataStoresRequest} or an equivalent Hash.
|
|
359
|
+
#
|
|
360
|
+
# @param request [::Google::Cloud::AIPlatform::V1::ListMetadataStoresRequest, ::Hash]
|
|
361
|
+
# A request object representing the call parameters. Required. To specify no
|
|
362
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
363
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
364
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
365
|
+
#
|
|
366
|
+
# @overload list_metadata_stores(parent: nil, page_size: nil, page_token: nil)
|
|
367
|
+
# Pass arguments to `list_metadata_stores` via keyword arguments. Note that at
|
|
368
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
369
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
370
|
+
#
|
|
371
|
+
# @param parent [::String]
|
|
372
|
+
# Required. The Location whose MetadataStores should be listed.
|
|
373
|
+
# Format:
|
|
374
|
+
# `projects/{project}/locations/{location}`
|
|
375
|
+
# @param page_size [::Integer]
|
|
376
|
+
# The maximum number of Metadata Stores to return. The service may return
|
|
377
|
+
# fewer.
|
|
378
|
+
# Must be in range 1-1000, inclusive. Defaults to 100.
|
|
379
|
+
# @param page_token [::String]
|
|
380
|
+
# A page token, received from a previous
|
|
381
|
+
# {::Google::Cloud::AIPlatform::V1::MetadataService::Client#list_metadata_stores MetadataService.ListMetadataStores} call. Provide this to retrieve the
|
|
382
|
+
# subsequent page.
|
|
383
|
+
#
|
|
384
|
+
# When paginating, all other provided parameters must match the call that
|
|
385
|
+
# provided the page token. (Otherwise the request will fail with
|
|
386
|
+
# INVALID_ARGUMENT error.)
|
|
387
|
+
#
|
|
388
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
389
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::MetadataStore>]
|
|
390
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
391
|
+
#
|
|
392
|
+
# @return [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::MetadataStore>]
|
|
393
|
+
#
|
|
394
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
395
|
+
#
|
|
396
|
+
# @example Basic example
|
|
397
|
+
# require "google/cloud/ai_platform/v1"
|
|
398
|
+
#
|
|
399
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
400
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
401
|
+
#
|
|
402
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
403
|
+
# request = Google::Cloud::AIPlatform::V1::ListMetadataStoresRequest.new
|
|
404
|
+
#
|
|
405
|
+
# # Call the list_metadata_stores method.
|
|
406
|
+
# result = client.list_metadata_stores request
|
|
407
|
+
#
|
|
408
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
|
409
|
+
# # iterate over all elements by calling #each, and the enumerable
|
|
410
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
|
411
|
+
# # methods are also available for managing paging directly.
|
|
412
|
+
# result.each do |response|
|
|
413
|
+
# # Each element is of type ::Google::Cloud::AIPlatform::V1::MetadataStore.
|
|
414
|
+
# p response
|
|
415
|
+
# end
|
|
416
|
+
#
|
|
417
|
+
def list_metadata_stores request, options = nil
|
|
418
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
419
|
+
|
|
420
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListMetadataStoresRequest
|
|
421
|
+
|
|
422
|
+
# Converts hash and nil to an options object
|
|
423
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
424
|
+
|
|
425
|
+
# Customize the options with defaults
|
|
426
|
+
metadata = @config.rpcs.list_metadata_stores.metadata.to_h
|
|
427
|
+
|
|
428
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
429
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
430
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
431
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
432
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
433
|
+
|
|
434
|
+
header_params = {}
|
|
435
|
+
if request.parent
|
|
436
|
+
header_params["parent"] = request.parent
|
|
437
|
+
end
|
|
438
|
+
|
|
439
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
440
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
441
|
+
|
|
442
|
+
options.apply_defaults timeout: @config.rpcs.list_metadata_stores.timeout,
|
|
443
|
+
metadata: metadata,
|
|
444
|
+
retry_policy: @config.rpcs.list_metadata_stores.retry_policy
|
|
445
|
+
|
|
446
|
+
options.apply_defaults timeout: @config.timeout,
|
|
447
|
+
metadata: @config.metadata,
|
|
448
|
+
retry_policy: @config.retry_policy
|
|
449
|
+
|
|
450
|
+
@metadata_service_stub.call_rpc :list_metadata_stores, request, options: options do |response, operation|
|
|
451
|
+
response = ::Gapic::PagedEnumerable.new @metadata_service_stub, :list_metadata_stores, request, response, operation, options
|
|
452
|
+
yield response, operation if block_given?
|
|
453
|
+
return response
|
|
454
|
+
end
|
|
455
|
+
rescue ::GRPC::BadStatus => e
|
|
456
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
457
|
+
end
|
|
458
|
+
|
|
459
|
+
##
|
|
460
|
+
# Deletes a single MetadataStore and all its child resources (Artifacts,
|
|
461
|
+
# Executions, and Contexts).
|
|
462
|
+
#
|
|
463
|
+
# @overload delete_metadata_store(request, options = nil)
|
|
464
|
+
# Pass arguments to `delete_metadata_store` via a request object, either of type
|
|
465
|
+
# {::Google::Cloud::AIPlatform::V1::DeleteMetadataStoreRequest} or an equivalent Hash.
|
|
466
|
+
#
|
|
467
|
+
# @param request [::Google::Cloud::AIPlatform::V1::DeleteMetadataStoreRequest, ::Hash]
|
|
468
|
+
# A request object representing the call parameters. Required. To specify no
|
|
469
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
470
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
471
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
472
|
+
#
|
|
473
|
+
# @overload delete_metadata_store(name: nil, force: nil)
|
|
474
|
+
# Pass arguments to `delete_metadata_store` via keyword arguments. Note that at
|
|
475
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
476
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
477
|
+
#
|
|
478
|
+
# @param name [::String]
|
|
479
|
+
# Required. The resource name of the MetadataStore to delete.
|
|
480
|
+
# Format:
|
|
481
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
|
482
|
+
# @param force [::Boolean]
|
|
483
|
+
# Deprecated: Field is no longer supported.
|
|
484
|
+
#
|
|
485
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
486
|
+
# @yieldparam response [::Gapic::Operation]
|
|
487
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
488
|
+
#
|
|
489
|
+
# @return [::Gapic::Operation]
|
|
490
|
+
#
|
|
491
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
492
|
+
#
|
|
493
|
+
# @example Basic example
|
|
494
|
+
# require "google/cloud/ai_platform/v1"
|
|
495
|
+
#
|
|
496
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
497
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
498
|
+
#
|
|
499
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
500
|
+
# request = Google::Cloud::AIPlatform::V1::DeleteMetadataStoreRequest.new
|
|
501
|
+
#
|
|
502
|
+
# # Call the delete_metadata_store method.
|
|
503
|
+
# result = client.delete_metadata_store request
|
|
504
|
+
#
|
|
505
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
|
506
|
+
# # object to check the status of an operation, cancel it, or wait
|
|
507
|
+
# # for results. Here is how to block until completion:
|
|
508
|
+
# result.wait_until_done! timeout: 60
|
|
509
|
+
# if result.response?
|
|
510
|
+
# p result.response
|
|
511
|
+
# else
|
|
512
|
+
# puts "Error!"
|
|
513
|
+
# end
|
|
514
|
+
#
|
|
515
|
+
def delete_metadata_store request, options = nil
|
|
516
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
517
|
+
|
|
518
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteMetadataStoreRequest
|
|
519
|
+
|
|
520
|
+
# Converts hash and nil to an options object
|
|
521
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
522
|
+
|
|
523
|
+
# Customize the options with defaults
|
|
524
|
+
metadata = @config.rpcs.delete_metadata_store.metadata.to_h
|
|
525
|
+
|
|
526
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
527
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
528
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
529
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
530
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
531
|
+
|
|
532
|
+
header_params = {}
|
|
533
|
+
if request.name
|
|
534
|
+
header_params["name"] = request.name
|
|
535
|
+
end
|
|
536
|
+
|
|
537
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
538
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
539
|
+
|
|
540
|
+
options.apply_defaults timeout: @config.rpcs.delete_metadata_store.timeout,
|
|
541
|
+
metadata: metadata,
|
|
542
|
+
retry_policy: @config.rpcs.delete_metadata_store.retry_policy
|
|
543
|
+
|
|
544
|
+
options.apply_defaults timeout: @config.timeout,
|
|
545
|
+
metadata: @config.metadata,
|
|
546
|
+
retry_policy: @config.retry_policy
|
|
547
|
+
|
|
548
|
+
@metadata_service_stub.call_rpc :delete_metadata_store, request, options: options do |response, operation|
|
|
549
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
|
550
|
+
yield response, operation if block_given?
|
|
551
|
+
return response
|
|
552
|
+
end
|
|
553
|
+
rescue ::GRPC::BadStatus => e
|
|
554
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
555
|
+
end
|
|
556
|
+
|
|
557
|
+
##
|
|
558
|
+
# Creates an Artifact associated with a MetadataStore.
|
|
559
|
+
#
|
|
560
|
+
# @overload create_artifact(request, options = nil)
|
|
561
|
+
# Pass arguments to `create_artifact` via a request object, either of type
|
|
562
|
+
# {::Google::Cloud::AIPlatform::V1::CreateArtifactRequest} or an equivalent Hash.
|
|
563
|
+
#
|
|
564
|
+
# @param request [::Google::Cloud::AIPlatform::V1::CreateArtifactRequest, ::Hash]
|
|
565
|
+
# A request object representing the call parameters. Required. To specify no
|
|
566
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
567
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
568
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
569
|
+
#
|
|
570
|
+
# @overload create_artifact(parent: nil, artifact: nil, artifact_id: nil)
|
|
571
|
+
# Pass arguments to `create_artifact` via keyword arguments. Note that at
|
|
572
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
573
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
574
|
+
#
|
|
575
|
+
# @param parent [::String]
|
|
576
|
+
# Required. The resource name of the MetadataStore where the Artifact should
|
|
577
|
+
# be created.
|
|
578
|
+
# Format:
|
|
579
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
|
580
|
+
# @param artifact [::Google::Cloud::AIPlatform::V1::Artifact, ::Hash]
|
|
581
|
+
# Required. The Artifact to create.
|
|
582
|
+
# @param artifact_id [::String]
|
|
583
|
+
# The \\{artifact} portion of the resource name with the format:
|
|
584
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
|
|
585
|
+
# If not provided, the Artifact's ID will be a UUID generated by the service.
|
|
586
|
+
# Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
|
|
587
|
+
# Must be unique across all Artifacts in the parent MetadataStore. (Otherwise
|
|
588
|
+
# the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the
|
|
589
|
+
# caller can't view the preexisting Artifact.)
|
|
590
|
+
#
|
|
591
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
592
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::Artifact]
|
|
593
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
594
|
+
#
|
|
595
|
+
# @return [::Google::Cloud::AIPlatform::V1::Artifact]
|
|
596
|
+
#
|
|
597
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
598
|
+
#
|
|
599
|
+
# @example Basic example
|
|
600
|
+
# require "google/cloud/ai_platform/v1"
|
|
601
|
+
#
|
|
602
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
603
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
604
|
+
#
|
|
605
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
606
|
+
# request = Google::Cloud::AIPlatform::V1::CreateArtifactRequest.new
|
|
607
|
+
#
|
|
608
|
+
# # Call the create_artifact method.
|
|
609
|
+
# result = client.create_artifact request
|
|
610
|
+
#
|
|
611
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::Artifact.
|
|
612
|
+
# p result
|
|
613
|
+
#
|
|
614
|
+
def create_artifact request, options = nil
|
|
615
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
616
|
+
|
|
617
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateArtifactRequest
|
|
618
|
+
|
|
619
|
+
# Converts hash and nil to an options object
|
|
620
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
621
|
+
|
|
622
|
+
# Customize the options with defaults
|
|
623
|
+
metadata = @config.rpcs.create_artifact.metadata.to_h
|
|
624
|
+
|
|
625
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
626
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
627
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
628
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
629
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
630
|
+
|
|
631
|
+
header_params = {}
|
|
632
|
+
if request.parent
|
|
633
|
+
header_params["parent"] = request.parent
|
|
634
|
+
end
|
|
635
|
+
|
|
636
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
637
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
638
|
+
|
|
639
|
+
options.apply_defaults timeout: @config.rpcs.create_artifact.timeout,
|
|
640
|
+
metadata: metadata,
|
|
641
|
+
retry_policy: @config.rpcs.create_artifact.retry_policy
|
|
642
|
+
|
|
643
|
+
options.apply_defaults timeout: @config.timeout,
|
|
644
|
+
metadata: @config.metadata,
|
|
645
|
+
retry_policy: @config.retry_policy
|
|
646
|
+
|
|
647
|
+
@metadata_service_stub.call_rpc :create_artifact, request, options: options do |response, operation|
|
|
648
|
+
yield response, operation if block_given?
|
|
649
|
+
return response
|
|
650
|
+
end
|
|
651
|
+
rescue ::GRPC::BadStatus => e
|
|
652
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
653
|
+
end
|
|
654
|
+
|
|
655
|
+
##
|
|
656
|
+
# Retrieves a specific Artifact.
|
|
657
|
+
#
|
|
658
|
+
# @overload get_artifact(request, options = nil)
|
|
659
|
+
# Pass arguments to `get_artifact` via a request object, either of type
|
|
660
|
+
# {::Google::Cloud::AIPlatform::V1::GetArtifactRequest} or an equivalent Hash.
|
|
661
|
+
#
|
|
662
|
+
# @param request [::Google::Cloud::AIPlatform::V1::GetArtifactRequest, ::Hash]
|
|
663
|
+
# A request object representing the call parameters. Required. To specify no
|
|
664
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
665
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
666
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
667
|
+
#
|
|
668
|
+
# @overload get_artifact(name: nil)
|
|
669
|
+
# Pass arguments to `get_artifact` via keyword arguments. Note that at
|
|
670
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
671
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
672
|
+
#
|
|
673
|
+
# @param name [::String]
|
|
674
|
+
# Required. The resource name of the Artifact to retrieve.
|
|
675
|
+
# Format:
|
|
676
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
|
|
677
|
+
#
|
|
678
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
679
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::Artifact]
|
|
680
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
681
|
+
#
|
|
682
|
+
# @return [::Google::Cloud::AIPlatform::V1::Artifact]
|
|
683
|
+
#
|
|
684
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
685
|
+
#
|
|
686
|
+
# @example Basic example
|
|
687
|
+
# require "google/cloud/ai_platform/v1"
|
|
688
|
+
#
|
|
689
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
690
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
691
|
+
#
|
|
692
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
693
|
+
# request = Google::Cloud::AIPlatform::V1::GetArtifactRequest.new
|
|
694
|
+
#
|
|
695
|
+
# # Call the get_artifact method.
|
|
696
|
+
# result = client.get_artifact request
|
|
697
|
+
#
|
|
698
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::Artifact.
|
|
699
|
+
# p result
|
|
700
|
+
#
|
|
701
|
+
def get_artifact request, options = nil
|
|
702
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
703
|
+
|
|
704
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetArtifactRequest
|
|
705
|
+
|
|
706
|
+
# Converts hash and nil to an options object
|
|
707
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
708
|
+
|
|
709
|
+
# Customize the options with defaults
|
|
710
|
+
metadata = @config.rpcs.get_artifact.metadata.to_h
|
|
711
|
+
|
|
712
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
713
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
714
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
715
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
716
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
717
|
+
|
|
718
|
+
header_params = {}
|
|
719
|
+
if request.name
|
|
720
|
+
header_params["name"] = request.name
|
|
721
|
+
end
|
|
722
|
+
|
|
723
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
724
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
725
|
+
|
|
726
|
+
options.apply_defaults timeout: @config.rpcs.get_artifact.timeout,
|
|
727
|
+
metadata: metadata,
|
|
728
|
+
retry_policy: @config.rpcs.get_artifact.retry_policy
|
|
729
|
+
|
|
730
|
+
options.apply_defaults timeout: @config.timeout,
|
|
731
|
+
metadata: @config.metadata,
|
|
732
|
+
retry_policy: @config.retry_policy
|
|
733
|
+
|
|
734
|
+
@metadata_service_stub.call_rpc :get_artifact, request, options: options do |response, operation|
|
|
735
|
+
yield response, operation if block_given?
|
|
736
|
+
return response
|
|
737
|
+
end
|
|
738
|
+
rescue ::GRPC::BadStatus => e
|
|
739
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
740
|
+
end
|
|
741
|
+
|
|
742
|
+
##
|
|
743
|
+
# Lists Artifacts in the MetadataStore.
|
|
744
|
+
#
|
|
745
|
+
# @overload list_artifacts(request, options = nil)
|
|
746
|
+
# Pass arguments to `list_artifacts` via a request object, either of type
|
|
747
|
+
# {::Google::Cloud::AIPlatform::V1::ListArtifactsRequest} or an equivalent Hash.
|
|
748
|
+
#
|
|
749
|
+
# @param request [::Google::Cloud::AIPlatform::V1::ListArtifactsRequest, ::Hash]
|
|
750
|
+
# A request object representing the call parameters. Required. To specify no
|
|
751
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
752
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
753
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
754
|
+
#
|
|
755
|
+
# @overload list_artifacts(parent: nil, page_size: nil, page_token: nil, filter: nil)
|
|
756
|
+
# Pass arguments to `list_artifacts` via keyword arguments. Note that at
|
|
757
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
758
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
759
|
+
#
|
|
760
|
+
# @param parent [::String]
|
|
761
|
+
# Required. The MetadataStore whose Artifacts should be listed.
|
|
762
|
+
# Format:
|
|
763
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
|
764
|
+
# @param page_size [::Integer]
|
|
765
|
+
# The maximum number of Artifacts to return. The service may return fewer.
|
|
766
|
+
# Must be in range 1-1000, inclusive. Defaults to 100.
|
|
767
|
+
# @param page_token [::String]
|
|
768
|
+
# A page token, received from a previous {::Google::Cloud::AIPlatform::V1::MetadataService::Client#list_artifacts MetadataService.ListArtifacts}
|
|
769
|
+
# call. Provide this to retrieve the subsequent page.
|
|
770
|
+
#
|
|
771
|
+
# When paginating, all other provided parameters must match the call that
|
|
772
|
+
# provided the page token. (Otherwise the request will fail with
|
|
773
|
+
# INVALID_ARGUMENT error.)
|
|
774
|
+
# @param filter [::String]
|
|
775
|
+
# Filter specifying the boolean condition for the Artifacts to satisfy in
|
|
776
|
+
# order to be part of the result set.
|
|
777
|
+
# The syntax to define filter query is based on https://google.aip.dev/160.
|
|
778
|
+
# The supported set of filters include the following:
|
|
779
|
+
#
|
|
780
|
+
# * **Attribute filtering**:
|
|
781
|
+
# For example: `display_name = "test"`.
|
|
782
|
+
# Supported fields include: `name`, `display_name`, `uri`, `state`,
|
|
783
|
+
# `schema_title`, `create_time`, and `update_time`.
|
|
784
|
+
# Time fields, such as `create_time` and `update_time`, require values
|
|
785
|
+
# specified in RFC-3339 format.
|
|
786
|
+
# For example: `create_time = "2020-11-19T11:30:00-04:00"`
|
|
787
|
+
# * **Metadata field**:
|
|
788
|
+
# To filter on metadata fields use traversal operation as follows:
|
|
789
|
+
# `metadata.<field_name>.<type_value>`.
|
|
790
|
+
# For example: `metadata.field_1.number_value = 10.0`
|
|
791
|
+
# * **Context based filtering**:
|
|
792
|
+
# To filter Artifacts based on the contexts to which they belong, use the
|
|
793
|
+
# function operator with the full resource name
|
|
794
|
+
# `in_context(<context-name>)`.
|
|
795
|
+
# For example:
|
|
796
|
+
# `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")`
|
|
797
|
+
#
|
|
798
|
+
# Each of the above supported filter types can be combined together using
|
|
799
|
+
# logical operators (`AND` & `OR`).
|
|
800
|
+
#
|
|
801
|
+
# For example: `display_name = "test" AND metadata.field1.bool_value = true`.
|
|
802
|
+
#
|
|
803
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
804
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Artifact>]
|
|
805
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
806
|
+
#
|
|
807
|
+
# @return [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Artifact>]
|
|
808
|
+
#
|
|
809
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
810
|
+
#
|
|
811
|
+
# @example Basic example
|
|
812
|
+
# require "google/cloud/ai_platform/v1"
|
|
813
|
+
#
|
|
814
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
815
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
816
|
+
#
|
|
817
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
818
|
+
# request = Google::Cloud::AIPlatform::V1::ListArtifactsRequest.new
|
|
819
|
+
#
|
|
820
|
+
# # Call the list_artifacts method.
|
|
821
|
+
# result = client.list_artifacts request
|
|
822
|
+
#
|
|
823
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
|
824
|
+
# # iterate over all elements by calling #each, and the enumerable
|
|
825
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
|
826
|
+
# # methods are also available for managing paging directly.
|
|
827
|
+
# result.each do |response|
|
|
828
|
+
# # Each element is of type ::Google::Cloud::AIPlatform::V1::Artifact.
|
|
829
|
+
# p response
|
|
830
|
+
# end
|
|
831
|
+
#
|
|
832
|
+
def list_artifacts request, options = nil
|
|
833
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
834
|
+
|
|
835
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListArtifactsRequest
|
|
836
|
+
|
|
837
|
+
# Converts hash and nil to an options object
|
|
838
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
839
|
+
|
|
840
|
+
# Customize the options with defaults
|
|
841
|
+
metadata = @config.rpcs.list_artifacts.metadata.to_h
|
|
842
|
+
|
|
843
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
844
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
845
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
846
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
847
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
848
|
+
|
|
849
|
+
header_params = {}
|
|
850
|
+
if request.parent
|
|
851
|
+
header_params["parent"] = request.parent
|
|
852
|
+
end
|
|
853
|
+
|
|
854
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
855
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
856
|
+
|
|
857
|
+
options.apply_defaults timeout: @config.rpcs.list_artifacts.timeout,
|
|
858
|
+
metadata: metadata,
|
|
859
|
+
retry_policy: @config.rpcs.list_artifacts.retry_policy
|
|
860
|
+
|
|
861
|
+
options.apply_defaults timeout: @config.timeout,
|
|
862
|
+
metadata: @config.metadata,
|
|
863
|
+
retry_policy: @config.retry_policy
|
|
864
|
+
|
|
865
|
+
@metadata_service_stub.call_rpc :list_artifacts, request, options: options do |response, operation|
|
|
866
|
+
response = ::Gapic::PagedEnumerable.new @metadata_service_stub, :list_artifacts, request, response, operation, options
|
|
867
|
+
yield response, operation if block_given?
|
|
868
|
+
return response
|
|
869
|
+
end
|
|
870
|
+
rescue ::GRPC::BadStatus => e
|
|
871
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
872
|
+
end
|
|
873
|
+
|
|
874
|
+
##
|
|
875
|
+
# Updates a stored Artifact.
|
|
876
|
+
#
|
|
877
|
+
# @overload update_artifact(request, options = nil)
|
|
878
|
+
# Pass arguments to `update_artifact` via a request object, either of type
|
|
879
|
+
# {::Google::Cloud::AIPlatform::V1::UpdateArtifactRequest} or an equivalent Hash.
|
|
880
|
+
#
|
|
881
|
+
# @param request [::Google::Cloud::AIPlatform::V1::UpdateArtifactRequest, ::Hash]
|
|
882
|
+
# A request object representing the call parameters. Required. To specify no
|
|
883
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
884
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
885
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
886
|
+
#
|
|
887
|
+
# @overload update_artifact(artifact: nil, update_mask: nil, allow_missing: nil)
|
|
888
|
+
# Pass arguments to `update_artifact` via keyword arguments. Note that at
|
|
889
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
890
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
891
|
+
#
|
|
892
|
+
# @param artifact [::Google::Cloud::AIPlatform::V1::Artifact, ::Hash]
|
|
893
|
+
# Required. The Artifact containing updates.
|
|
894
|
+
# The Artifact's {::Google::Cloud::AIPlatform::V1::Artifact#name Artifact.name} field is used to identify the Artifact to
|
|
895
|
+
# be updated.
|
|
896
|
+
# Format:
|
|
897
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
|
|
898
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
899
|
+
# Required. A FieldMask indicating which fields should be updated.
|
|
900
|
+
# Functionality of this field is not yet supported.
|
|
901
|
+
# @param allow_missing [::Boolean]
|
|
902
|
+
# If set to true, and the {::Google::Cloud::AIPlatform::V1::Artifact Artifact} is not found, a new {::Google::Cloud::AIPlatform::V1::Artifact Artifact} is
|
|
903
|
+
# created.
|
|
904
|
+
#
|
|
905
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
906
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::Artifact]
|
|
907
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
908
|
+
#
|
|
909
|
+
# @return [::Google::Cloud::AIPlatform::V1::Artifact]
|
|
910
|
+
#
|
|
911
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
912
|
+
#
|
|
913
|
+
# @example Basic example
|
|
914
|
+
# require "google/cloud/ai_platform/v1"
|
|
915
|
+
#
|
|
916
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
917
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
918
|
+
#
|
|
919
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
920
|
+
# request = Google::Cloud::AIPlatform::V1::UpdateArtifactRequest.new
|
|
921
|
+
#
|
|
922
|
+
# # Call the update_artifact method.
|
|
923
|
+
# result = client.update_artifact request
|
|
924
|
+
#
|
|
925
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::Artifact.
|
|
926
|
+
# p result
|
|
927
|
+
#
|
|
928
|
+
def update_artifact request, options = nil
|
|
929
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
930
|
+
|
|
931
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::UpdateArtifactRequest
|
|
932
|
+
|
|
933
|
+
# Converts hash and nil to an options object
|
|
934
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
935
|
+
|
|
936
|
+
# Customize the options with defaults
|
|
937
|
+
metadata = @config.rpcs.update_artifact.metadata.to_h
|
|
938
|
+
|
|
939
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
940
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
941
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
942
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
943
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
944
|
+
|
|
945
|
+
header_params = {}
|
|
946
|
+
if request.artifact&.name
|
|
947
|
+
header_params["artifact.name"] = request.artifact.name
|
|
948
|
+
end
|
|
949
|
+
|
|
950
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
951
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
952
|
+
|
|
953
|
+
options.apply_defaults timeout: @config.rpcs.update_artifact.timeout,
|
|
954
|
+
metadata: metadata,
|
|
955
|
+
retry_policy: @config.rpcs.update_artifact.retry_policy
|
|
956
|
+
|
|
957
|
+
options.apply_defaults timeout: @config.timeout,
|
|
958
|
+
metadata: @config.metadata,
|
|
959
|
+
retry_policy: @config.retry_policy
|
|
960
|
+
|
|
961
|
+
@metadata_service_stub.call_rpc :update_artifact, request, options: options do |response, operation|
|
|
962
|
+
yield response, operation if block_given?
|
|
963
|
+
return response
|
|
964
|
+
end
|
|
965
|
+
rescue ::GRPC::BadStatus => e
|
|
966
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
967
|
+
end
|
|
968
|
+
|
|
969
|
+
##
|
|
970
|
+
# Deletes an Artifact.
|
|
971
|
+
#
|
|
972
|
+
# @overload delete_artifact(request, options = nil)
|
|
973
|
+
# Pass arguments to `delete_artifact` via a request object, either of type
|
|
974
|
+
# {::Google::Cloud::AIPlatform::V1::DeleteArtifactRequest} or an equivalent Hash.
|
|
975
|
+
#
|
|
976
|
+
# @param request [::Google::Cloud::AIPlatform::V1::DeleteArtifactRequest, ::Hash]
|
|
977
|
+
# A request object representing the call parameters. Required. To specify no
|
|
978
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
979
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
980
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
981
|
+
#
|
|
982
|
+
# @overload delete_artifact(name: nil, etag: nil)
|
|
983
|
+
# Pass arguments to `delete_artifact` via keyword arguments. Note that at
|
|
984
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
985
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
986
|
+
#
|
|
987
|
+
# @param name [::String]
|
|
988
|
+
# Required. The resource name of the Artifact to delete.
|
|
989
|
+
# Format:
|
|
990
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
|
|
991
|
+
# @param etag [::String]
|
|
992
|
+
# Optional. The etag of the Artifact to delete.
|
|
993
|
+
# If this is provided, it must match the server's etag. Otherwise, the
|
|
994
|
+
# request will fail with a FAILED_PRECONDITION.
|
|
995
|
+
#
|
|
996
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
997
|
+
# @yieldparam response [::Gapic::Operation]
|
|
998
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
999
|
+
#
|
|
1000
|
+
# @return [::Gapic::Operation]
|
|
1001
|
+
#
|
|
1002
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
1003
|
+
#
|
|
1004
|
+
# @example Basic example
|
|
1005
|
+
# require "google/cloud/ai_platform/v1"
|
|
1006
|
+
#
|
|
1007
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1008
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
1009
|
+
#
|
|
1010
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1011
|
+
# request = Google::Cloud::AIPlatform::V1::DeleteArtifactRequest.new
|
|
1012
|
+
#
|
|
1013
|
+
# # Call the delete_artifact method.
|
|
1014
|
+
# result = client.delete_artifact request
|
|
1015
|
+
#
|
|
1016
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
|
1017
|
+
# # object to check the status of an operation, cancel it, or wait
|
|
1018
|
+
# # for results. Here is how to block until completion:
|
|
1019
|
+
# result.wait_until_done! timeout: 60
|
|
1020
|
+
# if result.response?
|
|
1021
|
+
# p result.response
|
|
1022
|
+
# else
|
|
1023
|
+
# puts "Error!"
|
|
1024
|
+
# end
|
|
1025
|
+
#
|
|
1026
|
+
def delete_artifact request, options = nil
|
|
1027
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1028
|
+
|
|
1029
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteArtifactRequest
|
|
1030
|
+
|
|
1031
|
+
# Converts hash and nil to an options object
|
|
1032
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
1033
|
+
|
|
1034
|
+
# Customize the options with defaults
|
|
1035
|
+
metadata = @config.rpcs.delete_artifact.metadata.to_h
|
|
1036
|
+
|
|
1037
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
1038
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
1039
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
1040
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
1041
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
1042
|
+
|
|
1043
|
+
header_params = {}
|
|
1044
|
+
if request.name
|
|
1045
|
+
header_params["name"] = request.name
|
|
1046
|
+
end
|
|
1047
|
+
|
|
1048
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
1049
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
1050
|
+
|
|
1051
|
+
options.apply_defaults timeout: @config.rpcs.delete_artifact.timeout,
|
|
1052
|
+
metadata: metadata,
|
|
1053
|
+
retry_policy: @config.rpcs.delete_artifact.retry_policy
|
|
1054
|
+
|
|
1055
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1056
|
+
metadata: @config.metadata,
|
|
1057
|
+
retry_policy: @config.retry_policy
|
|
1058
|
+
|
|
1059
|
+
@metadata_service_stub.call_rpc :delete_artifact, request, options: options do |response, operation|
|
|
1060
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
|
1061
|
+
yield response, operation if block_given?
|
|
1062
|
+
return response
|
|
1063
|
+
end
|
|
1064
|
+
rescue ::GRPC::BadStatus => e
|
|
1065
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
1066
|
+
end
|
|
1067
|
+
|
|
1068
|
+
##
|
|
1069
|
+
# Purges Artifacts.
|
|
1070
|
+
#
|
|
1071
|
+
# @overload purge_artifacts(request, options = nil)
|
|
1072
|
+
# Pass arguments to `purge_artifacts` via a request object, either of type
|
|
1073
|
+
# {::Google::Cloud::AIPlatform::V1::PurgeArtifactsRequest} or an equivalent Hash.
|
|
1074
|
+
#
|
|
1075
|
+
# @param request [::Google::Cloud::AIPlatform::V1::PurgeArtifactsRequest, ::Hash]
|
|
1076
|
+
# A request object representing the call parameters. Required. To specify no
|
|
1077
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
1078
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1079
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1080
|
+
#
|
|
1081
|
+
# @overload purge_artifacts(parent: nil, filter: nil, force: nil)
|
|
1082
|
+
# Pass arguments to `purge_artifacts` via keyword arguments. Note that at
|
|
1083
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1084
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
1085
|
+
#
|
|
1086
|
+
# @param parent [::String]
|
|
1087
|
+
# Required. The metadata store to purge Artifacts from.
|
|
1088
|
+
# Format:
|
|
1089
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
|
1090
|
+
# @param filter [::String]
|
|
1091
|
+
# Required. A required filter matching the Artifacts to be purged.
|
|
1092
|
+
# E.g., `update_time <= 2020-11-19T11:30:00-04:00`.
|
|
1093
|
+
# @param force [::Boolean]
|
|
1094
|
+
# Optional. Flag to indicate to actually perform the purge.
|
|
1095
|
+
# If `force` is set to false, the method will return a sample of
|
|
1096
|
+
# Artifact names that would be deleted.
|
|
1097
|
+
#
|
|
1098
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
1099
|
+
# @yieldparam response [::Gapic::Operation]
|
|
1100
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
1101
|
+
#
|
|
1102
|
+
# @return [::Gapic::Operation]
|
|
1103
|
+
#
|
|
1104
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
1105
|
+
#
|
|
1106
|
+
# @example Basic example
|
|
1107
|
+
# require "google/cloud/ai_platform/v1"
|
|
1108
|
+
#
|
|
1109
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1110
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
1111
|
+
#
|
|
1112
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1113
|
+
# request = Google::Cloud::AIPlatform::V1::PurgeArtifactsRequest.new
|
|
1114
|
+
#
|
|
1115
|
+
# # Call the purge_artifacts method.
|
|
1116
|
+
# result = client.purge_artifacts request
|
|
1117
|
+
#
|
|
1118
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
|
1119
|
+
# # object to check the status of an operation, cancel it, or wait
|
|
1120
|
+
# # for results. Here is how to block until completion:
|
|
1121
|
+
# result.wait_until_done! timeout: 60
|
|
1122
|
+
# if result.response?
|
|
1123
|
+
# p result.response
|
|
1124
|
+
# else
|
|
1125
|
+
# puts "Error!"
|
|
1126
|
+
# end
|
|
1127
|
+
#
|
|
1128
|
+
def purge_artifacts request, options = nil
|
|
1129
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1130
|
+
|
|
1131
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::PurgeArtifactsRequest
|
|
1132
|
+
|
|
1133
|
+
# Converts hash and nil to an options object
|
|
1134
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
1135
|
+
|
|
1136
|
+
# Customize the options with defaults
|
|
1137
|
+
metadata = @config.rpcs.purge_artifacts.metadata.to_h
|
|
1138
|
+
|
|
1139
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
1140
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
1141
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
1142
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
1143
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
1144
|
+
|
|
1145
|
+
header_params = {}
|
|
1146
|
+
if request.parent
|
|
1147
|
+
header_params["parent"] = request.parent
|
|
1148
|
+
end
|
|
1149
|
+
|
|
1150
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
1151
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
1152
|
+
|
|
1153
|
+
options.apply_defaults timeout: @config.rpcs.purge_artifacts.timeout,
|
|
1154
|
+
metadata: metadata,
|
|
1155
|
+
retry_policy: @config.rpcs.purge_artifacts.retry_policy
|
|
1156
|
+
|
|
1157
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1158
|
+
metadata: @config.metadata,
|
|
1159
|
+
retry_policy: @config.retry_policy
|
|
1160
|
+
|
|
1161
|
+
@metadata_service_stub.call_rpc :purge_artifacts, request, options: options do |response, operation|
|
|
1162
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
|
1163
|
+
yield response, operation if block_given?
|
|
1164
|
+
return response
|
|
1165
|
+
end
|
|
1166
|
+
rescue ::GRPC::BadStatus => e
|
|
1167
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
1168
|
+
end
|
|
1169
|
+
|
|
1170
|
+
##
|
|
1171
|
+
# Creates a Context associated with a MetadataStore.
|
|
1172
|
+
#
|
|
1173
|
+
# @overload create_context(request, options = nil)
|
|
1174
|
+
# Pass arguments to `create_context` via a request object, either of type
|
|
1175
|
+
# {::Google::Cloud::AIPlatform::V1::CreateContextRequest} or an equivalent Hash.
|
|
1176
|
+
#
|
|
1177
|
+
# @param request [::Google::Cloud::AIPlatform::V1::CreateContextRequest, ::Hash]
|
|
1178
|
+
# A request object representing the call parameters. Required. To specify no
|
|
1179
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
1180
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1181
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1182
|
+
#
|
|
1183
|
+
# @overload create_context(parent: nil, context: nil, context_id: nil)
|
|
1184
|
+
# Pass arguments to `create_context` via keyword arguments. Note that at
|
|
1185
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1186
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
1187
|
+
#
|
|
1188
|
+
# @param parent [::String]
|
|
1189
|
+
# Required. The resource name of the MetadataStore where the Context should be
|
|
1190
|
+
# created.
|
|
1191
|
+
# Format:
|
|
1192
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
|
1193
|
+
# @param context [::Google::Cloud::AIPlatform::V1::Context, ::Hash]
|
|
1194
|
+
# Required. The Context to create.
|
|
1195
|
+
# @param context_id [::String]
|
|
1196
|
+
# The \\{context} portion of the resource name with the format:
|
|
1197
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`.
|
|
1198
|
+
# If not provided, the Context's ID will be a UUID generated by the service.
|
|
1199
|
+
# Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
|
|
1200
|
+
# Must be unique across all Contexts in the parent MetadataStore. (Otherwise
|
|
1201
|
+
# the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the
|
|
1202
|
+
# caller can't view the preexisting Context.)
|
|
1203
|
+
#
|
|
1204
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
1205
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::Context]
|
|
1206
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
1207
|
+
#
|
|
1208
|
+
# @return [::Google::Cloud::AIPlatform::V1::Context]
|
|
1209
|
+
#
|
|
1210
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
1211
|
+
#
|
|
1212
|
+
# @example Basic example
|
|
1213
|
+
# require "google/cloud/ai_platform/v1"
|
|
1214
|
+
#
|
|
1215
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1216
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
1217
|
+
#
|
|
1218
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1219
|
+
# request = Google::Cloud::AIPlatform::V1::CreateContextRequest.new
|
|
1220
|
+
#
|
|
1221
|
+
# # Call the create_context method.
|
|
1222
|
+
# result = client.create_context request
|
|
1223
|
+
#
|
|
1224
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::Context.
|
|
1225
|
+
# p result
|
|
1226
|
+
#
|
|
1227
|
+
def create_context request, options = nil
|
|
1228
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1229
|
+
|
|
1230
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateContextRequest
|
|
1231
|
+
|
|
1232
|
+
# Converts hash and nil to an options object
|
|
1233
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
1234
|
+
|
|
1235
|
+
# Customize the options with defaults
|
|
1236
|
+
metadata = @config.rpcs.create_context.metadata.to_h
|
|
1237
|
+
|
|
1238
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
1239
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
1240
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
1241
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
1242
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
1243
|
+
|
|
1244
|
+
header_params = {}
|
|
1245
|
+
if request.parent
|
|
1246
|
+
header_params["parent"] = request.parent
|
|
1247
|
+
end
|
|
1248
|
+
|
|
1249
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
1250
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
1251
|
+
|
|
1252
|
+
options.apply_defaults timeout: @config.rpcs.create_context.timeout,
|
|
1253
|
+
metadata: metadata,
|
|
1254
|
+
retry_policy: @config.rpcs.create_context.retry_policy
|
|
1255
|
+
|
|
1256
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1257
|
+
metadata: @config.metadata,
|
|
1258
|
+
retry_policy: @config.retry_policy
|
|
1259
|
+
|
|
1260
|
+
@metadata_service_stub.call_rpc :create_context, request, options: options do |response, operation|
|
|
1261
|
+
yield response, operation if block_given?
|
|
1262
|
+
return response
|
|
1263
|
+
end
|
|
1264
|
+
rescue ::GRPC::BadStatus => e
|
|
1265
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
1266
|
+
end
|
|
1267
|
+
|
|
1268
|
+
##
|
|
1269
|
+
# Retrieves a specific Context.
|
|
1270
|
+
#
|
|
1271
|
+
# @overload get_context(request, options = nil)
|
|
1272
|
+
# Pass arguments to `get_context` via a request object, either of type
|
|
1273
|
+
# {::Google::Cloud::AIPlatform::V1::GetContextRequest} or an equivalent Hash.
|
|
1274
|
+
#
|
|
1275
|
+
# @param request [::Google::Cloud::AIPlatform::V1::GetContextRequest, ::Hash]
|
|
1276
|
+
# A request object representing the call parameters. Required. To specify no
|
|
1277
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
1278
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1279
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1280
|
+
#
|
|
1281
|
+
# @overload get_context(name: nil)
|
|
1282
|
+
# Pass arguments to `get_context` via keyword arguments. Note that at
|
|
1283
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1284
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
1285
|
+
#
|
|
1286
|
+
# @param name [::String]
|
|
1287
|
+
# Required. The resource name of the Context to retrieve.
|
|
1288
|
+
# Format:
|
|
1289
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
|
|
1290
|
+
#
|
|
1291
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
1292
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::Context]
|
|
1293
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
1294
|
+
#
|
|
1295
|
+
# @return [::Google::Cloud::AIPlatform::V1::Context]
|
|
1296
|
+
#
|
|
1297
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
1298
|
+
#
|
|
1299
|
+
# @example Basic example
|
|
1300
|
+
# require "google/cloud/ai_platform/v1"
|
|
1301
|
+
#
|
|
1302
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1303
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
1304
|
+
#
|
|
1305
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1306
|
+
# request = Google::Cloud::AIPlatform::V1::GetContextRequest.new
|
|
1307
|
+
#
|
|
1308
|
+
# # Call the get_context method.
|
|
1309
|
+
# result = client.get_context request
|
|
1310
|
+
#
|
|
1311
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::Context.
|
|
1312
|
+
# p result
|
|
1313
|
+
#
|
|
1314
|
+
def get_context request, options = nil
|
|
1315
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1316
|
+
|
|
1317
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetContextRequest
|
|
1318
|
+
|
|
1319
|
+
# Converts hash and nil to an options object
|
|
1320
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
1321
|
+
|
|
1322
|
+
# Customize the options with defaults
|
|
1323
|
+
metadata = @config.rpcs.get_context.metadata.to_h
|
|
1324
|
+
|
|
1325
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
1326
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
1327
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
1328
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
1329
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
1330
|
+
|
|
1331
|
+
header_params = {}
|
|
1332
|
+
if request.name
|
|
1333
|
+
header_params["name"] = request.name
|
|
1334
|
+
end
|
|
1335
|
+
|
|
1336
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
1337
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
1338
|
+
|
|
1339
|
+
options.apply_defaults timeout: @config.rpcs.get_context.timeout,
|
|
1340
|
+
metadata: metadata,
|
|
1341
|
+
retry_policy: @config.rpcs.get_context.retry_policy
|
|
1342
|
+
|
|
1343
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1344
|
+
metadata: @config.metadata,
|
|
1345
|
+
retry_policy: @config.retry_policy
|
|
1346
|
+
|
|
1347
|
+
@metadata_service_stub.call_rpc :get_context, request, options: options do |response, operation|
|
|
1348
|
+
yield response, operation if block_given?
|
|
1349
|
+
return response
|
|
1350
|
+
end
|
|
1351
|
+
rescue ::GRPC::BadStatus => e
|
|
1352
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
1353
|
+
end
|
|
1354
|
+
|
|
1355
|
+
##
|
|
1356
|
+
# Lists Contexts on the MetadataStore.
|
|
1357
|
+
#
|
|
1358
|
+
# @overload list_contexts(request, options = nil)
|
|
1359
|
+
# Pass arguments to `list_contexts` via a request object, either of type
|
|
1360
|
+
# {::Google::Cloud::AIPlatform::V1::ListContextsRequest} or an equivalent Hash.
|
|
1361
|
+
#
|
|
1362
|
+
# @param request [::Google::Cloud::AIPlatform::V1::ListContextsRequest, ::Hash]
|
|
1363
|
+
# A request object representing the call parameters. Required. To specify no
|
|
1364
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
1365
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1366
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1367
|
+
#
|
|
1368
|
+
# @overload list_contexts(parent: nil, page_size: nil, page_token: nil, filter: nil)
|
|
1369
|
+
# Pass arguments to `list_contexts` via keyword arguments. Note that at
|
|
1370
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1371
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
1372
|
+
#
|
|
1373
|
+
# @param parent [::String]
|
|
1374
|
+
# Required. The MetadataStore whose Contexts should be listed.
|
|
1375
|
+
# Format:
|
|
1376
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
|
1377
|
+
# @param page_size [::Integer]
|
|
1378
|
+
# The maximum number of Contexts to return. The service may return fewer.
|
|
1379
|
+
# Must be in range 1-1000, inclusive. Defaults to 100.
|
|
1380
|
+
# @param page_token [::String]
|
|
1381
|
+
# A page token, received from a previous {::Google::Cloud::AIPlatform::V1::MetadataService::Client#list_contexts MetadataService.ListContexts}
|
|
1382
|
+
# call. Provide this to retrieve the subsequent page.
|
|
1383
|
+
#
|
|
1384
|
+
# When paginating, all other provided parameters must match the call that
|
|
1385
|
+
# provided the page token. (Otherwise the request will fail with
|
|
1386
|
+
# INVALID_ARGUMENT error.)
|
|
1387
|
+
# @param filter [::String]
|
|
1388
|
+
# Filter specifying the boolean condition for the Contexts to satisfy in
|
|
1389
|
+
# order to be part of the result set.
|
|
1390
|
+
# The syntax to define filter query is based on https://google.aip.dev/160.
|
|
1391
|
+
# Following are the supported set of filters:
|
|
1392
|
+
#
|
|
1393
|
+
# * **Attribute filtering**:
|
|
1394
|
+
# For example: `display_name = "test"`.
|
|
1395
|
+
# Supported fields include: `name`, `display_name`, `schema_title`,
|
|
1396
|
+
# `create_time`, and `update_time`.
|
|
1397
|
+
# Time fields, such as `create_time` and `update_time`, require values
|
|
1398
|
+
# specified in RFC-3339 format.
|
|
1399
|
+
# For example: `create_time = "2020-11-19T11:30:00-04:00"`.
|
|
1400
|
+
# * **Metadata field**:
|
|
1401
|
+
# To filter on metadata fields use traversal operation as follows:
|
|
1402
|
+
# `metadata.<field_name>.<type_value>`.
|
|
1403
|
+
# For example: `metadata.field_1.number_value = 10.0`.
|
|
1404
|
+
# * **Parent Child filtering**:
|
|
1405
|
+
# To filter Contexts based on parent-child relationship use the HAS
|
|
1406
|
+
# operator as follows:
|
|
1407
|
+
#
|
|
1408
|
+
# ```
|
|
1409
|
+
# parent_contexts:
|
|
1410
|
+
# "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"
|
|
1411
|
+
# child_contexts:
|
|
1412
|
+
# "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"
|
|
1413
|
+
# ```
|
|
1414
|
+
#
|
|
1415
|
+
# Each of the above supported filters can be combined together using
|
|
1416
|
+
# logical operators (`AND` & `OR`).
|
|
1417
|
+
#
|
|
1418
|
+
# For example: `display_name = "test" AND metadata.field1.bool_value = true`.
|
|
1419
|
+
#
|
|
1420
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
1421
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Context>]
|
|
1422
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
1423
|
+
#
|
|
1424
|
+
# @return [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Context>]
|
|
1425
|
+
#
|
|
1426
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
1427
|
+
#
|
|
1428
|
+
# @example Basic example
|
|
1429
|
+
# require "google/cloud/ai_platform/v1"
|
|
1430
|
+
#
|
|
1431
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1432
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
1433
|
+
#
|
|
1434
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1435
|
+
# request = Google::Cloud::AIPlatform::V1::ListContextsRequest.new
|
|
1436
|
+
#
|
|
1437
|
+
# # Call the list_contexts method.
|
|
1438
|
+
# result = client.list_contexts request
|
|
1439
|
+
#
|
|
1440
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
|
1441
|
+
# # iterate over all elements by calling #each, and the enumerable
|
|
1442
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
|
1443
|
+
# # methods are also available for managing paging directly.
|
|
1444
|
+
# result.each do |response|
|
|
1445
|
+
# # Each element is of type ::Google::Cloud::AIPlatform::V1::Context.
|
|
1446
|
+
# p response
|
|
1447
|
+
# end
|
|
1448
|
+
#
|
|
1449
|
+
def list_contexts request, options = nil
|
|
1450
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1451
|
+
|
|
1452
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListContextsRequest
|
|
1453
|
+
|
|
1454
|
+
# Converts hash and nil to an options object
|
|
1455
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
1456
|
+
|
|
1457
|
+
# Customize the options with defaults
|
|
1458
|
+
metadata = @config.rpcs.list_contexts.metadata.to_h
|
|
1459
|
+
|
|
1460
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
1461
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
1462
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
1463
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
1464
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
1465
|
+
|
|
1466
|
+
header_params = {}
|
|
1467
|
+
if request.parent
|
|
1468
|
+
header_params["parent"] = request.parent
|
|
1469
|
+
end
|
|
1470
|
+
|
|
1471
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
1472
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
1473
|
+
|
|
1474
|
+
options.apply_defaults timeout: @config.rpcs.list_contexts.timeout,
|
|
1475
|
+
metadata: metadata,
|
|
1476
|
+
retry_policy: @config.rpcs.list_contexts.retry_policy
|
|
1477
|
+
|
|
1478
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1479
|
+
metadata: @config.metadata,
|
|
1480
|
+
retry_policy: @config.retry_policy
|
|
1481
|
+
|
|
1482
|
+
@metadata_service_stub.call_rpc :list_contexts, request, options: options do |response, operation|
|
|
1483
|
+
response = ::Gapic::PagedEnumerable.new @metadata_service_stub, :list_contexts, request, response, operation, options
|
|
1484
|
+
yield response, operation if block_given?
|
|
1485
|
+
return response
|
|
1486
|
+
end
|
|
1487
|
+
rescue ::GRPC::BadStatus => e
|
|
1488
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
1489
|
+
end
|
|
1490
|
+
|
|
1491
|
+
##
|
|
1492
|
+
# Updates a stored Context.
|
|
1493
|
+
#
|
|
1494
|
+
# @overload update_context(request, options = nil)
|
|
1495
|
+
# Pass arguments to `update_context` via a request object, either of type
|
|
1496
|
+
# {::Google::Cloud::AIPlatform::V1::UpdateContextRequest} or an equivalent Hash.
|
|
1497
|
+
#
|
|
1498
|
+
# @param request [::Google::Cloud::AIPlatform::V1::UpdateContextRequest, ::Hash]
|
|
1499
|
+
# A request object representing the call parameters. Required. To specify no
|
|
1500
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
1501
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1502
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1503
|
+
#
|
|
1504
|
+
# @overload update_context(context: nil, update_mask: nil, allow_missing: nil)
|
|
1505
|
+
# Pass arguments to `update_context` via keyword arguments. Note that at
|
|
1506
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1507
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
1508
|
+
#
|
|
1509
|
+
# @param context [::Google::Cloud::AIPlatform::V1::Context, ::Hash]
|
|
1510
|
+
# Required. The Context containing updates.
|
|
1511
|
+
# The Context's {::Google::Cloud::AIPlatform::V1::Context#name Context.name} field is used to identify the Context to be
|
|
1512
|
+
# updated.
|
|
1513
|
+
# Format:
|
|
1514
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
|
|
1515
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
1516
|
+
# Required. A FieldMask indicating which fields should be updated.
|
|
1517
|
+
# Functionality of this field is not yet supported.
|
|
1518
|
+
# @param allow_missing [::Boolean]
|
|
1519
|
+
# If set to true, and the {::Google::Cloud::AIPlatform::V1::Context Context} is not found, a new {::Google::Cloud::AIPlatform::V1::Context Context} is
|
|
1520
|
+
# created.
|
|
1521
|
+
#
|
|
1522
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
1523
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::Context]
|
|
1524
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
1525
|
+
#
|
|
1526
|
+
# @return [::Google::Cloud::AIPlatform::V1::Context]
|
|
1527
|
+
#
|
|
1528
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
1529
|
+
#
|
|
1530
|
+
# @example Basic example
|
|
1531
|
+
# require "google/cloud/ai_platform/v1"
|
|
1532
|
+
#
|
|
1533
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1534
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
1535
|
+
#
|
|
1536
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1537
|
+
# request = Google::Cloud::AIPlatform::V1::UpdateContextRequest.new
|
|
1538
|
+
#
|
|
1539
|
+
# # Call the update_context method.
|
|
1540
|
+
# result = client.update_context request
|
|
1541
|
+
#
|
|
1542
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::Context.
|
|
1543
|
+
# p result
|
|
1544
|
+
#
|
|
1545
|
+
def update_context request, options = nil
|
|
1546
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1547
|
+
|
|
1548
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::UpdateContextRequest
|
|
1549
|
+
|
|
1550
|
+
# Converts hash and nil to an options object
|
|
1551
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
1552
|
+
|
|
1553
|
+
# Customize the options with defaults
|
|
1554
|
+
metadata = @config.rpcs.update_context.metadata.to_h
|
|
1555
|
+
|
|
1556
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
1557
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
1558
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
1559
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
1560
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
1561
|
+
|
|
1562
|
+
header_params = {}
|
|
1563
|
+
if request.context&.name
|
|
1564
|
+
header_params["context.name"] = request.context.name
|
|
1565
|
+
end
|
|
1566
|
+
|
|
1567
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
1568
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
1569
|
+
|
|
1570
|
+
options.apply_defaults timeout: @config.rpcs.update_context.timeout,
|
|
1571
|
+
metadata: metadata,
|
|
1572
|
+
retry_policy: @config.rpcs.update_context.retry_policy
|
|
1573
|
+
|
|
1574
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1575
|
+
metadata: @config.metadata,
|
|
1576
|
+
retry_policy: @config.retry_policy
|
|
1577
|
+
|
|
1578
|
+
@metadata_service_stub.call_rpc :update_context, request, options: options do |response, operation|
|
|
1579
|
+
yield response, operation if block_given?
|
|
1580
|
+
return response
|
|
1581
|
+
end
|
|
1582
|
+
rescue ::GRPC::BadStatus => e
|
|
1583
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
1584
|
+
end
|
|
1585
|
+
|
|
1586
|
+
##
|
|
1587
|
+
# Deletes a stored Context.
|
|
1588
|
+
#
|
|
1589
|
+
# @overload delete_context(request, options = nil)
|
|
1590
|
+
# Pass arguments to `delete_context` via a request object, either of type
|
|
1591
|
+
# {::Google::Cloud::AIPlatform::V1::DeleteContextRequest} or an equivalent Hash.
|
|
1592
|
+
#
|
|
1593
|
+
# @param request [::Google::Cloud::AIPlatform::V1::DeleteContextRequest, ::Hash]
|
|
1594
|
+
# A request object representing the call parameters. Required. To specify no
|
|
1595
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
1596
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1597
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1598
|
+
#
|
|
1599
|
+
# @overload delete_context(name: nil, force: nil, etag: nil)
|
|
1600
|
+
# Pass arguments to `delete_context` via keyword arguments. Note that at
|
|
1601
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1602
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
1603
|
+
#
|
|
1604
|
+
# @param name [::String]
|
|
1605
|
+
# Required. The resource name of the Context to delete.
|
|
1606
|
+
# Format:
|
|
1607
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
|
|
1608
|
+
# @param force [::Boolean]
|
|
1609
|
+
# The force deletion semantics is still undefined.
|
|
1610
|
+
# Users should not use this field.
|
|
1611
|
+
# @param etag [::String]
|
|
1612
|
+
# Optional. The etag of the Context to delete.
|
|
1613
|
+
# If this is provided, it must match the server's etag. Otherwise, the
|
|
1614
|
+
# request will fail with a FAILED_PRECONDITION.
|
|
1615
|
+
#
|
|
1616
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
1617
|
+
# @yieldparam response [::Gapic::Operation]
|
|
1618
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
1619
|
+
#
|
|
1620
|
+
# @return [::Gapic::Operation]
|
|
1621
|
+
#
|
|
1622
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
1623
|
+
#
|
|
1624
|
+
# @example Basic example
|
|
1625
|
+
# require "google/cloud/ai_platform/v1"
|
|
1626
|
+
#
|
|
1627
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1628
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
1629
|
+
#
|
|
1630
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1631
|
+
# request = Google::Cloud::AIPlatform::V1::DeleteContextRequest.new
|
|
1632
|
+
#
|
|
1633
|
+
# # Call the delete_context method.
|
|
1634
|
+
# result = client.delete_context request
|
|
1635
|
+
#
|
|
1636
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
|
1637
|
+
# # object to check the status of an operation, cancel it, or wait
|
|
1638
|
+
# # for results. Here is how to block until completion:
|
|
1639
|
+
# result.wait_until_done! timeout: 60
|
|
1640
|
+
# if result.response?
|
|
1641
|
+
# p result.response
|
|
1642
|
+
# else
|
|
1643
|
+
# puts "Error!"
|
|
1644
|
+
# end
|
|
1645
|
+
#
|
|
1646
|
+
def delete_context request, options = nil
|
|
1647
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1648
|
+
|
|
1649
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteContextRequest
|
|
1650
|
+
|
|
1651
|
+
# Converts hash and nil to an options object
|
|
1652
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
1653
|
+
|
|
1654
|
+
# Customize the options with defaults
|
|
1655
|
+
metadata = @config.rpcs.delete_context.metadata.to_h
|
|
1656
|
+
|
|
1657
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
1658
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
1659
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
1660
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
1661
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
1662
|
+
|
|
1663
|
+
header_params = {}
|
|
1664
|
+
if request.name
|
|
1665
|
+
header_params["name"] = request.name
|
|
1666
|
+
end
|
|
1667
|
+
|
|
1668
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
1669
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
1670
|
+
|
|
1671
|
+
options.apply_defaults timeout: @config.rpcs.delete_context.timeout,
|
|
1672
|
+
metadata: metadata,
|
|
1673
|
+
retry_policy: @config.rpcs.delete_context.retry_policy
|
|
1674
|
+
|
|
1675
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1676
|
+
metadata: @config.metadata,
|
|
1677
|
+
retry_policy: @config.retry_policy
|
|
1678
|
+
|
|
1679
|
+
@metadata_service_stub.call_rpc :delete_context, request, options: options do |response, operation|
|
|
1680
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
|
1681
|
+
yield response, operation if block_given?
|
|
1682
|
+
return response
|
|
1683
|
+
end
|
|
1684
|
+
rescue ::GRPC::BadStatus => e
|
|
1685
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
1686
|
+
end
|
|
1687
|
+
|
|
1688
|
+
##
|
|
1689
|
+
# Purges Contexts.
|
|
1690
|
+
#
|
|
1691
|
+
# @overload purge_contexts(request, options = nil)
|
|
1692
|
+
# Pass arguments to `purge_contexts` via a request object, either of type
|
|
1693
|
+
# {::Google::Cloud::AIPlatform::V1::PurgeContextsRequest} or an equivalent Hash.
|
|
1694
|
+
#
|
|
1695
|
+
# @param request [::Google::Cloud::AIPlatform::V1::PurgeContextsRequest, ::Hash]
|
|
1696
|
+
# A request object representing the call parameters. Required. To specify no
|
|
1697
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
1698
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1699
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1700
|
+
#
|
|
1701
|
+
# @overload purge_contexts(parent: nil, filter: nil, force: nil)
|
|
1702
|
+
# Pass arguments to `purge_contexts` via keyword arguments. Note that at
|
|
1703
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1704
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
1705
|
+
#
|
|
1706
|
+
# @param parent [::String]
|
|
1707
|
+
# Required. The metadata store to purge Contexts from.
|
|
1708
|
+
# Format:
|
|
1709
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
|
1710
|
+
# @param filter [::String]
|
|
1711
|
+
# Required. A required filter matching the Contexts to be purged.
|
|
1712
|
+
# E.g., `update_time <= 2020-11-19T11:30:00-04:00`.
|
|
1713
|
+
# @param force [::Boolean]
|
|
1714
|
+
# Optional. Flag to indicate to actually perform the purge.
|
|
1715
|
+
# If `force` is set to false, the method will return a sample of
|
|
1716
|
+
# Context names that would be deleted.
|
|
1717
|
+
#
|
|
1718
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
1719
|
+
# @yieldparam response [::Gapic::Operation]
|
|
1720
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
1721
|
+
#
|
|
1722
|
+
# @return [::Gapic::Operation]
|
|
1723
|
+
#
|
|
1724
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
1725
|
+
#
|
|
1726
|
+
# @example Basic example
|
|
1727
|
+
# require "google/cloud/ai_platform/v1"
|
|
1728
|
+
#
|
|
1729
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1730
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
1731
|
+
#
|
|
1732
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1733
|
+
# request = Google::Cloud::AIPlatform::V1::PurgeContextsRequest.new
|
|
1734
|
+
#
|
|
1735
|
+
# # Call the purge_contexts method.
|
|
1736
|
+
# result = client.purge_contexts request
|
|
1737
|
+
#
|
|
1738
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
|
1739
|
+
# # object to check the status of an operation, cancel it, or wait
|
|
1740
|
+
# # for results. Here is how to block until completion:
|
|
1741
|
+
# result.wait_until_done! timeout: 60
|
|
1742
|
+
# if result.response?
|
|
1743
|
+
# p result.response
|
|
1744
|
+
# else
|
|
1745
|
+
# puts "Error!"
|
|
1746
|
+
# end
|
|
1747
|
+
#
|
|
1748
|
+
def purge_contexts request, options = nil
|
|
1749
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1750
|
+
|
|
1751
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::PurgeContextsRequest
|
|
1752
|
+
|
|
1753
|
+
# Converts hash and nil to an options object
|
|
1754
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
1755
|
+
|
|
1756
|
+
# Customize the options with defaults
|
|
1757
|
+
metadata = @config.rpcs.purge_contexts.metadata.to_h
|
|
1758
|
+
|
|
1759
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
1760
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
1761
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
1762
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
1763
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
1764
|
+
|
|
1765
|
+
header_params = {}
|
|
1766
|
+
if request.parent
|
|
1767
|
+
header_params["parent"] = request.parent
|
|
1768
|
+
end
|
|
1769
|
+
|
|
1770
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
1771
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
1772
|
+
|
|
1773
|
+
options.apply_defaults timeout: @config.rpcs.purge_contexts.timeout,
|
|
1774
|
+
metadata: metadata,
|
|
1775
|
+
retry_policy: @config.rpcs.purge_contexts.retry_policy
|
|
1776
|
+
|
|
1777
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1778
|
+
metadata: @config.metadata,
|
|
1779
|
+
retry_policy: @config.retry_policy
|
|
1780
|
+
|
|
1781
|
+
@metadata_service_stub.call_rpc :purge_contexts, request, options: options do |response, operation|
|
|
1782
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
|
1783
|
+
yield response, operation if block_given?
|
|
1784
|
+
return response
|
|
1785
|
+
end
|
|
1786
|
+
rescue ::GRPC::BadStatus => e
|
|
1787
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
1788
|
+
end
|
|
1789
|
+
|
|
1790
|
+
##
|
|
1791
|
+
# Adds a set of Artifacts and Executions to a Context. If any of the
|
|
1792
|
+
# Artifacts or Executions have already been added to a Context, they are
|
|
1793
|
+
# simply skipped.
|
|
1794
|
+
#
|
|
1795
|
+
# @overload add_context_artifacts_and_executions(request, options = nil)
|
|
1796
|
+
# Pass arguments to `add_context_artifacts_and_executions` via a request object, either of type
|
|
1797
|
+
# {::Google::Cloud::AIPlatform::V1::AddContextArtifactsAndExecutionsRequest} or an equivalent Hash.
|
|
1798
|
+
#
|
|
1799
|
+
# @param request [::Google::Cloud::AIPlatform::V1::AddContextArtifactsAndExecutionsRequest, ::Hash]
|
|
1800
|
+
# A request object representing the call parameters. Required. To specify no
|
|
1801
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
1802
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1803
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1804
|
+
#
|
|
1805
|
+
# @overload add_context_artifacts_and_executions(context: nil, artifacts: nil, executions: nil)
|
|
1806
|
+
# Pass arguments to `add_context_artifacts_and_executions` via keyword arguments. Note that at
|
|
1807
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1808
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
1809
|
+
#
|
|
1810
|
+
# @param context [::String]
|
|
1811
|
+
# Required. The resource name of the Context that the Artifacts and Executions
|
|
1812
|
+
# belong to.
|
|
1813
|
+
# Format:
|
|
1814
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
|
|
1815
|
+
# @param artifacts [::Array<::String>]
|
|
1816
|
+
# The resource names of the Artifacts to attribute to the Context.
|
|
1817
|
+
#
|
|
1818
|
+
# Format:
|
|
1819
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
|
|
1820
|
+
# @param executions [::Array<::String>]
|
|
1821
|
+
# The resource names of the Executions to associate with the
|
|
1822
|
+
# Context.
|
|
1823
|
+
#
|
|
1824
|
+
# Format:
|
|
1825
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
|
|
1826
|
+
#
|
|
1827
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
1828
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::AddContextArtifactsAndExecutionsResponse]
|
|
1829
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
1830
|
+
#
|
|
1831
|
+
# @return [::Google::Cloud::AIPlatform::V1::AddContextArtifactsAndExecutionsResponse]
|
|
1832
|
+
#
|
|
1833
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
1834
|
+
#
|
|
1835
|
+
# @example Basic example
|
|
1836
|
+
# require "google/cloud/ai_platform/v1"
|
|
1837
|
+
#
|
|
1838
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1839
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
1840
|
+
#
|
|
1841
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1842
|
+
# request = Google::Cloud::AIPlatform::V1::AddContextArtifactsAndExecutionsRequest.new
|
|
1843
|
+
#
|
|
1844
|
+
# # Call the add_context_artifacts_and_executions method.
|
|
1845
|
+
# result = client.add_context_artifacts_and_executions request
|
|
1846
|
+
#
|
|
1847
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::AddContextArtifactsAndExecutionsResponse.
|
|
1848
|
+
# p result
|
|
1849
|
+
#
|
|
1850
|
+
def add_context_artifacts_and_executions request, options = nil
|
|
1851
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1852
|
+
|
|
1853
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::AddContextArtifactsAndExecutionsRequest
|
|
1854
|
+
|
|
1855
|
+
# Converts hash and nil to an options object
|
|
1856
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
1857
|
+
|
|
1858
|
+
# Customize the options with defaults
|
|
1859
|
+
metadata = @config.rpcs.add_context_artifacts_and_executions.metadata.to_h
|
|
1860
|
+
|
|
1861
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
1862
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
1863
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
1864
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
1865
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
1866
|
+
|
|
1867
|
+
header_params = {}
|
|
1868
|
+
if request.context
|
|
1869
|
+
header_params["context"] = request.context
|
|
1870
|
+
end
|
|
1871
|
+
|
|
1872
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
1873
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
1874
|
+
|
|
1875
|
+
options.apply_defaults timeout: @config.rpcs.add_context_artifacts_and_executions.timeout,
|
|
1876
|
+
metadata: metadata,
|
|
1877
|
+
retry_policy: @config.rpcs.add_context_artifacts_and_executions.retry_policy
|
|
1878
|
+
|
|
1879
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1880
|
+
metadata: @config.metadata,
|
|
1881
|
+
retry_policy: @config.retry_policy
|
|
1882
|
+
|
|
1883
|
+
@metadata_service_stub.call_rpc :add_context_artifacts_and_executions, request, options: options do |response, operation|
|
|
1884
|
+
yield response, operation if block_given?
|
|
1885
|
+
return response
|
|
1886
|
+
end
|
|
1887
|
+
rescue ::GRPC::BadStatus => e
|
|
1888
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
1889
|
+
end
|
|
1890
|
+
|
|
1891
|
+
##
|
|
1892
|
+
# Adds a set of Contexts as children to a parent Context. If any of the
|
|
1893
|
+
# child Contexts have already been added to the parent Context, they are
|
|
1894
|
+
# simply skipped. If this call would create a cycle or cause any Context to
|
|
1895
|
+
# have more than 10 parents, the request will fail with an INVALID_ARGUMENT
|
|
1896
|
+
# error.
|
|
1897
|
+
#
|
|
1898
|
+
# @overload add_context_children(request, options = nil)
|
|
1899
|
+
# Pass arguments to `add_context_children` via a request object, either of type
|
|
1900
|
+
# {::Google::Cloud::AIPlatform::V1::AddContextChildrenRequest} or an equivalent Hash.
|
|
1901
|
+
#
|
|
1902
|
+
# @param request [::Google::Cloud::AIPlatform::V1::AddContextChildrenRequest, ::Hash]
|
|
1903
|
+
# A request object representing the call parameters. Required. To specify no
|
|
1904
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
1905
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1906
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1907
|
+
#
|
|
1908
|
+
# @overload add_context_children(context: nil, child_contexts: nil)
|
|
1909
|
+
# Pass arguments to `add_context_children` via keyword arguments. Note that at
|
|
1910
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1911
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
1912
|
+
#
|
|
1913
|
+
# @param context [::String]
|
|
1914
|
+
# Required. The resource name of the parent Context.
|
|
1915
|
+
#
|
|
1916
|
+
# Format:
|
|
1917
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
|
|
1918
|
+
# @param child_contexts [::Array<::String>]
|
|
1919
|
+
# The resource names of the child Contexts.
|
|
1920
|
+
#
|
|
1921
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
1922
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::AddContextChildrenResponse]
|
|
1923
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
1924
|
+
#
|
|
1925
|
+
# @return [::Google::Cloud::AIPlatform::V1::AddContextChildrenResponse]
|
|
1926
|
+
#
|
|
1927
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
1928
|
+
#
|
|
1929
|
+
# @example Basic example
|
|
1930
|
+
# require "google/cloud/ai_platform/v1"
|
|
1931
|
+
#
|
|
1932
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1933
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
1934
|
+
#
|
|
1935
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1936
|
+
# request = Google::Cloud::AIPlatform::V1::AddContextChildrenRequest.new
|
|
1937
|
+
#
|
|
1938
|
+
# # Call the add_context_children method.
|
|
1939
|
+
# result = client.add_context_children request
|
|
1940
|
+
#
|
|
1941
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::AddContextChildrenResponse.
|
|
1942
|
+
# p result
|
|
1943
|
+
#
|
|
1944
|
+
def add_context_children request, options = nil
|
|
1945
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
1946
|
+
|
|
1947
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::AddContextChildrenRequest
|
|
1948
|
+
|
|
1949
|
+
# Converts hash and nil to an options object
|
|
1950
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
1951
|
+
|
|
1952
|
+
# Customize the options with defaults
|
|
1953
|
+
metadata = @config.rpcs.add_context_children.metadata.to_h
|
|
1954
|
+
|
|
1955
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
1956
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
1957
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
1958
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
1959
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
1960
|
+
|
|
1961
|
+
header_params = {}
|
|
1962
|
+
if request.context
|
|
1963
|
+
header_params["context"] = request.context
|
|
1964
|
+
end
|
|
1965
|
+
|
|
1966
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
1967
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
1968
|
+
|
|
1969
|
+
options.apply_defaults timeout: @config.rpcs.add_context_children.timeout,
|
|
1970
|
+
metadata: metadata,
|
|
1971
|
+
retry_policy: @config.rpcs.add_context_children.retry_policy
|
|
1972
|
+
|
|
1973
|
+
options.apply_defaults timeout: @config.timeout,
|
|
1974
|
+
metadata: @config.metadata,
|
|
1975
|
+
retry_policy: @config.retry_policy
|
|
1976
|
+
|
|
1977
|
+
@metadata_service_stub.call_rpc :add_context_children, request, options: options do |response, operation|
|
|
1978
|
+
yield response, operation if block_given?
|
|
1979
|
+
return response
|
|
1980
|
+
end
|
|
1981
|
+
rescue ::GRPC::BadStatus => e
|
|
1982
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
1983
|
+
end
|
|
1984
|
+
|
|
1985
|
+
##
|
|
1986
|
+
# Retrieves Artifacts and Executions within the specified Context, connected
|
|
1987
|
+
# by Event edges and returned as a LineageSubgraph.
|
|
1988
|
+
#
|
|
1989
|
+
# @overload query_context_lineage_subgraph(request, options = nil)
|
|
1990
|
+
# Pass arguments to `query_context_lineage_subgraph` via a request object, either of type
|
|
1991
|
+
# {::Google::Cloud::AIPlatform::V1::QueryContextLineageSubgraphRequest} or an equivalent Hash.
|
|
1992
|
+
#
|
|
1993
|
+
# @param request [::Google::Cloud::AIPlatform::V1::QueryContextLineageSubgraphRequest, ::Hash]
|
|
1994
|
+
# A request object representing the call parameters. Required. To specify no
|
|
1995
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
1996
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1997
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1998
|
+
#
|
|
1999
|
+
# @overload query_context_lineage_subgraph(context: nil)
|
|
2000
|
+
# Pass arguments to `query_context_lineage_subgraph` via keyword arguments. Note that at
|
|
2001
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2002
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2003
|
+
#
|
|
2004
|
+
# @param context [::String]
|
|
2005
|
+
# Required. The resource name of the Context whose Artifacts and Executions
|
|
2006
|
+
# should be retrieved as a LineageSubgraph.
|
|
2007
|
+
# Format:
|
|
2008
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
|
|
2009
|
+
#
|
|
2010
|
+
# The request may error with FAILED_PRECONDITION if the number of Artifacts,
|
|
2011
|
+
# the number of Executions, or the number of Events that would be returned
|
|
2012
|
+
# for the Context exceeds 1000.
|
|
2013
|
+
#
|
|
2014
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
2015
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::LineageSubgraph]
|
|
2016
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
2017
|
+
#
|
|
2018
|
+
# @return [::Google::Cloud::AIPlatform::V1::LineageSubgraph]
|
|
2019
|
+
#
|
|
2020
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
2021
|
+
#
|
|
2022
|
+
# @example Basic example
|
|
2023
|
+
# require "google/cloud/ai_platform/v1"
|
|
2024
|
+
#
|
|
2025
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2026
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
2027
|
+
#
|
|
2028
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2029
|
+
# request = Google::Cloud::AIPlatform::V1::QueryContextLineageSubgraphRequest.new
|
|
2030
|
+
#
|
|
2031
|
+
# # Call the query_context_lineage_subgraph method.
|
|
2032
|
+
# result = client.query_context_lineage_subgraph request
|
|
2033
|
+
#
|
|
2034
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::LineageSubgraph.
|
|
2035
|
+
# p result
|
|
2036
|
+
#
|
|
2037
|
+
def query_context_lineage_subgraph request, options = nil
|
|
2038
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
2039
|
+
|
|
2040
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::QueryContextLineageSubgraphRequest
|
|
2041
|
+
|
|
2042
|
+
# Converts hash and nil to an options object
|
|
2043
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
2044
|
+
|
|
2045
|
+
# Customize the options with defaults
|
|
2046
|
+
metadata = @config.rpcs.query_context_lineage_subgraph.metadata.to_h
|
|
2047
|
+
|
|
2048
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
2049
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
2050
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
2051
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
2052
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
2053
|
+
|
|
2054
|
+
header_params = {}
|
|
2055
|
+
if request.context
|
|
2056
|
+
header_params["context"] = request.context
|
|
2057
|
+
end
|
|
2058
|
+
|
|
2059
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
2060
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
2061
|
+
|
|
2062
|
+
options.apply_defaults timeout: @config.rpcs.query_context_lineage_subgraph.timeout,
|
|
2063
|
+
metadata: metadata,
|
|
2064
|
+
retry_policy: @config.rpcs.query_context_lineage_subgraph.retry_policy
|
|
2065
|
+
|
|
2066
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2067
|
+
metadata: @config.metadata,
|
|
2068
|
+
retry_policy: @config.retry_policy
|
|
2069
|
+
|
|
2070
|
+
@metadata_service_stub.call_rpc :query_context_lineage_subgraph, request, options: options do |response, operation|
|
|
2071
|
+
yield response, operation if block_given?
|
|
2072
|
+
return response
|
|
2073
|
+
end
|
|
2074
|
+
rescue ::GRPC::BadStatus => e
|
|
2075
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
2076
|
+
end
|
|
2077
|
+
|
|
2078
|
+
##
|
|
2079
|
+
# Creates an Execution associated with a MetadataStore.
|
|
2080
|
+
#
|
|
2081
|
+
# @overload create_execution(request, options = nil)
|
|
2082
|
+
# Pass arguments to `create_execution` via a request object, either of type
|
|
2083
|
+
# {::Google::Cloud::AIPlatform::V1::CreateExecutionRequest} or an equivalent Hash.
|
|
2084
|
+
#
|
|
2085
|
+
# @param request [::Google::Cloud::AIPlatform::V1::CreateExecutionRequest, ::Hash]
|
|
2086
|
+
# A request object representing the call parameters. Required. To specify no
|
|
2087
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
2088
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
2089
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
2090
|
+
#
|
|
2091
|
+
# @overload create_execution(parent: nil, execution: nil, execution_id: nil)
|
|
2092
|
+
# Pass arguments to `create_execution` via keyword arguments. Note that at
|
|
2093
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2094
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2095
|
+
#
|
|
2096
|
+
# @param parent [::String]
|
|
2097
|
+
# Required. The resource name of the MetadataStore where the Execution should
|
|
2098
|
+
# be created.
|
|
2099
|
+
# Format:
|
|
2100
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
|
2101
|
+
# @param execution [::Google::Cloud::AIPlatform::V1::Execution, ::Hash]
|
|
2102
|
+
# Required. The Execution to create.
|
|
2103
|
+
# @param execution_id [::String]
|
|
2104
|
+
# The \\{execution} portion of the resource name with the format:
|
|
2105
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
|
|
2106
|
+
# If not provided, the Execution's ID will be a UUID generated by the
|
|
2107
|
+
# service.
|
|
2108
|
+
# Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
|
|
2109
|
+
# Must be unique across all Executions in the parent MetadataStore.
|
|
2110
|
+
# (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
|
|
2111
|
+
# if the caller can't view the preexisting Execution.)
|
|
2112
|
+
#
|
|
2113
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
2114
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::Execution]
|
|
2115
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
2116
|
+
#
|
|
2117
|
+
# @return [::Google::Cloud::AIPlatform::V1::Execution]
|
|
2118
|
+
#
|
|
2119
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
2120
|
+
#
|
|
2121
|
+
# @example Basic example
|
|
2122
|
+
# require "google/cloud/ai_platform/v1"
|
|
2123
|
+
#
|
|
2124
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2125
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
2126
|
+
#
|
|
2127
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2128
|
+
# request = Google::Cloud::AIPlatform::V1::CreateExecutionRequest.new
|
|
2129
|
+
#
|
|
2130
|
+
# # Call the create_execution method.
|
|
2131
|
+
# result = client.create_execution request
|
|
2132
|
+
#
|
|
2133
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::Execution.
|
|
2134
|
+
# p result
|
|
2135
|
+
#
|
|
2136
|
+
def create_execution request, options = nil
|
|
2137
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
2138
|
+
|
|
2139
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateExecutionRequest
|
|
2140
|
+
|
|
2141
|
+
# Converts hash and nil to an options object
|
|
2142
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
2143
|
+
|
|
2144
|
+
# Customize the options with defaults
|
|
2145
|
+
metadata = @config.rpcs.create_execution.metadata.to_h
|
|
2146
|
+
|
|
2147
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
2148
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
2149
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
2150
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
2151
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
2152
|
+
|
|
2153
|
+
header_params = {}
|
|
2154
|
+
if request.parent
|
|
2155
|
+
header_params["parent"] = request.parent
|
|
2156
|
+
end
|
|
2157
|
+
|
|
2158
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
2159
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
2160
|
+
|
|
2161
|
+
options.apply_defaults timeout: @config.rpcs.create_execution.timeout,
|
|
2162
|
+
metadata: metadata,
|
|
2163
|
+
retry_policy: @config.rpcs.create_execution.retry_policy
|
|
2164
|
+
|
|
2165
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2166
|
+
metadata: @config.metadata,
|
|
2167
|
+
retry_policy: @config.retry_policy
|
|
2168
|
+
|
|
2169
|
+
@metadata_service_stub.call_rpc :create_execution, request, options: options do |response, operation|
|
|
2170
|
+
yield response, operation if block_given?
|
|
2171
|
+
return response
|
|
2172
|
+
end
|
|
2173
|
+
rescue ::GRPC::BadStatus => e
|
|
2174
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
2175
|
+
end
|
|
2176
|
+
|
|
2177
|
+
##
|
|
2178
|
+
# Retrieves a specific Execution.
|
|
2179
|
+
#
|
|
2180
|
+
# @overload get_execution(request, options = nil)
|
|
2181
|
+
# Pass arguments to `get_execution` via a request object, either of type
|
|
2182
|
+
# {::Google::Cloud::AIPlatform::V1::GetExecutionRequest} or an equivalent Hash.
|
|
2183
|
+
#
|
|
2184
|
+
# @param request [::Google::Cloud::AIPlatform::V1::GetExecutionRequest, ::Hash]
|
|
2185
|
+
# A request object representing the call parameters. Required. To specify no
|
|
2186
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
2187
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
2188
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
2189
|
+
#
|
|
2190
|
+
# @overload get_execution(name: nil)
|
|
2191
|
+
# Pass arguments to `get_execution` via keyword arguments. Note that at
|
|
2192
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2193
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2194
|
+
#
|
|
2195
|
+
# @param name [::String]
|
|
2196
|
+
# Required. The resource name of the Execution to retrieve.
|
|
2197
|
+
# Format:
|
|
2198
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
|
|
2199
|
+
#
|
|
2200
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
2201
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::Execution]
|
|
2202
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
2203
|
+
#
|
|
2204
|
+
# @return [::Google::Cloud::AIPlatform::V1::Execution]
|
|
2205
|
+
#
|
|
2206
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
2207
|
+
#
|
|
2208
|
+
# @example Basic example
|
|
2209
|
+
# require "google/cloud/ai_platform/v1"
|
|
2210
|
+
#
|
|
2211
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2212
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
2213
|
+
#
|
|
2214
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2215
|
+
# request = Google::Cloud::AIPlatform::V1::GetExecutionRequest.new
|
|
2216
|
+
#
|
|
2217
|
+
# # Call the get_execution method.
|
|
2218
|
+
# result = client.get_execution request
|
|
2219
|
+
#
|
|
2220
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::Execution.
|
|
2221
|
+
# p result
|
|
2222
|
+
#
|
|
2223
|
+
def get_execution request, options = nil
|
|
2224
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
2225
|
+
|
|
2226
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetExecutionRequest
|
|
2227
|
+
|
|
2228
|
+
# Converts hash and nil to an options object
|
|
2229
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
2230
|
+
|
|
2231
|
+
# Customize the options with defaults
|
|
2232
|
+
metadata = @config.rpcs.get_execution.metadata.to_h
|
|
2233
|
+
|
|
2234
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
2235
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
2236
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
2237
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
2238
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
2239
|
+
|
|
2240
|
+
header_params = {}
|
|
2241
|
+
if request.name
|
|
2242
|
+
header_params["name"] = request.name
|
|
2243
|
+
end
|
|
2244
|
+
|
|
2245
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
2246
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
2247
|
+
|
|
2248
|
+
options.apply_defaults timeout: @config.rpcs.get_execution.timeout,
|
|
2249
|
+
metadata: metadata,
|
|
2250
|
+
retry_policy: @config.rpcs.get_execution.retry_policy
|
|
2251
|
+
|
|
2252
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2253
|
+
metadata: @config.metadata,
|
|
2254
|
+
retry_policy: @config.retry_policy
|
|
2255
|
+
|
|
2256
|
+
@metadata_service_stub.call_rpc :get_execution, request, options: options do |response, operation|
|
|
2257
|
+
yield response, operation if block_given?
|
|
2258
|
+
return response
|
|
2259
|
+
end
|
|
2260
|
+
rescue ::GRPC::BadStatus => e
|
|
2261
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
2262
|
+
end
|
|
2263
|
+
|
|
2264
|
+
##
|
|
2265
|
+
# Lists Executions in the MetadataStore.
|
|
2266
|
+
#
|
|
2267
|
+
# @overload list_executions(request, options = nil)
|
|
2268
|
+
# Pass arguments to `list_executions` via a request object, either of type
|
|
2269
|
+
# {::Google::Cloud::AIPlatform::V1::ListExecutionsRequest} or an equivalent Hash.
|
|
2270
|
+
#
|
|
2271
|
+
# @param request [::Google::Cloud::AIPlatform::V1::ListExecutionsRequest, ::Hash]
|
|
2272
|
+
# A request object representing the call parameters. Required. To specify no
|
|
2273
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
2274
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
2275
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
2276
|
+
#
|
|
2277
|
+
# @overload list_executions(parent: nil, page_size: nil, page_token: nil, filter: nil)
|
|
2278
|
+
# Pass arguments to `list_executions` via keyword arguments. Note that at
|
|
2279
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2280
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2281
|
+
#
|
|
2282
|
+
# @param parent [::String]
|
|
2283
|
+
# Required. The MetadataStore whose Executions should be listed.
|
|
2284
|
+
# Format:
|
|
2285
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
|
2286
|
+
# @param page_size [::Integer]
|
|
2287
|
+
# The maximum number of Executions to return. The service may return fewer.
|
|
2288
|
+
# Must be in range 1-1000, inclusive. Defaults to 100.
|
|
2289
|
+
# @param page_token [::String]
|
|
2290
|
+
# A page token, received from a previous {::Google::Cloud::AIPlatform::V1::MetadataService::Client#list_executions MetadataService.ListExecutions}
|
|
2291
|
+
# call. Provide this to retrieve the subsequent page.
|
|
2292
|
+
#
|
|
2293
|
+
# When paginating, all other provided parameters must match the call that
|
|
2294
|
+
# provided the page token. (Otherwise the request will fail with an
|
|
2295
|
+
# INVALID_ARGUMENT error.)
|
|
2296
|
+
# @param filter [::String]
|
|
2297
|
+
# Filter specifying the boolean condition for the Executions to satisfy in
|
|
2298
|
+
# order to be part of the result set.
|
|
2299
|
+
# The syntax to define filter query is based on https://google.aip.dev/160.
|
|
2300
|
+
# Following are the supported set of filters:
|
|
2301
|
+
#
|
|
2302
|
+
# * **Attribute filtering**:
|
|
2303
|
+
# For example: `display_name = "test"`.
|
|
2304
|
+
# Supported fields include: `name`, `display_name`, `state`,
|
|
2305
|
+
# `schema_title`, `create_time`, and `update_time`.
|
|
2306
|
+
# Time fields, such as `create_time` and `update_time`, require values
|
|
2307
|
+
# specified in RFC-3339 format.
|
|
2308
|
+
# For example: `create_time = "2020-11-19T11:30:00-04:00"`.
|
|
2309
|
+
# * **Metadata field**:
|
|
2310
|
+
# To filter on metadata fields use traversal operation as follows:
|
|
2311
|
+
# `metadata.<field_name>.<type_value>`
|
|
2312
|
+
# For example: `metadata.field_1.number_value = 10.0`
|
|
2313
|
+
# * **Context based filtering**:
|
|
2314
|
+
# To filter Executions based on the contexts to which they belong use
|
|
2315
|
+
# the function operator with the full resource name:
|
|
2316
|
+
# `in_context(<context-name>)`.
|
|
2317
|
+
# For example:
|
|
2318
|
+
# `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")`
|
|
2319
|
+
#
|
|
2320
|
+
# Each of the above supported filters can be combined together using
|
|
2321
|
+
# logical operators (`AND` & `OR`).
|
|
2322
|
+
# For example: `display_name = "test" AND metadata.field1.bool_value = true`.
|
|
2323
|
+
#
|
|
2324
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
2325
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Execution>]
|
|
2326
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
2327
|
+
#
|
|
2328
|
+
# @return [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Execution>]
|
|
2329
|
+
#
|
|
2330
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
2331
|
+
#
|
|
2332
|
+
# @example Basic example
|
|
2333
|
+
# require "google/cloud/ai_platform/v1"
|
|
2334
|
+
#
|
|
2335
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2336
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
2337
|
+
#
|
|
2338
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2339
|
+
# request = Google::Cloud::AIPlatform::V1::ListExecutionsRequest.new
|
|
2340
|
+
#
|
|
2341
|
+
# # Call the list_executions method.
|
|
2342
|
+
# result = client.list_executions request
|
|
2343
|
+
#
|
|
2344
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
|
2345
|
+
# # iterate over all elements by calling #each, and the enumerable
|
|
2346
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
|
2347
|
+
# # methods are also available for managing paging directly.
|
|
2348
|
+
# result.each do |response|
|
|
2349
|
+
# # Each element is of type ::Google::Cloud::AIPlatform::V1::Execution.
|
|
2350
|
+
# p response
|
|
2351
|
+
# end
|
|
2352
|
+
#
|
|
2353
|
+
def list_executions request, options = nil
|
|
2354
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
2355
|
+
|
|
2356
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListExecutionsRequest
|
|
2357
|
+
|
|
2358
|
+
# Converts hash and nil to an options object
|
|
2359
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
2360
|
+
|
|
2361
|
+
# Customize the options with defaults
|
|
2362
|
+
metadata = @config.rpcs.list_executions.metadata.to_h
|
|
2363
|
+
|
|
2364
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
2365
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
2366
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
2367
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
2368
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
2369
|
+
|
|
2370
|
+
header_params = {}
|
|
2371
|
+
if request.parent
|
|
2372
|
+
header_params["parent"] = request.parent
|
|
2373
|
+
end
|
|
2374
|
+
|
|
2375
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
2376
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
2377
|
+
|
|
2378
|
+
options.apply_defaults timeout: @config.rpcs.list_executions.timeout,
|
|
2379
|
+
metadata: metadata,
|
|
2380
|
+
retry_policy: @config.rpcs.list_executions.retry_policy
|
|
2381
|
+
|
|
2382
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2383
|
+
metadata: @config.metadata,
|
|
2384
|
+
retry_policy: @config.retry_policy
|
|
2385
|
+
|
|
2386
|
+
@metadata_service_stub.call_rpc :list_executions, request, options: options do |response, operation|
|
|
2387
|
+
response = ::Gapic::PagedEnumerable.new @metadata_service_stub, :list_executions, request, response, operation, options
|
|
2388
|
+
yield response, operation if block_given?
|
|
2389
|
+
return response
|
|
2390
|
+
end
|
|
2391
|
+
rescue ::GRPC::BadStatus => e
|
|
2392
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
2393
|
+
end
|
|
2394
|
+
|
|
2395
|
+
##
|
|
2396
|
+
# Updates a stored Execution.
|
|
2397
|
+
#
|
|
2398
|
+
# @overload update_execution(request, options = nil)
|
|
2399
|
+
# Pass arguments to `update_execution` via a request object, either of type
|
|
2400
|
+
# {::Google::Cloud::AIPlatform::V1::UpdateExecutionRequest} or an equivalent Hash.
|
|
2401
|
+
#
|
|
2402
|
+
# @param request [::Google::Cloud::AIPlatform::V1::UpdateExecutionRequest, ::Hash]
|
|
2403
|
+
# A request object representing the call parameters. Required. To specify no
|
|
2404
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
2405
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
2406
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
2407
|
+
#
|
|
2408
|
+
# @overload update_execution(execution: nil, update_mask: nil, allow_missing: nil)
|
|
2409
|
+
# Pass arguments to `update_execution` via keyword arguments. Note that at
|
|
2410
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2411
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2412
|
+
#
|
|
2413
|
+
# @param execution [::Google::Cloud::AIPlatform::V1::Execution, ::Hash]
|
|
2414
|
+
# Required. The Execution containing updates.
|
|
2415
|
+
# The Execution's {::Google::Cloud::AIPlatform::V1::Execution#name Execution.name} field is used to identify the Execution
|
|
2416
|
+
# to be updated.
|
|
2417
|
+
# Format:
|
|
2418
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
|
|
2419
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
2420
|
+
# Required. A FieldMask indicating which fields should be updated.
|
|
2421
|
+
# Functionality of this field is not yet supported.
|
|
2422
|
+
# @param allow_missing [::Boolean]
|
|
2423
|
+
# If set to true, and the {::Google::Cloud::AIPlatform::V1::Execution Execution} is not found, a new {::Google::Cloud::AIPlatform::V1::Execution Execution}
|
|
2424
|
+
# is created.
|
|
2425
|
+
#
|
|
2426
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
2427
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::Execution]
|
|
2428
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
2429
|
+
#
|
|
2430
|
+
# @return [::Google::Cloud::AIPlatform::V1::Execution]
|
|
2431
|
+
#
|
|
2432
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
2433
|
+
#
|
|
2434
|
+
# @example Basic example
|
|
2435
|
+
# require "google/cloud/ai_platform/v1"
|
|
2436
|
+
#
|
|
2437
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2438
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
2439
|
+
#
|
|
2440
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2441
|
+
# request = Google::Cloud::AIPlatform::V1::UpdateExecutionRequest.new
|
|
2442
|
+
#
|
|
2443
|
+
# # Call the update_execution method.
|
|
2444
|
+
# result = client.update_execution request
|
|
2445
|
+
#
|
|
2446
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::Execution.
|
|
2447
|
+
# p result
|
|
2448
|
+
#
|
|
2449
|
+
def update_execution request, options = nil
|
|
2450
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
2451
|
+
|
|
2452
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::UpdateExecutionRequest
|
|
2453
|
+
|
|
2454
|
+
# Converts hash and nil to an options object
|
|
2455
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
2456
|
+
|
|
2457
|
+
# Customize the options with defaults
|
|
2458
|
+
metadata = @config.rpcs.update_execution.metadata.to_h
|
|
2459
|
+
|
|
2460
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
2461
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
2462
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
2463
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
2464
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
2465
|
+
|
|
2466
|
+
header_params = {}
|
|
2467
|
+
if request.execution&.name
|
|
2468
|
+
header_params["execution.name"] = request.execution.name
|
|
2469
|
+
end
|
|
2470
|
+
|
|
2471
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
2472
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
2473
|
+
|
|
2474
|
+
options.apply_defaults timeout: @config.rpcs.update_execution.timeout,
|
|
2475
|
+
metadata: metadata,
|
|
2476
|
+
retry_policy: @config.rpcs.update_execution.retry_policy
|
|
2477
|
+
|
|
2478
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2479
|
+
metadata: @config.metadata,
|
|
2480
|
+
retry_policy: @config.retry_policy
|
|
2481
|
+
|
|
2482
|
+
@metadata_service_stub.call_rpc :update_execution, request, options: options do |response, operation|
|
|
2483
|
+
yield response, operation if block_given?
|
|
2484
|
+
return response
|
|
2485
|
+
end
|
|
2486
|
+
rescue ::GRPC::BadStatus => e
|
|
2487
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
2488
|
+
end
|
|
2489
|
+
|
|
2490
|
+
##
|
|
2491
|
+
# Deletes an Execution.
|
|
2492
|
+
#
|
|
2493
|
+
# @overload delete_execution(request, options = nil)
|
|
2494
|
+
# Pass arguments to `delete_execution` via a request object, either of type
|
|
2495
|
+
# {::Google::Cloud::AIPlatform::V1::DeleteExecutionRequest} or an equivalent Hash.
|
|
2496
|
+
#
|
|
2497
|
+
# @param request [::Google::Cloud::AIPlatform::V1::DeleteExecutionRequest, ::Hash]
|
|
2498
|
+
# A request object representing the call parameters. Required. To specify no
|
|
2499
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
2500
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
2501
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
2502
|
+
#
|
|
2503
|
+
# @overload delete_execution(name: nil, etag: nil)
|
|
2504
|
+
# Pass arguments to `delete_execution` via keyword arguments. Note that at
|
|
2505
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2506
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2507
|
+
#
|
|
2508
|
+
# @param name [::String]
|
|
2509
|
+
# Required. The resource name of the Execution to delete.
|
|
2510
|
+
# Format:
|
|
2511
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
|
|
2512
|
+
# @param etag [::String]
|
|
2513
|
+
# Optional. The etag of the Execution to delete.
|
|
2514
|
+
# If this is provided, it must match the server's etag. Otherwise, the
|
|
2515
|
+
# request will fail with a FAILED_PRECONDITION.
|
|
2516
|
+
#
|
|
2517
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
2518
|
+
# @yieldparam response [::Gapic::Operation]
|
|
2519
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
2520
|
+
#
|
|
2521
|
+
# @return [::Gapic::Operation]
|
|
2522
|
+
#
|
|
2523
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
2524
|
+
#
|
|
2525
|
+
# @example Basic example
|
|
2526
|
+
# require "google/cloud/ai_platform/v1"
|
|
2527
|
+
#
|
|
2528
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2529
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
2530
|
+
#
|
|
2531
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2532
|
+
# request = Google::Cloud::AIPlatform::V1::DeleteExecutionRequest.new
|
|
2533
|
+
#
|
|
2534
|
+
# # Call the delete_execution method.
|
|
2535
|
+
# result = client.delete_execution request
|
|
2536
|
+
#
|
|
2537
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
|
2538
|
+
# # object to check the status of an operation, cancel it, or wait
|
|
2539
|
+
# # for results. Here is how to block until completion:
|
|
2540
|
+
# result.wait_until_done! timeout: 60
|
|
2541
|
+
# if result.response?
|
|
2542
|
+
# p result.response
|
|
2543
|
+
# else
|
|
2544
|
+
# puts "Error!"
|
|
2545
|
+
# end
|
|
2546
|
+
#
|
|
2547
|
+
def delete_execution request, options = nil
|
|
2548
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
2549
|
+
|
|
2550
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteExecutionRequest
|
|
2551
|
+
|
|
2552
|
+
# Converts hash and nil to an options object
|
|
2553
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
2554
|
+
|
|
2555
|
+
# Customize the options with defaults
|
|
2556
|
+
metadata = @config.rpcs.delete_execution.metadata.to_h
|
|
2557
|
+
|
|
2558
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
2559
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
2560
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
2561
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
2562
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
2563
|
+
|
|
2564
|
+
header_params = {}
|
|
2565
|
+
if request.name
|
|
2566
|
+
header_params["name"] = request.name
|
|
2567
|
+
end
|
|
2568
|
+
|
|
2569
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
2570
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
2571
|
+
|
|
2572
|
+
options.apply_defaults timeout: @config.rpcs.delete_execution.timeout,
|
|
2573
|
+
metadata: metadata,
|
|
2574
|
+
retry_policy: @config.rpcs.delete_execution.retry_policy
|
|
2575
|
+
|
|
2576
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2577
|
+
metadata: @config.metadata,
|
|
2578
|
+
retry_policy: @config.retry_policy
|
|
2579
|
+
|
|
2580
|
+
@metadata_service_stub.call_rpc :delete_execution, request, options: options do |response, operation|
|
|
2581
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
|
2582
|
+
yield response, operation if block_given?
|
|
2583
|
+
return response
|
|
2584
|
+
end
|
|
2585
|
+
rescue ::GRPC::BadStatus => e
|
|
2586
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
2587
|
+
end
|
|
2588
|
+
|
|
2589
|
+
##
|
|
2590
|
+
# Purges Executions.
|
|
2591
|
+
#
|
|
2592
|
+
# @overload purge_executions(request, options = nil)
|
|
2593
|
+
# Pass arguments to `purge_executions` via a request object, either of type
|
|
2594
|
+
# {::Google::Cloud::AIPlatform::V1::PurgeExecutionsRequest} or an equivalent Hash.
|
|
2595
|
+
#
|
|
2596
|
+
# @param request [::Google::Cloud::AIPlatform::V1::PurgeExecutionsRequest, ::Hash]
|
|
2597
|
+
# A request object representing the call parameters. Required. To specify no
|
|
2598
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
2599
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
2600
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
2601
|
+
#
|
|
2602
|
+
# @overload purge_executions(parent: nil, filter: nil, force: nil)
|
|
2603
|
+
# Pass arguments to `purge_executions` via keyword arguments. Note that at
|
|
2604
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2605
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2606
|
+
#
|
|
2607
|
+
# @param parent [::String]
|
|
2608
|
+
# Required. The metadata store to purge Executions from.
|
|
2609
|
+
# Format:
|
|
2610
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
|
2611
|
+
# @param filter [::String]
|
|
2612
|
+
# Required. A required filter matching the Executions to be purged.
|
|
2613
|
+
# E.g., `update_time <= 2020-11-19T11:30:00-04:00`.
|
|
2614
|
+
# @param force [::Boolean]
|
|
2615
|
+
# Optional. Flag to indicate to actually perform the purge.
|
|
2616
|
+
# If `force` is set to false, the method will return a sample of
|
|
2617
|
+
# Execution names that would be deleted.
|
|
2618
|
+
#
|
|
2619
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
2620
|
+
# @yieldparam response [::Gapic::Operation]
|
|
2621
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
2622
|
+
#
|
|
2623
|
+
# @return [::Gapic::Operation]
|
|
2624
|
+
#
|
|
2625
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
2626
|
+
#
|
|
2627
|
+
# @example Basic example
|
|
2628
|
+
# require "google/cloud/ai_platform/v1"
|
|
2629
|
+
#
|
|
2630
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2631
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
2632
|
+
#
|
|
2633
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2634
|
+
# request = Google::Cloud::AIPlatform::V1::PurgeExecutionsRequest.new
|
|
2635
|
+
#
|
|
2636
|
+
# # Call the purge_executions method.
|
|
2637
|
+
# result = client.purge_executions request
|
|
2638
|
+
#
|
|
2639
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
|
2640
|
+
# # object to check the status of an operation, cancel it, or wait
|
|
2641
|
+
# # for results. Here is how to block until completion:
|
|
2642
|
+
# result.wait_until_done! timeout: 60
|
|
2643
|
+
# if result.response?
|
|
2644
|
+
# p result.response
|
|
2645
|
+
# else
|
|
2646
|
+
# puts "Error!"
|
|
2647
|
+
# end
|
|
2648
|
+
#
|
|
2649
|
+
def purge_executions request, options = nil
|
|
2650
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
2651
|
+
|
|
2652
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::PurgeExecutionsRequest
|
|
2653
|
+
|
|
2654
|
+
# Converts hash and nil to an options object
|
|
2655
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
2656
|
+
|
|
2657
|
+
# Customize the options with defaults
|
|
2658
|
+
metadata = @config.rpcs.purge_executions.metadata.to_h
|
|
2659
|
+
|
|
2660
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
2661
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
2662
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
2663
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
2664
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
2665
|
+
|
|
2666
|
+
header_params = {}
|
|
2667
|
+
if request.parent
|
|
2668
|
+
header_params["parent"] = request.parent
|
|
2669
|
+
end
|
|
2670
|
+
|
|
2671
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
2672
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
2673
|
+
|
|
2674
|
+
options.apply_defaults timeout: @config.rpcs.purge_executions.timeout,
|
|
2675
|
+
metadata: metadata,
|
|
2676
|
+
retry_policy: @config.rpcs.purge_executions.retry_policy
|
|
2677
|
+
|
|
2678
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2679
|
+
metadata: @config.metadata,
|
|
2680
|
+
retry_policy: @config.retry_policy
|
|
2681
|
+
|
|
2682
|
+
@metadata_service_stub.call_rpc :purge_executions, request, options: options do |response, operation|
|
|
2683
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
|
2684
|
+
yield response, operation if block_given?
|
|
2685
|
+
return response
|
|
2686
|
+
end
|
|
2687
|
+
rescue ::GRPC::BadStatus => e
|
|
2688
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
2689
|
+
end
|
|
2690
|
+
|
|
2691
|
+
##
|
|
2692
|
+
# Adds Events to the specified Execution. An Event indicates whether an
|
|
2693
|
+
# Artifact was used as an input or output for an Execution. If an Event
|
|
2694
|
+
# already exists between the Execution and the Artifact, the Event is
|
|
2695
|
+
# skipped.
|
|
2696
|
+
#
|
|
2697
|
+
# @overload add_execution_events(request, options = nil)
|
|
2698
|
+
# Pass arguments to `add_execution_events` via a request object, either of type
|
|
2699
|
+
# {::Google::Cloud::AIPlatform::V1::AddExecutionEventsRequest} or an equivalent Hash.
|
|
2700
|
+
#
|
|
2701
|
+
# @param request [::Google::Cloud::AIPlatform::V1::AddExecutionEventsRequest, ::Hash]
|
|
2702
|
+
# A request object representing the call parameters. Required. To specify no
|
|
2703
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
2704
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
2705
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
2706
|
+
#
|
|
2707
|
+
# @overload add_execution_events(execution: nil, events: nil)
|
|
2708
|
+
# Pass arguments to `add_execution_events` via keyword arguments. Note that at
|
|
2709
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2710
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2711
|
+
#
|
|
2712
|
+
# @param execution [::String]
|
|
2713
|
+
# Required. The resource name of the Execution that the Events connect
|
|
2714
|
+
# Artifacts with.
|
|
2715
|
+
# Format:
|
|
2716
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
|
|
2717
|
+
# @param events [::Array<::Google::Cloud::AIPlatform::V1::Event, ::Hash>]
|
|
2718
|
+
# The Events to create and add.
|
|
2719
|
+
#
|
|
2720
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
2721
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::AddExecutionEventsResponse]
|
|
2722
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
2723
|
+
#
|
|
2724
|
+
# @return [::Google::Cloud::AIPlatform::V1::AddExecutionEventsResponse]
|
|
2725
|
+
#
|
|
2726
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
2727
|
+
#
|
|
2728
|
+
# @example Basic example
|
|
2729
|
+
# require "google/cloud/ai_platform/v1"
|
|
2730
|
+
#
|
|
2731
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2732
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
2733
|
+
#
|
|
2734
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2735
|
+
# request = Google::Cloud::AIPlatform::V1::AddExecutionEventsRequest.new
|
|
2736
|
+
#
|
|
2737
|
+
# # Call the add_execution_events method.
|
|
2738
|
+
# result = client.add_execution_events request
|
|
2739
|
+
#
|
|
2740
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::AddExecutionEventsResponse.
|
|
2741
|
+
# p result
|
|
2742
|
+
#
|
|
2743
|
+
def add_execution_events request, options = nil
|
|
2744
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
2745
|
+
|
|
2746
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::AddExecutionEventsRequest
|
|
2747
|
+
|
|
2748
|
+
# Converts hash and nil to an options object
|
|
2749
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
2750
|
+
|
|
2751
|
+
# Customize the options with defaults
|
|
2752
|
+
metadata = @config.rpcs.add_execution_events.metadata.to_h
|
|
2753
|
+
|
|
2754
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
2755
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
2756
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
2757
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
2758
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
2759
|
+
|
|
2760
|
+
header_params = {}
|
|
2761
|
+
if request.execution
|
|
2762
|
+
header_params["execution"] = request.execution
|
|
2763
|
+
end
|
|
2764
|
+
|
|
2765
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
2766
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
2767
|
+
|
|
2768
|
+
options.apply_defaults timeout: @config.rpcs.add_execution_events.timeout,
|
|
2769
|
+
metadata: metadata,
|
|
2770
|
+
retry_policy: @config.rpcs.add_execution_events.retry_policy
|
|
2771
|
+
|
|
2772
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2773
|
+
metadata: @config.metadata,
|
|
2774
|
+
retry_policy: @config.retry_policy
|
|
2775
|
+
|
|
2776
|
+
@metadata_service_stub.call_rpc :add_execution_events, request, options: options do |response, operation|
|
|
2777
|
+
yield response, operation if block_given?
|
|
2778
|
+
return response
|
|
2779
|
+
end
|
|
2780
|
+
rescue ::GRPC::BadStatus => e
|
|
2781
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
2782
|
+
end
|
|
2783
|
+
|
|
2784
|
+
##
|
|
2785
|
+
# Obtains the set of input and output Artifacts for this Execution, in the
|
|
2786
|
+
# form of LineageSubgraph that also contains the Execution and connecting
|
|
2787
|
+
# Events.
|
|
2788
|
+
#
|
|
2789
|
+
# @overload query_execution_inputs_and_outputs(request, options = nil)
|
|
2790
|
+
# Pass arguments to `query_execution_inputs_and_outputs` via a request object, either of type
|
|
2791
|
+
# {::Google::Cloud::AIPlatform::V1::QueryExecutionInputsAndOutputsRequest} or an equivalent Hash.
|
|
2792
|
+
#
|
|
2793
|
+
# @param request [::Google::Cloud::AIPlatform::V1::QueryExecutionInputsAndOutputsRequest, ::Hash]
|
|
2794
|
+
# A request object representing the call parameters. Required. To specify no
|
|
2795
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
2796
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
2797
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
2798
|
+
#
|
|
2799
|
+
# @overload query_execution_inputs_and_outputs(execution: nil)
|
|
2800
|
+
# Pass arguments to `query_execution_inputs_and_outputs` via keyword arguments. Note that at
|
|
2801
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2802
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2803
|
+
#
|
|
2804
|
+
# @param execution [::String]
|
|
2805
|
+
# Required. The resource name of the Execution whose input and output Artifacts should
|
|
2806
|
+
# be retrieved as a LineageSubgraph.
|
|
2807
|
+
# Format:
|
|
2808
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
|
|
2809
|
+
#
|
|
2810
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
2811
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::LineageSubgraph]
|
|
2812
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
2813
|
+
#
|
|
2814
|
+
# @return [::Google::Cloud::AIPlatform::V1::LineageSubgraph]
|
|
2815
|
+
#
|
|
2816
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
2817
|
+
#
|
|
2818
|
+
# @example Basic example
|
|
2819
|
+
# require "google/cloud/ai_platform/v1"
|
|
2820
|
+
#
|
|
2821
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2822
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
2823
|
+
#
|
|
2824
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2825
|
+
# request = Google::Cloud::AIPlatform::V1::QueryExecutionInputsAndOutputsRequest.new
|
|
2826
|
+
#
|
|
2827
|
+
# # Call the query_execution_inputs_and_outputs method.
|
|
2828
|
+
# result = client.query_execution_inputs_and_outputs request
|
|
2829
|
+
#
|
|
2830
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::LineageSubgraph.
|
|
2831
|
+
# p result
|
|
2832
|
+
#
|
|
2833
|
+
def query_execution_inputs_and_outputs request, options = nil
|
|
2834
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
2835
|
+
|
|
2836
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::QueryExecutionInputsAndOutputsRequest
|
|
2837
|
+
|
|
2838
|
+
# Converts hash and nil to an options object
|
|
2839
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
2840
|
+
|
|
2841
|
+
# Customize the options with defaults
|
|
2842
|
+
metadata = @config.rpcs.query_execution_inputs_and_outputs.metadata.to_h
|
|
2843
|
+
|
|
2844
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
2845
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
2846
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
2847
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
2848
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
2849
|
+
|
|
2850
|
+
header_params = {}
|
|
2851
|
+
if request.execution
|
|
2852
|
+
header_params["execution"] = request.execution
|
|
2853
|
+
end
|
|
2854
|
+
|
|
2855
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
2856
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
2857
|
+
|
|
2858
|
+
options.apply_defaults timeout: @config.rpcs.query_execution_inputs_and_outputs.timeout,
|
|
2859
|
+
metadata: metadata,
|
|
2860
|
+
retry_policy: @config.rpcs.query_execution_inputs_and_outputs.retry_policy
|
|
2861
|
+
|
|
2862
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2863
|
+
metadata: @config.metadata,
|
|
2864
|
+
retry_policy: @config.retry_policy
|
|
2865
|
+
|
|
2866
|
+
@metadata_service_stub.call_rpc :query_execution_inputs_and_outputs, request, options: options do |response, operation|
|
|
2867
|
+
yield response, operation if block_given?
|
|
2868
|
+
return response
|
|
2869
|
+
end
|
|
2870
|
+
rescue ::GRPC::BadStatus => e
|
|
2871
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
2872
|
+
end
|
|
2873
|
+
|
|
2874
|
+
##
|
|
2875
|
+
# Creates a MetadataSchema.
|
|
2876
|
+
#
|
|
2877
|
+
# @overload create_metadata_schema(request, options = nil)
|
|
2878
|
+
# Pass arguments to `create_metadata_schema` via a request object, either of type
|
|
2879
|
+
# {::Google::Cloud::AIPlatform::V1::CreateMetadataSchemaRequest} or an equivalent Hash.
|
|
2880
|
+
#
|
|
2881
|
+
# @param request [::Google::Cloud::AIPlatform::V1::CreateMetadataSchemaRequest, ::Hash]
|
|
2882
|
+
# A request object representing the call parameters. Required. To specify no
|
|
2883
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
2884
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
2885
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
2886
|
+
#
|
|
2887
|
+
# @overload create_metadata_schema(parent: nil, metadata_schema: nil, metadata_schema_id: nil)
|
|
2888
|
+
# Pass arguments to `create_metadata_schema` via keyword arguments. Note that at
|
|
2889
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2890
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2891
|
+
#
|
|
2892
|
+
# @param parent [::String]
|
|
2893
|
+
# Required. The resource name of the MetadataStore where the MetadataSchema should
|
|
2894
|
+
# be created.
|
|
2895
|
+
# Format:
|
|
2896
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
|
2897
|
+
# @param metadata_schema [::Google::Cloud::AIPlatform::V1::MetadataSchema, ::Hash]
|
|
2898
|
+
# Required. The MetadataSchema to create.
|
|
2899
|
+
# @param metadata_schema_id [::String]
|
|
2900
|
+
# The \\{metadata_schema} portion of the resource name with the format:
|
|
2901
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`
|
|
2902
|
+
# If not provided, the MetadataStore's ID will be a UUID generated by the
|
|
2903
|
+
# service.
|
|
2904
|
+
# Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
|
|
2905
|
+
# Must be unique across all MetadataSchemas in the parent Location.
|
|
2906
|
+
# (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
|
|
2907
|
+
# if the caller can't view the preexisting MetadataSchema.)
|
|
2908
|
+
#
|
|
2909
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
2910
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::MetadataSchema]
|
|
2911
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
2912
|
+
#
|
|
2913
|
+
# @return [::Google::Cloud::AIPlatform::V1::MetadataSchema]
|
|
2914
|
+
#
|
|
2915
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
2916
|
+
#
|
|
2917
|
+
# @example Basic example
|
|
2918
|
+
# require "google/cloud/ai_platform/v1"
|
|
2919
|
+
#
|
|
2920
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2921
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
2922
|
+
#
|
|
2923
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2924
|
+
# request = Google::Cloud::AIPlatform::V1::CreateMetadataSchemaRequest.new
|
|
2925
|
+
#
|
|
2926
|
+
# # Call the create_metadata_schema method.
|
|
2927
|
+
# result = client.create_metadata_schema request
|
|
2928
|
+
#
|
|
2929
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::MetadataSchema.
|
|
2930
|
+
# p result
|
|
2931
|
+
#
|
|
2932
|
+
def create_metadata_schema request, options = nil
|
|
2933
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
2934
|
+
|
|
2935
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateMetadataSchemaRequest
|
|
2936
|
+
|
|
2937
|
+
# Converts hash and nil to an options object
|
|
2938
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
2939
|
+
|
|
2940
|
+
# Customize the options with defaults
|
|
2941
|
+
metadata = @config.rpcs.create_metadata_schema.metadata.to_h
|
|
2942
|
+
|
|
2943
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
2944
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
2945
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
2946
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
2947
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
2948
|
+
|
|
2949
|
+
header_params = {}
|
|
2950
|
+
if request.parent
|
|
2951
|
+
header_params["parent"] = request.parent
|
|
2952
|
+
end
|
|
2953
|
+
|
|
2954
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
2955
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
2956
|
+
|
|
2957
|
+
options.apply_defaults timeout: @config.rpcs.create_metadata_schema.timeout,
|
|
2958
|
+
metadata: metadata,
|
|
2959
|
+
retry_policy: @config.rpcs.create_metadata_schema.retry_policy
|
|
2960
|
+
|
|
2961
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2962
|
+
metadata: @config.metadata,
|
|
2963
|
+
retry_policy: @config.retry_policy
|
|
2964
|
+
|
|
2965
|
+
@metadata_service_stub.call_rpc :create_metadata_schema, request, options: options do |response, operation|
|
|
2966
|
+
yield response, operation if block_given?
|
|
2967
|
+
return response
|
|
2968
|
+
end
|
|
2969
|
+
rescue ::GRPC::BadStatus => e
|
|
2970
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
2971
|
+
end
|
|
2972
|
+
|
|
2973
|
+
##
|
|
2974
|
+
# Retrieves a specific MetadataSchema.
|
|
2975
|
+
#
|
|
2976
|
+
# @overload get_metadata_schema(request, options = nil)
|
|
2977
|
+
# Pass arguments to `get_metadata_schema` via a request object, either of type
|
|
2978
|
+
# {::Google::Cloud::AIPlatform::V1::GetMetadataSchemaRequest} or an equivalent Hash.
|
|
2979
|
+
#
|
|
2980
|
+
# @param request [::Google::Cloud::AIPlatform::V1::GetMetadataSchemaRequest, ::Hash]
|
|
2981
|
+
# A request object representing the call parameters. Required. To specify no
|
|
2982
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
2983
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
2984
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
2985
|
+
#
|
|
2986
|
+
# @overload get_metadata_schema(name: nil)
|
|
2987
|
+
# Pass arguments to `get_metadata_schema` via keyword arguments. Note that at
|
|
2988
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2989
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2990
|
+
#
|
|
2991
|
+
# @param name [::String]
|
|
2992
|
+
# Required. The resource name of the MetadataSchema to retrieve.
|
|
2993
|
+
# Format:
|
|
2994
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`
|
|
2995
|
+
#
|
|
2996
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
2997
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::MetadataSchema]
|
|
2998
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
2999
|
+
#
|
|
3000
|
+
# @return [::Google::Cloud::AIPlatform::V1::MetadataSchema]
|
|
3001
|
+
#
|
|
3002
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
3003
|
+
#
|
|
3004
|
+
# @example Basic example
|
|
3005
|
+
# require "google/cloud/ai_platform/v1"
|
|
3006
|
+
#
|
|
3007
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
3008
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
3009
|
+
#
|
|
3010
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
3011
|
+
# request = Google::Cloud::AIPlatform::V1::GetMetadataSchemaRequest.new
|
|
3012
|
+
#
|
|
3013
|
+
# # Call the get_metadata_schema method.
|
|
3014
|
+
# result = client.get_metadata_schema request
|
|
3015
|
+
#
|
|
3016
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::MetadataSchema.
|
|
3017
|
+
# p result
|
|
3018
|
+
#
|
|
3019
|
+
def get_metadata_schema request, options = nil
|
|
3020
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3021
|
+
|
|
3022
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetMetadataSchemaRequest
|
|
3023
|
+
|
|
3024
|
+
# Converts hash and nil to an options object
|
|
3025
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3026
|
+
|
|
3027
|
+
# Customize the options with defaults
|
|
3028
|
+
metadata = @config.rpcs.get_metadata_schema.metadata.to_h
|
|
3029
|
+
|
|
3030
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3031
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3032
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3033
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
3034
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3035
|
+
|
|
3036
|
+
header_params = {}
|
|
3037
|
+
if request.name
|
|
3038
|
+
header_params["name"] = request.name
|
|
3039
|
+
end
|
|
3040
|
+
|
|
3041
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
3042
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
3043
|
+
|
|
3044
|
+
options.apply_defaults timeout: @config.rpcs.get_metadata_schema.timeout,
|
|
3045
|
+
metadata: metadata,
|
|
3046
|
+
retry_policy: @config.rpcs.get_metadata_schema.retry_policy
|
|
3047
|
+
|
|
3048
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3049
|
+
metadata: @config.metadata,
|
|
3050
|
+
retry_policy: @config.retry_policy
|
|
3051
|
+
|
|
3052
|
+
@metadata_service_stub.call_rpc :get_metadata_schema, request, options: options do |response, operation|
|
|
3053
|
+
yield response, operation if block_given?
|
|
3054
|
+
return response
|
|
3055
|
+
end
|
|
3056
|
+
rescue ::GRPC::BadStatus => e
|
|
3057
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3058
|
+
end
|
|
3059
|
+
|
|
3060
|
+
##
|
|
3061
|
+
# Lists MetadataSchemas.
|
|
3062
|
+
#
|
|
3063
|
+
# @overload list_metadata_schemas(request, options = nil)
|
|
3064
|
+
# Pass arguments to `list_metadata_schemas` via a request object, either of type
|
|
3065
|
+
# {::Google::Cloud::AIPlatform::V1::ListMetadataSchemasRequest} or an equivalent Hash.
|
|
3066
|
+
#
|
|
3067
|
+
# @param request [::Google::Cloud::AIPlatform::V1::ListMetadataSchemasRequest, ::Hash]
|
|
3068
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3069
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3070
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3071
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
3072
|
+
#
|
|
3073
|
+
# @overload list_metadata_schemas(parent: nil, page_size: nil, page_token: nil, filter: nil)
|
|
3074
|
+
# Pass arguments to `list_metadata_schemas` via keyword arguments. Note that at
|
|
3075
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3076
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3077
|
+
#
|
|
3078
|
+
# @param parent [::String]
|
|
3079
|
+
# Required. The MetadataStore whose MetadataSchemas should be listed.
|
|
3080
|
+
# Format:
|
|
3081
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
|
|
3082
|
+
# @param page_size [::Integer]
|
|
3083
|
+
# The maximum number of MetadataSchemas to return. The service may return
|
|
3084
|
+
# fewer.
|
|
3085
|
+
# Must be in range 1-1000, inclusive. Defaults to 100.
|
|
3086
|
+
# @param page_token [::String]
|
|
3087
|
+
# A page token, received from a previous
|
|
3088
|
+
# {::Google::Cloud::AIPlatform::V1::MetadataService::Client#list_metadata_schemas MetadataService.ListMetadataSchemas} call. Provide this to retrieve the
|
|
3089
|
+
# next page.
|
|
3090
|
+
#
|
|
3091
|
+
# When paginating, all other provided parameters must match the call that
|
|
3092
|
+
# provided the page token. (Otherwise the request will fail with
|
|
3093
|
+
# INVALID_ARGUMENT error.)
|
|
3094
|
+
# @param filter [::String]
|
|
3095
|
+
# A query to filter available MetadataSchemas for matching results.
|
|
3096
|
+
#
|
|
3097
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
3098
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::MetadataSchema>]
|
|
3099
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
3100
|
+
#
|
|
3101
|
+
# @return [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::MetadataSchema>]
|
|
3102
|
+
#
|
|
3103
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
3104
|
+
#
|
|
3105
|
+
# @example Basic example
|
|
3106
|
+
# require "google/cloud/ai_platform/v1"
|
|
3107
|
+
#
|
|
3108
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
3109
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
3110
|
+
#
|
|
3111
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
3112
|
+
# request = Google::Cloud::AIPlatform::V1::ListMetadataSchemasRequest.new
|
|
3113
|
+
#
|
|
3114
|
+
# # Call the list_metadata_schemas method.
|
|
3115
|
+
# result = client.list_metadata_schemas request
|
|
3116
|
+
#
|
|
3117
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
|
3118
|
+
# # iterate over all elements by calling #each, and the enumerable
|
|
3119
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
|
3120
|
+
# # methods are also available for managing paging directly.
|
|
3121
|
+
# result.each do |response|
|
|
3122
|
+
# # Each element is of type ::Google::Cloud::AIPlatform::V1::MetadataSchema.
|
|
3123
|
+
# p response
|
|
3124
|
+
# end
|
|
3125
|
+
#
|
|
3126
|
+
def list_metadata_schemas request, options = nil
|
|
3127
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3128
|
+
|
|
3129
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListMetadataSchemasRequest
|
|
3130
|
+
|
|
3131
|
+
# Converts hash and nil to an options object
|
|
3132
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3133
|
+
|
|
3134
|
+
# Customize the options with defaults
|
|
3135
|
+
metadata = @config.rpcs.list_metadata_schemas.metadata.to_h
|
|
3136
|
+
|
|
3137
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3138
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3139
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3140
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
3141
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3142
|
+
|
|
3143
|
+
header_params = {}
|
|
3144
|
+
if request.parent
|
|
3145
|
+
header_params["parent"] = request.parent
|
|
3146
|
+
end
|
|
3147
|
+
|
|
3148
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
3149
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
3150
|
+
|
|
3151
|
+
options.apply_defaults timeout: @config.rpcs.list_metadata_schemas.timeout,
|
|
3152
|
+
metadata: metadata,
|
|
3153
|
+
retry_policy: @config.rpcs.list_metadata_schemas.retry_policy
|
|
3154
|
+
|
|
3155
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3156
|
+
metadata: @config.metadata,
|
|
3157
|
+
retry_policy: @config.retry_policy
|
|
3158
|
+
|
|
3159
|
+
@metadata_service_stub.call_rpc :list_metadata_schemas, request, options: options do |response, operation|
|
|
3160
|
+
response = ::Gapic::PagedEnumerable.new @metadata_service_stub, :list_metadata_schemas, request, response, operation, options
|
|
3161
|
+
yield response, operation if block_given?
|
|
3162
|
+
return response
|
|
3163
|
+
end
|
|
3164
|
+
rescue ::GRPC::BadStatus => e
|
|
3165
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3166
|
+
end
|
|
3167
|
+
|
|
3168
|
+
##
|
|
3169
|
+
# Retrieves lineage of an Artifact represented through Artifacts and
|
|
3170
|
+
# Executions connected by Event edges and returned as a LineageSubgraph.
|
|
3171
|
+
#
|
|
3172
|
+
# @overload query_artifact_lineage_subgraph(request, options = nil)
|
|
3173
|
+
# Pass arguments to `query_artifact_lineage_subgraph` via a request object, either of type
|
|
3174
|
+
# {::Google::Cloud::AIPlatform::V1::QueryArtifactLineageSubgraphRequest} or an equivalent Hash.
|
|
3175
|
+
#
|
|
3176
|
+
# @param request [::Google::Cloud::AIPlatform::V1::QueryArtifactLineageSubgraphRequest, ::Hash]
|
|
3177
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3178
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3179
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3180
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
3181
|
+
#
|
|
3182
|
+
# @overload query_artifact_lineage_subgraph(artifact: nil, max_hops: nil, filter: nil)
|
|
3183
|
+
# Pass arguments to `query_artifact_lineage_subgraph` via keyword arguments. Note that at
|
|
3184
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3185
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3186
|
+
#
|
|
3187
|
+
# @param artifact [::String]
|
|
3188
|
+
# Required. The resource name of the Artifact whose Lineage needs to be retrieved as a
|
|
3189
|
+
# LineageSubgraph.
|
|
3190
|
+
# Format:
|
|
3191
|
+
# `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
|
|
3192
|
+
#
|
|
3193
|
+
# The request may error with FAILED_PRECONDITION if the number of Artifacts,
|
|
3194
|
+
# the number of Executions, or the number of Events that would be returned
|
|
3195
|
+
# for the Context exceeds 1000.
|
|
3196
|
+
# @param max_hops [::Integer]
|
|
3197
|
+
# Specifies the size of the lineage graph in terms of number of hops from the
|
|
3198
|
+
# specified artifact.
|
|
3199
|
+
# Negative Value: INVALID_ARGUMENT error is returned
|
|
3200
|
+
# 0: Only input artifact is returned.
|
|
3201
|
+
# No value: Transitive closure is performed to return the complete graph.
|
|
3202
|
+
# @param filter [::String]
|
|
3203
|
+
# Filter specifying the boolean condition for the Artifacts to satisfy in
|
|
3204
|
+
# order to be part of the Lineage Subgraph.
|
|
3205
|
+
# The syntax to define filter query is based on https://google.aip.dev/160.
|
|
3206
|
+
# The supported set of filters include the following:
|
|
3207
|
+
#
|
|
3208
|
+
# * **Attribute filtering**:
|
|
3209
|
+
# For example: `display_name = "test"`
|
|
3210
|
+
# Supported fields include: `name`, `display_name`, `uri`, `state`,
|
|
3211
|
+
# `schema_title`, `create_time`, and `update_time`.
|
|
3212
|
+
# Time fields, such as `create_time` and `update_time`, require values
|
|
3213
|
+
# specified in RFC-3339 format.
|
|
3214
|
+
# For example: `create_time = "2020-11-19T11:30:00-04:00"`
|
|
3215
|
+
# * **Metadata field**:
|
|
3216
|
+
# To filter on metadata fields use traversal operation as follows:
|
|
3217
|
+
# `metadata.<field_name>.<type_value>`.
|
|
3218
|
+
# For example: `metadata.field_1.number_value = 10.0`
|
|
3219
|
+
#
|
|
3220
|
+
# Each of the above supported filter types can be combined together using
|
|
3221
|
+
# logical operators (`AND` & `OR`).
|
|
3222
|
+
#
|
|
3223
|
+
# For example: `display_name = "test" AND metadata.field1.bool_value = true`.
|
|
3224
|
+
#
|
|
3225
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
3226
|
+
# @yieldparam response [::Google::Cloud::AIPlatform::V1::LineageSubgraph]
|
|
3227
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
3228
|
+
#
|
|
3229
|
+
# @return [::Google::Cloud::AIPlatform::V1::LineageSubgraph]
|
|
3230
|
+
#
|
|
3231
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
3232
|
+
#
|
|
3233
|
+
# @example Basic example
|
|
3234
|
+
# require "google/cloud/ai_platform/v1"
|
|
3235
|
+
#
|
|
3236
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
3237
|
+
# client = Google::Cloud::AIPlatform::V1::MetadataService::Client.new
|
|
3238
|
+
#
|
|
3239
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
3240
|
+
# request = Google::Cloud::AIPlatform::V1::QueryArtifactLineageSubgraphRequest.new
|
|
3241
|
+
#
|
|
3242
|
+
# # Call the query_artifact_lineage_subgraph method.
|
|
3243
|
+
# result = client.query_artifact_lineage_subgraph request
|
|
3244
|
+
#
|
|
3245
|
+
# # The returned object is of type Google::Cloud::AIPlatform::V1::LineageSubgraph.
|
|
3246
|
+
# p result
|
|
3247
|
+
#
|
|
3248
|
+
def query_artifact_lineage_subgraph request, options = nil
|
|
3249
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3250
|
+
|
|
3251
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::QueryArtifactLineageSubgraphRequest
|
|
3252
|
+
|
|
3253
|
+
# Converts hash and nil to an options object
|
|
3254
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3255
|
+
|
|
3256
|
+
# Customize the options with defaults
|
|
3257
|
+
metadata = @config.rpcs.query_artifact_lineage_subgraph.metadata.to_h
|
|
3258
|
+
|
|
3259
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3260
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3261
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3262
|
+
gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
|
|
3263
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3264
|
+
|
|
3265
|
+
header_params = {}
|
|
3266
|
+
if request.artifact
|
|
3267
|
+
header_params["artifact"] = request.artifact
|
|
3268
|
+
end
|
|
3269
|
+
|
|
3270
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
|
3271
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
|
3272
|
+
|
|
3273
|
+
options.apply_defaults timeout: @config.rpcs.query_artifact_lineage_subgraph.timeout,
|
|
3274
|
+
metadata: metadata,
|
|
3275
|
+
retry_policy: @config.rpcs.query_artifact_lineage_subgraph.retry_policy
|
|
3276
|
+
|
|
3277
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3278
|
+
metadata: @config.metadata,
|
|
3279
|
+
retry_policy: @config.retry_policy
|
|
3280
|
+
|
|
3281
|
+
@metadata_service_stub.call_rpc :query_artifact_lineage_subgraph, request, options: options do |response, operation|
|
|
3282
|
+
yield response, operation if block_given?
|
|
3283
|
+
return response
|
|
3284
|
+
end
|
|
3285
|
+
rescue ::GRPC::BadStatus => e
|
|
3286
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3287
|
+
end
|
|
3288
|
+
|
|
3289
|
+
##
|
|
3290
|
+
# Configuration class for the MetadataService API.
|
|
3291
|
+
#
|
|
3292
|
+
# This class represents the configuration for MetadataService,
|
|
3293
|
+
# providing control over timeouts, retry behavior, logging, transport
|
|
3294
|
+
# parameters, and other low-level controls. Certain parameters can also be
|
|
3295
|
+
# applied individually to specific RPCs. See
|
|
3296
|
+
# {::Google::Cloud::AIPlatform::V1::MetadataService::Client::Configuration::Rpcs}
|
|
3297
|
+
# for a list of RPCs that can be configured independently.
|
|
3298
|
+
#
|
|
3299
|
+
# Configuration can be applied globally to all clients, or to a single client
|
|
3300
|
+
# on construction.
|
|
3301
|
+
#
|
|
3302
|
+
# @example
|
|
3303
|
+
#
|
|
3304
|
+
# # Modify the global config, setting the timeout for
|
|
3305
|
+
# # create_metadata_store to 20 seconds,
|
|
3306
|
+
# # and all remaining timeouts to 10 seconds.
|
|
3307
|
+
# ::Google::Cloud::AIPlatform::V1::MetadataService::Client.configure do |config|
|
|
3308
|
+
# config.timeout = 10.0
|
|
3309
|
+
# config.rpcs.create_metadata_store.timeout = 20.0
|
|
3310
|
+
# end
|
|
3311
|
+
#
|
|
3312
|
+
# # Apply the above configuration only to a new client.
|
|
3313
|
+
# client = ::Google::Cloud::AIPlatform::V1::MetadataService::Client.new do |config|
|
|
3314
|
+
# config.timeout = 10.0
|
|
3315
|
+
# config.rpcs.create_metadata_store.timeout = 20.0
|
|
3316
|
+
# end
|
|
3317
|
+
#
|
|
3318
|
+
# @!attribute [rw] endpoint
|
|
3319
|
+
# The hostname or hostname:port of the service endpoint.
|
|
3320
|
+
# Defaults to `"aiplatform.googleapis.com"`.
|
|
3321
|
+
# @return [::String]
|
|
3322
|
+
# @!attribute [rw] credentials
|
|
3323
|
+
# Credentials to send with calls. You may provide any of the following types:
|
|
3324
|
+
# * (`String`) The path to a service account key file in JSON format
|
|
3325
|
+
# * (`Hash`) A service account key as a Hash
|
|
3326
|
+
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
|
3327
|
+
# (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
|
|
3328
|
+
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
|
3329
|
+
# (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
|
|
3330
|
+
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
|
3331
|
+
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
|
3332
|
+
# * (`nil`) indicating no credentials
|
|
3333
|
+
# @return [::Object]
|
|
3334
|
+
# @!attribute [rw] scope
|
|
3335
|
+
# The OAuth scopes
|
|
3336
|
+
# @return [::Array<::String>]
|
|
3337
|
+
# @!attribute [rw] lib_name
|
|
3338
|
+
# The library name as recorded in instrumentation and logging
|
|
3339
|
+
# @return [::String]
|
|
3340
|
+
# @!attribute [rw] lib_version
|
|
3341
|
+
# The library version as recorded in instrumentation and logging
|
|
3342
|
+
# @return [::String]
|
|
3343
|
+
# @!attribute [rw] channel_args
|
|
3344
|
+
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
|
|
3345
|
+
# `GRPC::Core::Channel` object is provided as the credential.
|
|
3346
|
+
# @return [::Hash]
|
|
3347
|
+
# @!attribute [rw] interceptors
|
|
3348
|
+
# An array of interceptors that are run before calls are executed.
|
|
3349
|
+
# @return [::Array<::GRPC::ClientInterceptor>]
|
|
3350
|
+
# @!attribute [rw] timeout
|
|
3351
|
+
# The call timeout in seconds.
|
|
3352
|
+
# @return [::Numeric]
|
|
3353
|
+
# @!attribute [rw] metadata
|
|
3354
|
+
# Additional gRPC headers to be sent with the call.
|
|
3355
|
+
# @return [::Hash{::Symbol=>::String}]
|
|
3356
|
+
# @!attribute [rw] retry_policy
|
|
3357
|
+
# The retry policy. The value is a hash with the following keys:
|
|
3358
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
3359
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
3360
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
3361
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
3362
|
+
# trigger a retry.
|
|
3363
|
+
# @return [::Hash]
|
|
3364
|
+
# @!attribute [rw] quota_project
|
|
3365
|
+
# A separate project against which to charge quota.
|
|
3366
|
+
# @return [::String]
|
|
3367
|
+
#
|
|
3368
|
+
class Configuration
|
|
3369
|
+
extend ::Gapic::Config
|
|
3370
|
+
|
|
3371
|
+
config_attr :endpoint, "aiplatform.googleapis.com", ::String
|
|
3372
|
+
config_attr :credentials, nil do |value|
|
|
3373
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
3374
|
+
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
3375
|
+
allowed.any? { |klass| klass === value }
|
|
3376
|
+
end
|
|
3377
|
+
config_attr :scope, nil, ::String, ::Array, nil
|
|
3378
|
+
config_attr :lib_name, nil, ::String, nil
|
|
3379
|
+
config_attr :lib_version, nil, ::String, nil
|
|
3380
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
|
3381
|
+
config_attr :interceptors, nil, ::Array, nil
|
|
3382
|
+
config_attr :timeout, nil, ::Numeric, nil
|
|
3383
|
+
config_attr :metadata, nil, ::Hash, nil
|
|
3384
|
+
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
3385
|
+
config_attr :quota_project, nil, ::String, nil
|
|
3386
|
+
|
|
3387
|
+
# @private
|
|
3388
|
+
def initialize parent_config = nil
|
|
3389
|
+
@parent_config = parent_config unless parent_config.nil?
|
|
3390
|
+
|
|
3391
|
+
yield self if block_given?
|
|
3392
|
+
end
|
|
3393
|
+
|
|
3394
|
+
##
|
|
3395
|
+
# Configurations for individual RPCs
|
|
3396
|
+
# @return [Rpcs]
|
|
3397
|
+
#
|
|
3398
|
+
def rpcs
|
|
3399
|
+
@rpcs ||= begin
|
|
3400
|
+
parent_rpcs = nil
|
|
3401
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
|
3402
|
+
Rpcs.new parent_rpcs
|
|
3403
|
+
end
|
|
3404
|
+
end
|
|
3405
|
+
|
|
3406
|
+
##
|
|
3407
|
+
# Configuration RPC class for the MetadataService API.
|
|
3408
|
+
#
|
|
3409
|
+
# Includes fields providing the configuration for each RPC in this service.
|
|
3410
|
+
# Each configuration object is of type `Gapic::Config::Method` and includes
|
|
3411
|
+
# the following configuration fields:
|
|
3412
|
+
#
|
|
3413
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
|
3414
|
+
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
|
3415
|
+
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
|
3416
|
+
# include the following keys:
|
|
3417
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
3418
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
3419
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
3420
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
3421
|
+
# trigger a retry.
|
|
3422
|
+
#
|
|
3423
|
+
class Rpcs
|
|
3424
|
+
##
|
|
3425
|
+
# RPC-specific configuration for `create_metadata_store`
|
|
3426
|
+
# @return [::Gapic::Config::Method]
|
|
3427
|
+
#
|
|
3428
|
+
attr_reader :create_metadata_store
|
|
3429
|
+
##
|
|
3430
|
+
# RPC-specific configuration for `get_metadata_store`
|
|
3431
|
+
# @return [::Gapic::Config::Method]
|
|
3432
|
+
#
|
|
3433
|
+
attr_reader :get_metadata_store
|
|
3434
|
+
##
|
|
3435
|
+
# RPC-specific configuration for `list_metadata_stores`
|
|
3436
|
+
# @return [::Gapic::Config::Method]
|
|
3437
|
+
#
|
|
3438
|
+
attr_reader :list_metadata_stores
|
|
3439
|
+
##
|
|
3440
|
+
# RPC-specific configuration for `delete_metadata_store`
|
|
3441
|
+
# @return [::Gapic::Config::Method]
|
|
3442
|
+
#
|
|
3443
|
+
attr_reader :delete_metadata_store
|
|
3444
|
+
##
|
|
3445
|
+
# RPC-specific configuration for `create_artifact`
|
|
3446
|
+
# @return [::Gapic::Config::Method]
|
|
3447
|
+
#
|
|
3448
|
+
attr_reader :create_artifact
|
|
3449
|
+
##
|
|
3450
|
+
# RPC-specific configuration for `get_artifact`
|
|
3451
|
+
# @return [::Gapic::Config::Method]
|
|
3452
|
+
#
|
|
3453
|
+
attr_reader :get_artifact
|
|
3454
|
+
##
|
|
3455
|
+
# RPC-specific configuration for `list_artifacts`
|
|
3456
|
+
# @return [::Gapic::Config::Method]
|
|
3457
|
+
#
|
|
3458
|
+
attr_reader :list_artifacts
|
|
3459
|
+
##
|
|
3460
|
+
# RPC-specific configuration for `update_artifact`
|
|
3461
|
+
# @return [::Gapic::Config::Method]
|
|
3462
|
+
#
|
|
3463
|
+
attr_reader :update_artifact
|
|
3464
|
+
##
|
|
3465
|
+
# RPC-specific configuration for `delete_artifact`
|
|
3466
|
+
# @return [::Gapic::Config::Method]
|
|
3467
|
+
#
|
|
3468
|
+
attr_reader :delete_artifact
|
|
3469
|
+
##
|
|
3470
|
+
# RPC-specific configuration for `purge_artifacts`
|
|
3471
|
+
# @return [::Gapic::Config::Method]
|
|
3472
|
+
#
|
|
3473
|
+
attr_reader :purge_artifacts
|
|
3474
|
+
##
|
|
3475
|
+
# RPC-specific configuration for `create_context`
|
|
3476
|
+
# @return [::Gapic::Config::Method]
|
|
3477
|
+
#
|
|
3478
|
+
attr_reader :create_context
|
|
3479
|
+
##
|
|
3480
|
+
# RPC-specific configuration for `get_context`
|
|
3481
|
+
# @return [::Gapic::Config::Method]
|
|
3482
|
+
#
|
|
3483
|
+
attr_reader :get_context
|
|
3484
|
+
##
|
|
3485
|
+
# RPC-specific configuration for `list_contexts`
|
|
3486
|
+
# @return [::Gapic::Config::Method]
|
|
3487
|
+
#
|
|
3488
|
+
attr_reader :list_contexts
|
|
3489
|
+
##
|
|
3490
|
+
# RPC-specific configuration for `update_context`
|
|
3491
|
+
# @return [::Gapic::Config::Method]
|
|
3492
|
+
#
|
|
3493
|
+
attr_reader :update_context
|
|
3494
|
+
##
|
|
3495
|
+
# RPC-specific configuration for `delete_context`
|
|
3496
|
+
# @return [::Gapic::Config::Method]
|
|
3497
|
+
#
|
|
3498
|
+
attr_reader :delete_context
|
|
3499
|
+
##
|
|
3500
|
+
# RPC-specific configuration for `purge_contexts`
|
|
3501
|
+
# @return [::Gapic::Config::Method]
|
|
3502
|
+
#
|
|
3503
|
+
attr_reader :purge_contexts
|
|
3504
|
+
##
|
|
3505
|
+
# RPC-specific configuration for `add_context_artifacts_and_executions`
|
|
3506
|
+
# @return [::Gapic::Config::Method]
|
|
3507
|
+
#
|
|
3508
|
+
attr_reader :add_context_artifacts_and_executions
|
|
3509
|
+
##
|
|
3510
|
+
# RPC-specific configuration for `add_context_children`
|
|
3511
|
+
# @return [::Gapic::Config::Method]
|
|
3512
|
+
#
|
|
3513
|
+
attr_reader :add_context_children
|
|
3514
|
+
##
|
|
3515
|
+
# RPC-specific configuration for `query_context_lineage_subgraph`
|
|
3516
|
+
# @return [::Gapic::Config::Method]
|
|
3517
|
+
#
|
|
3518
|
+
attr_reader :query_context_lineage_subgraph
|
|
3519
|
+
##
|
|
3520
|
+
# RPC-specific configuration for `create_execution`
|
|
3521
|
+
# @return [::Gapic::Config::Method]
|
|
3522
|
+
#
|
|
3523
|
+
attr_reader :create_execution
|
|
3524
|
+
##
|
|
3525
|
+
# RPC-specific configuration for `get_execution`
|
|
3526
|
+
# @return [::Gapic::Config::Method]
|
|
3527
|
+
#
|
|
3528
|
+
attr_reader :get_execution
|
|
3529
|
+
##
|
|
3530
|
+
# RPC-specific configuration for `list_executions`
|
|
3531
|
+
# @return [::Gapic::Config::Method]
|
|
3532
|
+
#
|
|
3533
|
+
attr_reader :list_executions
|
|
3534
|
+
##
|
|
3535
|
+
# RPC-specific configuration for `update_execution`
|
|
3536
|
+
# @return [::Gapic::Config::Method]
|
|
3537
|
+
#
|
|
3538
|
+
attr_reader :update_execution
|
|
3539
|
+
##
|
|
3540
|
+
# RPC-specific configuration for `delete_execution`
|
|
3541
|
+
# @return [::Gapic::Config::Method]
|
|
3542
|
+
#
|
|
3543
|
+
attr_reader :delete_execution
|
|
3544
|
+
##
|
|
3545
|
+
# RPC-specific configuration for `purge_executions`
|
|
3546
|
+
# @return [::Gapic::Config::Method]
|
|
3547
|
+
#
|
|
3548
|
+
attr_reader :purge_executions
|
|
3549
|
+
##
|
|
3550
|
+
# RPC-specific configuration for `add_execution_events`
|
|
3551
|
+
# @return [::Gapic::Config::Method]
|
|
3552
|
+
#
|
|
3553
|
+
attr_reader :add_execution_events
|
|
3554
|
+
##
|
|
3555
|
+
# RPC-specific configuration for `query_execution_inputs_and_outputs`
|
|
3556
|
+
# @return [::Gapic::Config::Method]
|
|
3557
|
+
#
|
|
3558
|
+
attr_reader :query_execution_inputs_and_outputs
|
|
3559
|
+
##
|
|
3560
|
+
# RPC-specific configuration for `create_metadata_schema`
|
|
3561
|
+
# @return [::Gapic::Config::Method]
|
|
3562
|
+
#
|
|
3563
|
+
attr_reader :create_metadata_schema
|
|
3564
|
+
##
|
|
3565
|
+
# RPC-specific configuration for `get_metadata_schema`
|
|
3566
|
+
# @return [::Gapic::Config::Method]
|
|
3567
|
+
#
|
|
3568
|
+
attr_reader :get_metadata_schema
|
|
3569
|
+
##
|
|
3570
|
+
# RPC-specific configuration for `list_metadata_schemas`
|
|
3571
|
+
# @return [::Gapic::Config::Method]
|
|
3572
|
+
#
|
|
3573
|
+
attr_reader :list_metadata_schemas
|
|
3574
|
+
##
|
|
3575
|
+
# RPC-specific configuration for `query_artifact_lineage_subgraph`
|
|
3576
|
+
# @return [::Gapic::Config::Method]
|
|
3577
|
+
#
|
|
3578
|
+
attr_reader :query_artifact_lineage_subgraph
|
|
3579
|
+
|
|
3580
|
+
# @private
|
|
3581
|
+
def initialize parent_rpcs = nil
|
|
3582
|
+
create_metadata_store_config = parent_rpcs.create_metadata_store if parent_rpcs.respond_to? :create_metadata_store
|
|
3583
|
+
@create_metadata_store = ::Gapic::Config::Method.new create_metadata_store_config
|
|
3584
|
+
get_metadata_store_config = parent_rpcs.get_metadata_store if parent_rpcs.respond_to? :get_metadata_store
|
|
3585
|
+
@get_metadata_store = ::Gapic::Config::Method.new get_metadata_store_config
|
|
3586
|
+
list_metadata_stores_config = parent_rpcs.list_metadata_stores if parent_rpcs.respond_to? :list_metadata_stores
|
|
3587
|
+
@list_metadata_stores = ::Gapic::Config::Method.new list_metadata_stores_config
|
|
3588
|
+
delete_metadata_store_config = parent_rpcs.delete_metadata_store if parent_rpcs.respond_to? :delete_metadata_store
|
|
3589
|
+
@delete_metadata_store = ::Gapic::Config::Method.new delete_metadata_store_config
|
|
3590
|
+
create_artifact_config = parent_rpcs.create_artifact if parent_rpcs.respond_to? :create_artifact
|
|
3591
|
+
@create_artifact = ::Gapic::Config::Method.new create_artifact_config
|
|
3592
|
+
get_artifact_config = parent_rpcs.get_artifact if parent_rpcs.respond_to? :get_artifact
|
|
3593
|
+
@get_artifact = ::Gapic::Config::Method.new get_artifact_config
|
|
3594
|
+
list_artifacts_config = parent_rpcs.list_artifacts if parent_rpcs.respond_to? :list_artifacts
|
|
3595
|
+
@list_artifacts = ::Gapic::Config::Method.new list_artifacts_config
|
|
3596
|
+
update_artifact_config = parent_rpcs.update_artifact if parent_rpcs.respond_to? :update_artifact
|
|
3597
|
+
@update_artifact = ::Gapic::Config::Method.new update_artifact_config
|
|
3598
|
+
delete_artifact_config = parent_rpcs.delete_artifact if parent_rpcs.respond_to? :delete_artifact
|
|
3599
|
+
@delete_artifact = ::Gapic::Config::Method.new delete_artifact_config
|
|
3600
|
+
purge_artifacts_config = parent_rpcs.purge_artifacts if parent_rpcs.respond_to? :purge_artifacts
|
|
3601
|
+
@purge_artifacts = ::Gapic::Config::Method.new purge_artifacts_config
|
|
3602
|
+
create_context_config = parent_rpcs.create_context if parent_rpcs.respond_to? :create_context
|
|
3603
|
+
@create_context = ::Gapic::Config::Method.new create_context_config
|
|
3604
|
+
get_context_config = parent_rpcs.get_context if parent_rpcs.respond_to? :get_context
|
|
3605
|
+
@get_context = ::Gapic::Config::Method.new get_context_config
|
|
3606
|
+
list_contexts_config = parent_rpcs.list_contexts if parent_rpcs.respond_to? :list_contexts
|
|
3607
|
+
@list_contexts = ::Gapic::Config::Method.new list_contexts_config
|
|
3608
|
+
update_context_config = parent_rpcs.update_context if parent_rpcs.respond_to? :update_context
|
|
3609
|
+
@update_context = ::Gapic::Config::Method.new update_context_config
|
|
3610
|
+
delete_context_config = parent_rpcs.delete_context if parent_rpcs.respond_to? :delete_context
|
|
3611
|
+
@delete_context = ::Gapic::Config::Method.new delete_context_config
|
|
3612
|
+
purge_contexts_config = parent_rpcs.purge_contexts if parent_rpcs.respond_to? :purge_contexts
|
|
3613
|
+
@purge_contexts = ::Gapic::Config::Method.new purge_contexts_config
|
|
3614
|
+
add_context_artifacts_and_executions_config = parent_rpcs.add_context_artifacts_and_executions if parent_rpcs.respond_to? :add_context_artifacts_and_executions
|
|
3615
|
+
@add_context_artifacts_and_executions = ::Gapic::Config::Method.new add_context_artifacts_and_executions_config
|
|
3616
|
+
add_context_children_config = parent_rpcs.add_context_children if parent_rpcs.respond_to? :add_context_children
|
|
3617
|
+
@add_context_children = ::Gapic::Config::Method.new add_context_children_config
|
|
3618
|
+
query_context_lineage_subgraph_config = parent_rpcs.query_context_lineage_subgraph if parent_rpcs.respond_to? :query_context_lineage_subgraph
|
|
3619
|
+
@query_context_lineage_subgraph = ::Gapic::Config::Method.new query_context_lineage_subgraph_config
|
|
3620
|
+
create_execution_config = parent_rpcs.create_execution if parent_rpcs.respond_to? :create_execution
|
|
3621
|
+
@create_execution = ::Gapic::Config::Method.new create_execution_config
|
|
3622
|
+
get_execution_config = parent_rpcs.get_execution if parent_rpcs.respond_to? :get_execution
|
|
3623
|
+
@get_execution = ::Gapic::Config::Method.new get_execution_config
|
|
3624
|
+
list_executions_config = parent_rpcs.list_executions if parent_rpcs.respond_to? :list_executions
|
|
3625
|
+
@list_executions = ::Gapic::Config::Method.new list_executions_config
|
|
3626
|
+
update_execution_config = parent_rpcs.update_execution if parent_rpcs.respond_to? :update_execution
|
|
3627
|
+
@update_execution = ::Gapic::Config::Method.new update_execution_config
|
|
3628
|
+
delete_execution_config = parent_rpcs.delete_execution if parent_rpcs.respond_to? :delete_execution
|
|
3629
|
+
@delete_execution = ::Gapic::Config::Method.new delete_execution_config
|
|
3630
|
+
purge_executions_config = parent_rpcs.purge_executions if parent_rpcs.respond_to? :purge_executions
|
|
3631
|
+
@purge_executions = ::Gapic::Config::Method.new purge_executions_config
|
|
3632
|
+
add_execution_events_config = parent_rpcs.add_execution_events if parent_rpcs.respond_to? :add_execution_events
|
|
3633
|
+
@add_execution_events = ::Gapic::Config::Method.new add_execution_events_config
|
|
3634
|
+
query_execution_inputs_and_outputs_config = parent_rpcs.query_execution_inputs_and_outputs if parent_rpcs.respond_to? :query_execution_inputs_and_outputs
|
|
3635
|
+
@query_execution_inputs_and_outputs = ::Gapic::Config::Method.new query_execution_inputs_and_outputs_config
|
|
3636
|
+
create_metadata_schema_config = parent_rpcs.create_metadata_schema if parent_rpcs.respond_to? :create_metadata_schema
|
|
3637
|
+
@create_metadata_schema = ::Gapic::Config::Method.new create_metadata_schema_config
|
|
3638
|
+
get_metadata_schema_config = parent_rpcs.get_metadata_schema if parent_rpcs.respond_to? :get_metadata_schema
|
|
3639
|
+
@get_metadata_schema = ::Gapic::Config::Method.new get_metadata_schema_config
|
|
3640
|
+
list_metadata_schemas_config = parent_rpcs.list_metadata_schemas if parent_rpcs.respond_to? :list_metadata_schemas
|
|
3641
|
+
@list_metadata_schemas = ::Gapic::Config::Method.new list_metadata_schemas_config
|
|
3642
|
+
query_artifact_lineage_subgraph_config = parent_rpcs.query_artifact_lineage_subgraph if parent_rpcs.respond_to? :query_artifact_lineage_subgraph
|
|
3643
|
+
@query_artifact_lineage_subgraph = ::Gapic::Config::Method.new query_artifact_lineage_subgraph_config
|
|
3644
|
+
|
|
3645
|
+
yield self if block_given?
|
|
3646
|
+
end
|
|
3647
|
+
end
|
|
3648
|
+
end
|
|
3649
|
+
end
|
|
3650
|
+
end
|
|
3651
|
+
end
|
|
3652
|
+
end
|
|
3653
|
+
end
|
|
3654
|
+
end
|