google-cloud-ai_platform-v1 0.35.0 → 0.37.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (186) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -99
  3. data/README.md +1 -1
  4. data/lib/google/cloud/ai_platform/v1/dataset_service/client.rb +43 -17
  5. data/lib/google/cloud/ai_platform/v1/dataset_service/operations.rb +28 -6
  6. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/client.rb +896 -0
  7. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/credentials.rb +47 -0
  8. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/operations.rb +809 -0
  9. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/paths.rb +83 -0
  10. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service.rb +50 -0
  11. data/lib/google/cloud/ai_platform/v1/endpoint_service/client.rb +43 -17
  12. data/lib/google/cloud/ai_platform/v1/endpoint_service/operations.rb +28 -6
  13. data/lib/google/cloud/ai_platform/v1/endpoint_service/paths.rb +19 -0
  14. data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/client.rb +46 -18
  15. data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/operations.rb +28 -6
  16. data/lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb +146 -17
  17. data/lib/google/cloud/ai_platform/v1/feature_online_store_service.rb +2 -0
  18. data/lib/google/cloud/ai_platform/v1/feature_registry_service/client.rb +44 -18
  19. data/lib/google/cloud/ai_platform/v1/feature_registry_service/operations.rb +28 -6
  20. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb +42 -17
  21. data/lib/google/cloud/ai_platform/v1/featurestore_service/client.rb +44 -18
  22. data/lib/google/cloud/ai_platform/v1/featurestore_service/operations.rb +28 -6
  23. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/client.rb +43 -17
  24. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/operations.rb +28 -6
  25. data/lib/google/cloud/ai_platform/v1/index_service/client.rb +52 -18
  26. data/lib/google/cloud/ai_platform/v1/index_service/operations.rb +28 -6
  27. data/lib/google/cloud/ai_platform/v1/job_service/client.rb +43 -17
  28. data/lib/google/cloud/ai_platform/v1/job_service/operations.rb +28 -6
  29. data/lib/google/cloud/ai_platform/v1/llm_utility_service/client.rb +49 -18
  30. data/lib/google/cloud/ai_platform/v1/match_service/client.rb +42 -17
  31. data/lib/google/cloud/ai_platform/v1/metadata_service/client.rb +43 -17
  32. data/lib/google/cloud/ai_platform/v1/metadata_service/operations.rb +28 -6
  33. data/lib/google/cloud/ai_platform/v1/migration_service/client.rb +43 -17
  34. data/lib/google/cloud/ai_platform/v1/migration_service/operations.rb +28 -6
  35. data/lib/google/cloud/ai_platform/v1/model_garden_service/client.rb +42 -17
  36. data/lib/google/cloud/ai_platform/v1/model_service/client.rb +47 -21
  37. data/lib/google/cloud/ai_platform/v1/model_service/operations.rb +28 -6
  38. data/lib/google/cloud/ai_platform/v1/pipeline_service/client.rb +43 -17
  39. data/lib/google/cloud/ai_platform/v1/pipeline_service/operations.rb +28 -6
  40. data/lib/google/cloud/ai_platform/v1/prediction_service/client.rb +544 -20
  41. data/lib/google/cloud/ai_platform/v1/schedule_service/client.rb +43 -17
  42. data/lib/google/cloud/ai_platform/v1/schedule_service/operations.rb +28 -6
  43. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/client.rb +43 -17
  44. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/operations.rb +28 -6
  45. data/lib/google/cloud/ai_platform/v1/tensorboard_service/client.rb +43 -17
  46. data/lib/google/cloud/ai_platform/v1/tensorboard_service/operations.rb +28 -6
  47. data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
  48. data/lib/google/cloud/ai_platform/v1/vizier_service/client.rb +43 -17
  49. data/lib/google/cloud/ai_platform/v1/vizier_service/operations.rb +28 -6
  50. data/lib/google/cloud/ai_platform/v1.rb +1 -0
  51. data/lib/google/cloud/aiplatform/v1/accelerator_type_pb.rb +1 -1
  52. data/lib/google/cloud/aiplatform/v1/annotation_pb.rb +1 -1
  53. data/lib/google/cloud/aiplatform/v1/annotation_spec_pb.rb +1 -1
  54. data/lib/google/cloud/aiplatform/v1/artifact_pb.rb +1 -1
  55. data/lib/google/cloud/aiplatform/v1/batch_prediction_job_pb.rb +1 -1
  56. data/lib/google/cloud/aiplatform/v1/completion_stats_pb.rb +1 -1
  57. data/lib/google/cloud/aiplatform/v1/content_pb.rb +64 -0
  58. data/lib/google/cloud/aiplatform/v1/context_pb.rb +1 -1
  59. data/lib/google/cloud/aiplatform/v1/custom_job_pb.rb +2 -2
  60. data/lib/google/cloud/aiplatform/v1/data_item_pb.rb +1 -1
  61. data/lib/google/cloud/aiplatform/v1/data_labeling_job_pb.rb +1 -1
  62. data/lib/google/cloud/aiplatform/v1/dataset_pb.rb +4 -2
  63. data/lib/google/cloud/aiplatform/v1/dataset_service_pb.rb +4 -2
  64. data/lib/google/cloud/aiplatform/v1/dataset_version_pb.rb +1 -1
  65. data/lib/google/cloud/aiplatform/v1/deployed_index_ref_pb.rb +2 -2
  66. data/lib/google/cloud/aiplatform/v1/deployed_model_ref_pb.rb +1 -1
  67. data/lib/google/cloud/aiplatform/v1/deployment_resource_pool_pb.rb +49 -0
  68. data/lib/google/cloud/aiplatform/v1/deployment_resource_pool_service_pb.rb +65 -0
  69. data/lib/google/cloud/aiplatform/v1/deployment_resource_pool_service_services_pb.rb +53 -0
  70. data/lib/google/cloud/aiplatform/v1/encryption_spec_pb.rb +1 -1
  71. data/lib/google/cloud/aiplatform/v1/endpoint_pb.rb +2 -2
  72. data/lib/google/cloud/aiplatform/v1/endpoint_service_pb.rb +2 -2
  73. data/lib/google/cloud/aiplatform/v1/entity_type_pb.rb +1 -1
  74. data/lib/google/cloud/aiplatform/v1/env_var_pb.rb +1 -1
  75. data/lib/google/cloud/aiplatform/v1/evaluated_annotation_pb.rb +1 -1
  76. data/lib/google/cloud/aiplatform/v1/event_pb.rb +1 -1
  77. data/lib/google/cloud/aiplatform/v1/execution_pb.rb +1 -1
  78. data/lib/google/cloud/aiplatform/v1/explanation_metadata_pb.rb +1 -1
  79. data/lib/google/cloud/aiplatform/v1/explanation_pb.rb +1 -1
  80. data/lib/google/cloud/aiplatform/v1/feature_group_pb.rb +2 -2
  81. data/lib/google/cloud/aiplatform/v1/feature_monitoring_stats_pb.rb +1 -1
  82. data/lib/google/cloud/aiplatform/v1/feature_online_store_admin_service_pb.rb +2 -2
  83. data/lib/google/cloud/aiplatform/v1/feature_online_store_pb.rb +2 -2
  84. data/lib/google/cloud/aiplatform/v1/feature_online_store_service_pb.rb +11 -2
  85. data/lib/google/cloud/aiplatform/v1/feature_online_store_service_services_pb.rb +5 -0
  86. data/lib/google/cloud/aiplatform/v1/feature_pb.rb +2 -2
  87. data/lib/google/cloud/aiplatform/v1/feature_registry_service_pb.rb +2 -2
  88. data/lib/google/cloud/aiplatform/v1/feature_selector_pb.rb +1 -1
  89. data/lib/google/cloud/aiplatform/v1/feature_view_pb.rb +2 -2
  90. data/lib/google/cloud/aiplatform/v1/feature_view_sync_pb.rb +2 -2
  91. data/lib/google/cloud/aiplatform/v1/featurestore_monitoring_pb.rb +1 -1
  92. data/lib/google/cloud/aiplatform/v1/featurestore_online_service_pb.rb +2 -2
  93. data/lib/google/cloud/aiplatform/v1/featurestore_pb.rb +1 -1
  94. data/lib/google/cloud/aiplatform/v1/featurestore_service_pb.rb +2 -2
  95. data/lib/google/cloud/aiplatform/v1/hyperparameter_tuning_job_pb.rb +1 -1
  96. data/lib/google/cloud/aiplatform/v1/index_endpoint_pb.rb +2 -2
  97. data/lib/google/cloud/aiplatform/v1/index_endpoint_service_pb.rb +2 -2
  98. data/lib/google/cloud/aiplatform/v1/index_pb.rb +1 -1
  99. data/lib/google/cloud/aiplatform/v1/index_service_pb.rb +2 -2
  100. data/lib/google/cloud/aiplatform/v1/io_pb.rb +1 -1
  101. data/lib/google/cloud/aiplatform/v1/job_service_pb.rb +2 -2
  102. data/lib/google/cloud/aiplatform/v1/job_state_pb.rb +1 -1
  103. data/lib/google/cloud/aiplatform/v1/lineage_subgraph_pb.rb +1 -1
  104. data/lib/google/cloud/aiplatform/v1/llm_utility_service_pb.rb +2 -2
  105. data/lib/google/cloud/aiplatform/v1/machine_resources_pb.rb +1 -1
  106. data/lib/google/cloud/aiplatform/v1/manual_batch_tuning_parameters_pb.rb +1 -1
  107. data/lib/google/cloud/aiplatform/v1/match_service_pb.rb +1 -1
  108. data/lib/google/cloud/aiplatform/v1/metadata_schema_pb.rb +1 -1
  109. data/lib/google/cloud/aiplatform/v1/metadata_service_pb.rb +2 -2
  110. data/lib/google/cloud/aiplatform/v1/metadata_store_pb.rb +1 -1
  111. data/lib/google/cloud/aiplatform/v1/migratable_resource_pb.rb +1 -1
  112. data/lib/google/cloud/aiplatform/v1/migration_service_pb.rb +2 -2
  113. data/lib/google/cloud/aiplatform/v1/model_deployment_monitoring_job_pb.rb +2 -2
  114. data/lib/google/cloud/aiplatform/v1/model_evaluation_pb.rb +1 -1
  115. data/lib/google/cloud/aiplatform/v1/model_evaluation_slice_pb.rb +1 -1
  116. data/lib/google/cloud/aiplatform/v1/model_garden_service_pb.rb +2 -2
  117. data/lib/google/cloud/aiplatform/v1/model_monitoring_pb.rb +1 -1
  118. data/lib/google/cloud/aiplatform/v1/model_pb.rb +3 -2
  119. data/lib/google/cloud/aiplatform/v1/model_service_pb.rb +2 -2
  120. data/lib/google/cloud/aiplatform/v1/nas_job_pb.rb +1 -1
  121. data/lib/google/cloud/aiplatform/v1/openapi_pb.rb +47 -0
  122. data/lib/google/cloud/aiplatform/v1/operation_pb.rb +1 -1
  123. data/lib/google/cloud/aiplatform/v1/pipeline_failure_policy_pb.rb +1 -1
  124. data/lib/google/cloud/aiplatform/v1/pipeline_job_pb.rb +1 -1
  125. data/lib/google/cloud/aiplatform/v1/pipeline_service_pb.rb +2 -2
  126. data/lib/google/cloud/aiplatform/v1/pipeline_state_pb.rb +1 -1
  127. data/lib/google/cloud/aiplatform/v1/prediction_service_pb.rb +16 -2
  128. data/lib/google/cloud/aiplatform/v1/prediction_service_services_pb.rb +16 -3
  129. data/lib/google/cloud/aiplatform/v1/publisher_model_pb.rb +6 -2
  130. data/lib/google/cloud/aiplatform/v1/saved_query_pb.rb +1 -1
  131. data/lib/google/cloud/aiplatform/v1/schedule_pb.rb +1 -1
  132. data/lib/google/cloud/aiplatform/v1/schedule_service_pb.rb +2 -2
  133. data/lib/google/cloud/aiplatform/v1/service_networking_pb.rb +4 -2
  134. data/lib/google/cloud/aiplatform/v1/specialist_pool_pb.rb +1 -1
  135. data/lib/google/cloud/aiplatform/v1/specialist_pool_service_pb.rb +2 -2
  136. data/lib/google/cloud/aiplatform/v1/study_pb.rb +1 -1
  137. data/lib/google/cloud/aiplatform/v1/tensorboard_data_pb.rb +1 -1
  138. data/lib/google/cloud/aiplatform/v1/tensorboard_experiment_pb.rb +1 -1
  139. data/lib/google/cloud/aiplatform/v1/tensorboard_pb.rb +1 -1
  140. data/lib/google/cloud/aiplatform/v1/tensorboard_run_pb.rb +1 -1
  141. data/lib/google/cloud/aiplatform/v1/tensorboard_service_pb.rb +2 -2
  142. data/lib/google/cloud/aiplatform/v1/tensorboard_time_series_pb.rb +1 -1
  143. data/lib/google/cloud/aiplatform/v1/tool_pb.rb +51 -0
  144. data/lib/google/cloud/aiplatform/v1/training_pipeline_pb.rb +1 -1
  145. data/lib/google/cloud/aiplatform/v1/types_pb.rb +1 -1
  146. data/lib/google/cloud/aiplatform/v1/unmanaged_container_model_pb.rb +1 -1
  147. data/lib/google/cloud/aiplatform/v1/user_action_reference_pb.rb +1 -1
  148. data/lib/google/cloud/aiplatform/v1/value_pb.rb +1 -1
  149. data/lib/google/cloud/aiplatform/v1/vizier_service_pb.rb +2 -2
  150. data/proto_docs/google/api/client.rb +1 -0
  151. data/proto_docs/google/cloud/aiplatform/v1/batch_prediction_job.rb +2 -2
  152. data/proto_docs/google/cloud/aiplatform/v1/content.rb +312 -0
  153. data/proto_docs/google/cloud/aiplatform/v1/custom_job.rb +15 -0
  154. data/proto_docs/google/cloud/aiplatform/v1/dataset.rb +102 -0
  155. data/proto_docs/google/cloud/aiplatform/v1/dataset_service.rb +12 -1
  156. data/proto_docs/google/cloud/aiplatform/v1/deployed_index_ref.rb +3 -0
  157. data/proto_docs/google/cloud/aiplatform/v1/deployment_resource_pool.rb +45 -0
  158. data/proto_docs/google/cloud/aiplatform/v1/deployment_resource_pool_service.rb +170 -0
  159. data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +6 -0
  160. data/proto_docs/google/cloud/aiplatform/v1/explanation.rb +8 -0
  161. data/proto_docs/google/cloud/aiplatform/v1/feature.rb +5 -1
  162. data/proto_docs/google/cloud/aiplatform/v1/feature_group.rb +2 -2
  163. data/proto_docs/google/cloud/aiplatform/v1/feature_online_store.rb +2 -2
  164. data/proto_docs/google/cloud/aiplatform/v1/feature_online_store_admin_service.rb +3 -1
  165. data/proto_docs/google/cloud/aiplatform/v1/feature_online_store_service.rb +150 -0
  166. data/proto_docs/google/cloud/aiplatform/v1/feature_view.rb +3 -2
  167. data/proto_docs/google/cloud/aiplatform/v1/feature_view_sync.rb +2 -2
  168. data/proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb +1 -1
  169. data/proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb +5 -0
  170. data/proto_docs/google/cloud/aiplatform/v1/index_service.rb +28 -0
  171. data/proto_docs/google/cloud/aiplatform/v1/metadata_service.rb +1 -0
  172. data/proto_docs/google/cloud/aiplatform/v1/model.rb +55 -4
  173. data/proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb +4 -0
  174. data/proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb +1 -1
  175. data/proto_docs/google/cloud/aiplatform/v1/model_monitoring.rb +1 -0
  176. data/proto_docs/google/cloud/aiplatform/v1/model_service.rb +4 -4
  177. data/proto_docs/google/cloud/aiplatform/v1/nas_job.rb +1 -0
  178. data/proto_docs/google/cloud/aiplatform/v1/openapi.rb +102 -0
  179. data/proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb +1 -0
  180. data/proto_docs/google/cloud/aiplatform/v1/prediction_service.rb +195 -0
  181. data/proto_docs/google/cloud/aiplatform/v1/publisher_model.rb +73 -1
  182. data/proto_docs/google/cloud/aiplatform/v1/service_networking.rb +16 -0
  183. data/proto_docs/google/cloud/aiplatform/v1/tool.rb +112 -0
  184. data/proto_docs/google/protobuf/any.rb +2 -1
  185. data/proto_docs/google/type/date.rb +53 -0
  186. metadata +27 -122
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fcb7c0638bbbcec0d81c576378862c6531005fd0f067378e55c86db49172310f
4
- data.tar.gz: 29f33bd3e971a27297ea8df831935c48fd9db6428464434ef5ef35cc6702a95a
3
+ metadata.gz: cd0581c567f247302d00a412853f32674a882726467887682a0d83f143b7e8a8
4
+ data.tar.gz: a6ae84ef91cefd447b0dcaabaa014f7eaeb06cbd425dd237a242f9f8e0d74dd6
5
5
  SHA512:
6
- metadata.gz: 360db9b95f78ab5d25878828f40f18798d19d6a8756d2dc901152fdd00df57d3f7faa2294869c480be77f5e4df82d9694042aefa7a3a318aeb0abfcc0b52b0df
7
- data.tar.gz: 35e6d36c41fa67cf120019af21e1a66e9420583b96164fb1837d0bd5e14005be63c1cbfa1443be4f59978ac4102dede0cff24920eb981d080ba4f61fa3dad7e4
6
+ metadata.gz: 538f1d0daad928b335c5b05c03c7a022ed572035ae004fd8f63643879b231fb8b7152697131b86fa221318c470c284f6b5a66914e59b3eb53dea2130b3efbe65
7
+ data.tar.gz: bea7867b7fb33bc8c4ffe75ffc5f3777190d9d1796a4961046473f11e77ac063127cd7a46090cb573203c2b32bb541b8e8c755b09c7e82a1858b2fcc6e2ca17e
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-ai_platform-v1 library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
6
- [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
- credentials will be discovered automatically. When running on other
8
- environments, the Service Account credentials can be specified by providing the
9
- path to the
10
- [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
- for the account (or the JSON itself) in
12
- [environment variables](#environment-variables). Additionally, Cloud SDK
13
- credentials can also be discovered automatically, but this is only recommended
14
- during development.
3
+ The recommended way to authenticate to the google-cloud-ai_platform-v1 library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
15
6
 
16
7
  ## Quickstart
17
8
 
18
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export GOOGLE_CLOUD_CREDENTIALS=path/to/keyfile.json
23
- ```
24
-
25
- 3. Initialize the client.
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
26
14
 
27
- ```ruby
28
- require "google/cloud/ai_platform/v1"
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
29
17
 
30
- client = ::Google::Cloud::AIPlatform::V1::DatasetService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-ai_platform-v1 library aims to make authentication
36
- as simple as possible, and provides several mechanisms to configure your system
37
- without requiring **Service Account Credentials** directly in code.
38
-
39
- **Credentials** are discovered in the following order:
40
-
41
- 1. Specify credentials in method arguments
42
- 2. Specify credentials in configuration
43
- 3. Discover credentials path in environment variables
44
- 4. Discover credentials JSON in environment variables
45
- 5. Discover credentials file in the Cloud SDK's path
46
- 6. Discover GCP credentials
47
-
48
- ### Google Cloud Platform environments
22
+ 3. Write code as if already authenticated.
49
23
 
50
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
- Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
- Code should be written as if already authenticated.
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
54
26
 
55
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
61
- **Credentials JSON** file can be stored in the environment variable, or the
62
- **Credentials JSON** itself can be stored for environments such as Docker
63
- containers where writing files is difficult or not encouraged.
29
+ The google-cloud-ai_platform-v1 library provides several mechanisms to configure your system.
30
+ Generally, using Application Default Credentials to facilitate automatic
31
+ credentials discovery is the easist method. But if you need to explicitly specify
32
+ credentials, there are several methods available to you.
64
33
 
65
- The environment variables that google-cloud-ai_platform-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::AIPlatform::V1::DatasetService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
72
41
 
73
- ```ruby
74
- require "google/cloud/ai_platform/v1"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Cloud::AIPlatform::V1::DatasetService::Client.new
79
- ```
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
80
49
 
81
- ### Configuration
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
82
53
 
83
- The path to the **Credentials JSON** file can be configured instead of storing
84
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
85
55
 
86
56
  ```ruby
87
57
  require "google/cloud/ai_platform/v1"
88
58
 
89
59
  client = ::Google::Cloud::AIPlatform::V1::DatasetService::Client.new do |config|
90
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
91
61
  end
92
62
  ```
93
63
 
94
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
95
65
 
96
66
  ```ruby
97
67
  require "google/cloud/ai_platform/v1"
98
68
 
99
69
  ::Google::Cloud::AIPlatform::V1::DatasetService::Client.configure do |config|
100
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
101
71
  end
102
72
 
103
73
  client = ::Google::Cloud::AIPlatform::V1::DatasetService::Client.new
104
74
  ```
105
75
 
106
- ### Cloud SDK
76
+ ### Environment Variables
107
77
 
108
- This option allows for an easy way to authenticate during development. If
109
- credentials are not provided in code or in environment variables, then Cloud SDK
110
- credentials are discovered.
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
111
82
 
112
- To configure your system for this, simply:
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
113
87
 
114
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
115
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
116
- 3. Write code as if already authenticated.
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-ai_platform-v1
93
+ checks for credentials are:
117
94
 
118
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
120
97
 
121
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/ai_platform/v1"
122
100
 
123
- Google Cloud requires **Service Account Credentials** to
124
- connect to the APIs. You will use the **JSON key file** to
125
- connect to most services with google-cloud-ai_platform-v1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
126
102
 
127
- If you are not running this client within
128
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
129
- need a Google Developers service account.
103
+ client = ::Google::Cloud::AIPlatform::V1::DatasetService::Client.new
104
+ ```
130
105
 
131
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
132
- 2. Create a new project or click on an existing project.
133
- 3. Activate the menu in the upper left and select **APIs & Services**. From
134
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
135
107
 
136
- *Note: You may need to enable billing in order to use these services.*
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
137
111
 
138
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
139
113
 
140
- Find the "Create credentials" drop down near the top of the page, and select
141
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
142
115
 
143
- If you want to re-use an existing service account, you can easily generate a
144
- new key file. Just select the account you wish to re-use, click the pencil
145
- tool on the right side to edit the service account, select the **Keys** tab,
146
- and then select **Add Key**.
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
147
120
 
148
- The key file you download will be used by this library to authenticate API
149
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
data/README.md CHANGED
@@ -76,7 +76,7 @@ To browse ready to use code samples check [Google Cloud Samples](https://cloud.g
76
76
 
77
77
  ## Supported Ruby Versions
78
78
 
79
- This library is supported on Ruby 2.6+.
79
+ This library is supported on Ruby 2.7+.
80
80
 
81
81
  Google provides official support for Ruby versions that are actively supported
82
82
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -32,6 +32,9 @@ module Google
32
32
  # The service that manages Vertex AI Dataset and its child resources.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "aiplatform.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -92,6 +95,15 @@ module Google
92
95
  @config
93
96
  end
94
97
 
98
+ ##
99
+ # The effective universe domain
100
+ #
101
+ # @return [String]
102
+ #
103
+ def universe_domain
104
+ @dataset_service_stub.universe_domain
105
+ end
106
+
95
107
  ##
96
108
  # Create a new DatasetService client object.
97
109
  #
@@ -125,8 +137,9 @@ module Google
125
137
  credentials = @config.credentials
126
138
  # Use self-signed JWT if the endpoint is unchanged from default,
127
139
  # but only if the default endpoint does not have a region prefix.
128
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
129
- !@config.endpoint.split(".").first.include?("-")
140
+ enable_self_signed_jwt = @config.endpoint.nil? ||
141
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
142
+ !@config.endpoint.split(".").first.include?("-"))
130
143
  credentials ||= Credentials.default scope: @config.scope,
131
144
  enable_self_signed_jwt: enable_self_signed_jwt
132
145
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -139,28 +152,33 @@ module Google
139
152
  config.credentials = credentials
140
153
  config.quota_project = @quota_project_id
141
154
  config.endpoint = @config.endpoint
155
+ config.universe_domain = @config.universe_domain
142
156
  end
143
157
 
158
+ @dataset_service_stub = ::Gapic::ServiceStub.new(
159
+ ::Google::Cloud::AIPlatform::V1::DatasetService::Stub,
160
+ credentials: credentials,
161
+ endpoint: @config.endpoint,
162
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
163
+ universe_domain: @config.universe_domain,
164
+ channel_args: @config.channel_args,
165
+ interceptors: @config.interceptors,
166
+ channel_pool_config: @config.channel_pool
167
+ )
168
+
144
169
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
145
170
  config.credentials = credentials
146
171
  config.quota_project = @quota_project_id
147
- config.endpoint = @config.endpoint
172
+ config.endpoint = @dataset_service_stub.endpoint
173
+ config.universe_domain = @dataset_service_stub.universe_domain
148
174
  end
149
175
 
150
176
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
151
177
  config.credentials = credentials
152
178
  config.quota_project = @quota_project_id
153
- config.endpoint = @config.endpoint
179
+ config.endpoint = @dataset_service_stub.endpoint
180
+ config.universe_domain = @dataset_service_stub.universe_domain
154
181
  end
155
-
156
- @dataset_service_stub = ::Gapic::ServiceStub.new(
157
- ::Google::Cloud::AIPlatform::V1::DatasetService::Stub,
158
- credentials: credentials,
159
- endpoint: @config.endpoint,
160
- channel_args: @config.channel_args,
161
- interceptors: @config.interceptors,
162
- channel_pool_config: @config.channel_pool
163
- )
164
182
  end
165
183
 
166
184
  ##
@@ -2027,9 +2045,9 @@ module Google
2027
2045
  # end
2028
2046
  #
2029
2047
  # @!attribute [rw] endpoint
2030
- # The hostname or hostname:port of the service endpoint.
2031
- # Defaults to `"aiplatform.googleapis.com"`.
2032
- # @return [::String]
2048
+ # A custom service endpoint, as a hostname or hostname:port. The default is
2049
+ # nil, indicating to use the default endpoint in the current universe domain.
2050
+ # @return [::String,nil]
2033
2051
  # @!attribute [rw] credentials
2034
2052
  # Credentials to send with calls. You may provide any of the following types:
2035
2053
  # * (`String`) The path to a service account key file in JSON format
@@ -2075,13 +2093,20 @@ module Google
2075
2093
  # @!attribute [rw] quota_project
2076
2094
  # A separate project against which to charge quota.
2077
2095
  # @return [::String]
2096
+ # @!attribute [rw] universe_domain
2097
+ # The universe domain within which to make requests. This determines the
2098
+ # default endpoint URL. The default value of nil uses the environment
2099
+ # universe (usually the default "googleapis.com" universe).
2100
+ # @return [::String,nil]
2078
2101
  #
2079
2102
  class Configuration
2080
2103
  extend ::Gapic::Config
2081
2104
 
2105
+ # @private
2106
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
2082
2107
  DEFAULT_ENDPOINT = "aiplatform.googleapis.com"
2083
2108
 
2084
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2109
+ config_attr :endpoint, nil, ::String, nil
2085
2110
  config_attr :credentials, nil do |value|
2086
2111
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2087
2112
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -2096,6 +2121,7 @@ module Google
2096
2121
  config_attr :metadata, nil, ::Hash, nil
2097
2122
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2098
2123
  config_attr :quota_project, nil, ::String, nil
2124
+ config_attr :universe_domain, nil, ::String, nil
2099
2125
 
2100
2126
  # @private
2101
2127
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module DatasetService
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "aiplatform.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -90,8 +102,10 @@ module Google
90
102
 
91
103
  @operations_stub = ::Gapic::ServiceStub.new(
92
104
  ::Google::Longrunning::Operations::Stub,
93
- credentials: credentials,
94
- endpoint: @config.endpoint,
105
+ credentials: credentials,
106
+ endpoint: @config.endpoint,
107
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
108
+ universe_domain: @config.universe_domain,
95
109
  channel_args: @config.channel_args,
96
110
  interceptors: @config.interceptors,
97
111
  channel_pool_config: @config.channel_pool
@@ -621,9 +635,9 @@ module Google
621
635
  # end
622
636
  #
623
637
  # @!attribute [rw] endpoint
624
- # The hostname or hostname:port of the service endpoint.
625
- # Defaults to `"aiplatform.googleapis.com"`.
626
- # @return [::String]
638
+ # A custom service endpoint, as a hostname or hostname:port. The default is
639
+ # nil, indicating to use the default endpoint in the current universe domain.
640
+ # @return [::String,nil]
627
641
  # @!attribute [rw] credentials
628
642
  # Credentials to send with calls. You may provide any of the following types:
629
643
  # * (`String`) The path to a service account key file in JSON format
@@ -669,13 +683,20 @@ module Google
669
683
  # @!attribute [rw] quota_project
670
684
  # A separate project against which to charge quota.
671
685
  # @return [::String]
686
+ # @!attribute [rw] universe_domain
687
+ # The universe domain within which to make requests. This determines the
688
+ # default endpoint URL. The default value of nil uses the environment
689
+ # universe (usually the default "googleapis.com" universe).
690
+ # @return [::String,nil]
672
691
  #
673
692
  class Configuration
674
693
  extend ::Gapic::Config
675
694
 
695
+ # @private
696
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
676
697
  DEFAULT_ENDPOINT = "aiplatform.googleapis.com"
677
698
 
678
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
699
+ config_attr :endpoint, nil, ::String, nil
679
700
  config_attr :credentials, nil do |value|
680
701
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
681
702
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -690,6 +711,7 @@ module Google
690
711
  config_attr :metadata, nil, ::Hash, nil
691
712
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
692
713
  config_attr :quota_project, nil, ::String, nil
714
+ config_attr :universe_domain, nil, ::String, nil
693
715
 
694
716
  # @private
695
717
  def initialize parent_config = nil