google-cloud-ai_platform-v1 0.39.0 → 0.41.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.
Files changed (221) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/ai_platform/v1/bindings_override.rb +399 -0
  3. data/lib/google/cloud/ai_platform/v1/dataset_service/client.rb +138 -18
  4. data/lib/google/cloud/ai_platform/v1/dataset_service/operations.rb +13 -5
  5. data/lib/google/cloud/ai_platform/v1/dataset_service/rest/client.rb +2280 -0
  6. data/lib/google/cloud/ai_platform/v1/dataset_service/rest/operations.rb +3971 -0
  7. data/lib/google/cloud/ai_platform/v1/dataset_service/rest/service_stub.rb +1196 -0
  8. data/lib/google/cloud/ai_platform/v1/dataset_service/rest.rb +54 -0
  9. data/lib/google/cloud/ai_platform/v1/dataset_service.rb +6 -0
  10. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/client.rb +13 -5
  11. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/operations.rb +13 -5
  12. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb +851 -0
  13. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/operations.rb +3971 -0
  14. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/service_stub.rb +365 -0
  15. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest.rb +54 -0
  16. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service.rb +6 -0
  17. data/lib/google/cloud/ai_platform/v1/endpoint_service/client.rb +19 -8
  18. data/lib/google/cloud/ai_platform/v1/endpoint_service/operations.rb +13 -5
  19. data/lib/google/cloud/ai_platform/v1/endpoint_service/rest/client.rb +1215 -0
  20. data/lib/google/cloud/ai_platform/v1/endpoint_service/rest/operations.rb +3971 -0
  21. data/lib/google/cloud/ai_platform/v1/endpoint_service/rest/service_stub.rb +546 -0
  22. data/lib/google/cloud/ai_platform/v1/endpoint_service/rest.rb +54 -0
  23. data/lib/google/cloud/ai_platform/v1/endpoint_service.rb +6 -0
  24. data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/client.rb +29 -13
  25. data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/operations.rb +13 -5
  26. data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/rest/client.rb +1732 -0
  27. data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/rest/operations.rb +3971 -0
  28. data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/rest/service_stub.rb +841 -0
  29. data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/rest.rb +55 -0
  30. data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service.rb +6 -0
  31. data/lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb +7 -2
  32. data/lib/google/cloud/ai_platform/v1/feature_online_store_service/rest/client.rb +534 -0
  33. data/lib/google/cloud/ai_platform/v1/feature_online_store_service/rest/service_stub.rb +189 -0
  34. data/lib/google/cloud/ai_platform/v1/feature_online_store_service/rest.rb +53 -0
  35. data/lib/google/cloud/ai_platform/v1/feature_online_store_service.rb +6 -0
  36. data/lib/google/cloud/ai_platform/v1/feature_registry_service/client.rb +24 -11
  37. data/lib/google/cloud/ai_platform/v1/feature_registry_service/operations.rb +13 -5
  38. data/lib/google/cloud/ai_platform/v1/feature_registry_service/rest/client.rb +1450 -0
  39. data/lib/google/cloud/ai_platform/v1/feature_registry_service/rest/operations.rb +3971 -0
  40. data/lib/google/cloud/ai_platform/v1/feature_registry_service/rest/service_stub.rb +663 -0
  41. data/lib/google/cloud/ai_platform/v1/feature_registry_service/rest.rb +55 -0
  42. data/lib/google/cloud/ai_platform/v1/feature_registry_service.rb +6 -0
  43. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb +9 -3
  44. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/rest/client.rb +645 -0
  45. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/rest/service_stub.rb +244 -0
  46. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/rest.rb +53 -0
  47. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service.rb +6 -0
  48. data/lib/google/cloud/ai_platform/v1/featurestore_service/client.rb +45 -21
  49. data/lib/google/cloud/ai_platform/v1/featurestore_service/operations.rb +13 -5
  50. data/lib/google/cloud/ai_platform/v1/featurestore_service/rest/client.rb +2765 -0
  51. data/lib/google/cloud/ai_platform/v1/featurestore_service/rest/operations.rb +3971 -0
  52. data/lib/google/cloud/ai_platform/v1/featurestore_service/rest/service_stub.rb +1319 -0
  53. data/lib/google/cloud/ai_platform/v1/featurestore_service/rest.rb +54 -0
  54. data/lib/google/cloud/ai_platform/v1/featurestore_service.rb +6 -0
  55. data/lib/google/cloud/ai_platform/v1/gen_ai_tuning_service/client.rb +11 -4
  56. data/lib/google/cloud/ai_platform/v1/gen_ai_tuning_service/rest/client.rb +720 -0
  57. data/lib/google/cloud/ai_platform/v1/gen_ai_tuning_service/rest/service_stub.rb +307 -0
  58. data/lib/google/cloud/ai_platform/v1/gen_ai_tuning_service/rest.rb +53 -0
  59. data/lib/google/cloud/ai_platform/v1/gen_ai_tuning_service.rb +6 -0
  60. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/client.rb +19 -8
  61. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/operations.rb +13 -5
  62. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/rest/client.rb +1151 -0
  63. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/rest/operations.rb +3971 -0
  64. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/rest/service_stub.rb +546 -0
  65. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/rest.rb +54 -0
  66. data/lib/google/cloud/ai_platform/v1/index_endpoint_service.rb +6 -0
  67. data/lib/google/cloud/ai_platform/v1/index_service/client.rb +17 -7
  68. data/lib/google/cloud/ai_platform/v1/index_service/operations.rb +13 -5
  69. data/lib/google/cloud/ai_platform/v1/index_service/rest/client.rb +1034 -0
  70. data/lib/google/cloud/ai_platform/v1/index_service/rest/operations.rb +3971 -0
  71. data/lib/google/cloud/ai_platform/v1/index_service/rest/service_stub.rb +486 -0
  72. data/lib/google/cloud/ai_platform/v1/index_service/rest.rb +54 -0
  73. data/lib/google/cloud/ai_platform/v1/index_service.rb +6 -0
  74. data/lib/google/cloud/ai_platform/v1/job_service/client.rb +73 -35
  75. data/lib/google/cloud/ai_platform/v1/job_service/operations.rb +13 -5
  76. data/lib/google/cloud/ai_platform/v1/job_service/rest/client.rb +3841 -0
  77. data/lib/google/cloud/ai_platform/v1/job_service/rest/operations.rb +3971 -0
  78. data/lib/google/cloud/ai_platform/v1/job_service/rest/service_stub.rb +2149 -0
  79. data/lib/google/cloud/ai_platform/v1/job_service/rest.rb +54 -0
  80. data/lib/google/cloud/ai_platform/v1/job_service.rb +6 -0
  81. data/lib/google/cloud/ai_platform/v1/llm_utility_service/client.rb +7 -2
  82. data/lib/google/cloud/ai_platform/v1/llm_utility_service/rest/client.rb +533 -0
  83. data/lib/google/cloud/ai_platform/v1/llm_utility_service/rest/service_stub.rb +205 -0
  84. data/lib/google/cloud/ai_platform/v1/llm_utility_service/rest.rb +53 -0
  85. data/lib/google/cloud/ai_platform/v1/llm_utility_service.rb +6 -0
  86. data/lib/google/cloud/ai_platform/v1/match_service/client.rb +7 -2
  87. data/lib/google/cloud/ai_platform/v1/match_service/rest/client.rb +541 -0
  88. data/lib/google/cloud/ai_platform/v1/match_service/rest/service_stub.rb +189 -0
  89. data/lib/google/cloud/ai_platform/v1/match_service/rest.rb +54 -0
  90. data/lib/google/cloud/ai_platform/v1/match_service.rb +6 -0
  91. data/lib/google/cloud/ai_platform/v1/metadata_service/client.rb +67 -32
  92. data/lib/google/cloud/ai_platform/v1/metadata_service/operations.rb +13 -5
  93. data/lib/google/cloud/ai_platform/v1/metadata_service/rest/client.rb +3634 -0
  94. data/lib/google/cloud/ai_platform/v1/metadata_service/rest/operations.rb +3971 -0
  95. data/lib/google/cloud/ai_platform/v1/metadata_service/rest/service_stub.rb +1972 -0
  96. data/lib/google/cloud/ai_platform/v1/metadata_service/rest.rb +54 -0
  97. data/lib/google/cloud/ai_platform/v1/metadata_service.rb +6 -0
  98. data/lib/google/cloud/ai_platform/v1/migration_service/client.rb +7 -2
  99. data/lib/google/cloud/ai_platform/v1/migration_service/operations.rb +13 -5
  100. data/lib/google/cloud/ai_platform/v1/migration_service/rest/client.rb +574 -0
  101. data/lib/google/cloud/ai_platform/v1/migration_service/rest/operations.rb +3971 -0
  102. data/lib/google/cloud/ai_platform/v1/migration_service/rest/service_stub.rb +189 -0
  103. data/lib/google/cloud/ai_platform/v1/migration_service/rest.rb +55 -0
  104. data/lib/google/cloud/ai_platform/v1/migration_service.rb +6 -0
  105. data/lib/google/cloud/ai_platform/v1/model_garden_service/client.rb +5 -1
  106. data/lib/google/cloud/ai_platform/v1/model_garden_service/rest/client.rb +438 -0
  107. data/lib/google/cloud/ai_platform/v1/model_garden_service/rest/service_stub.rb +128 -0
  108. data/lib/google/cloud/ai_platform/v1/model_garden_service/rest.rb +53 -0
  109. data/lib/google/cloud/ai_platform/v1/model_garden_service.rb +6 -0
  110. data/lib/google/cloud/ai_platform/v1/model_service/client.rb +39 -18
  111. data/lib/google/cloud/ai_platform/v1/model_service/operations.rb +13 -5
  112. data/lib/google/cloud/ai_platform/v1/model_service/rest/client.rb +2213 -0
  113. data/lib/google/cloud/ai_platform/v1/model_service/rest/operations.rb +3971 -0
  114. data/lib/google/cloud/ai_platform/v1/model_service/rest/service_stub.rb +1140 -0
  115. data/lib/google/cloud/ai_platform/v1/model_service/rest.rb +54 -0
  116. data/lib/google/cloud/ai_platform/v1/model_service.rb +6 -0
  117. data/lib/google/cloud/ai_platform/v1/notebook_service/client.rb +123 -10
  118. data/lib/google/cloud/ai_platform/v1/notebook_service/operations.rb +13 -5
  119. data/lib/google/cloud/ai_platform/v1/notebook_service/rest/client.rb +1503 -0
  120. data/lib/google/cloud/ai_platform/v1/notebook_service/rest/operations.rb +3971 -0
  121. data/lib/google/cloud/ai_platform/v1/notebook_service/rest/service_stub.rb +723 -0
  122. data/lib/google/cloud/ai_platform/v1/notebook_service/rest.rb +54 -0
  123. data/lib/google/cloud/ai_platform/v1/notebook_service.rb +6 -0
  124. data/lib/google/cloud/ai_platform/v1/persistent_resource_service/client.rb +15 -6
  125. data/lib/google/cloud/ai_platform/v1/persistent_resource_service/operations.rb +13 -5
  126. data/lib/google/cloud/ai_platform/v1/persistent_resource_service/rest/client.rb +942 -0
  127. data/lib/google/cloud/ai_platform/v1/persistent_resource_service/rest/operations.rb +3971 -0
  128. data/lib/google/cloud/ai_platform/v1/persistent_resource_service/rest/service_stub.rb +426 -0
  129. data/lib/google/cloud/ai_platform/v1/persistent_resource_service/rest.rb +54 -0
  130. data/lib/google/cloud/ai_platform/v1/persistent_resource_service.rb +6 -0
  131. data/lib/google/cloud/ai_platform/v1/pipeline_service/client.rb +27 -12
  132. data/lib/google/cloud/ai_platform/v1/pipeline_service/operations.rb +13 -5
  133. data/lib/google/cloud/ai_platform/v1/pipeline_service/rest/client.rb +1600 -0
  134. data/lib/google/cloud/ai_platform/v1/pipeline_service/rest/operations.rb +3971 -0
  135. data/lib/google/cloud/ai_platform/v1/pipeline_service/rest/service_stub.rb +783 -0
  136. data/lib/google/cloud/ai_platform/v1/pipeline_service/rest.rb +56 -0
  137. data/lib/google/cloud/ai_platform/v1/pipeline_service.rb +6 -0
  138. data/lib/google/cloud/ai_platform/v1/prediction_service/client.rb +37 -15
  139. data/lib/google/cloud/ai_platform/v1/prediction_service/credentials.rb +2 -1
  140. data/lib/google/cloud/ai_platform/v1/prediction_service/rest/client.rb +1303 -0
  141. data/lib/google/cloud/ai_platform/v1/prediction_service/rest/service_stub.rb +658 -0
  142. data/lib/google/cloud/ai_platform/v1/prediction_service/rest.rb +53 -0
  143. data/lib/google/cloud/ai_platform/v1/prediction_service.rb +6 -0
  144. data/lib/google/cloud/ai_platform/v1/rest.rb +63 -0
  145. data/lib/google/cloud/ai_platform/v1/schedule_service/client.rb +17 -7
  146. data/lib/google/cloud/ai_platform/v1/schedule_service/operations.rb +13 -5
  147. data/lib/google/cloud/ai_platform/v1/schedule_service/rest/client.rb +1076 -0
  148. data/lib/google/cloud/ai_platform/v1/schedule_service/rest/operations.rb +3971 -0
  149. data/lib/google/cloud/ai_platform/v1/schedule_service/rest/service_stub.rb +486 -0
  150. data/lib/google/cloud/ai_platform/v1/schedule_service/rest.rb +55 -0
  151. data/lib/google/cloud/ai_platform/v1/schedule_service.rb +6 -0
  152. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/client.rb +13 -5
  153. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/operations.rb +13 -5
  154. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/rest/client.rb +847 -0
  155. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/rest/operations.rb +3971 -0
  156. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/rest/service_stub.rb +366 -0
  157. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/rest.rb +59 -0
  158. data/lib/google/cloud/ai_platform/v1/specialist_pool_service.rb +6 -0
  159. data/lib/google/cloud/ai_platform/v1/tensorboard_service/client.rb +63 -30
  160. data/lib/google/cloud/ai_platform/v1/tensorboard_service/operations.rb +13 -5
  161. data/lib/google/cloud/ai_platform/v1/tensorboard_service/rest/client.rb +3274 -0
  162. data/lib/google/cloud/ai_platform/v1/tensorboard_service/rest/operations.rb +3971 -0
  163. data/lib/google/cloud/ai_platform/v1/tensorboard_service/rest/service_stub.rb +1847 -0
  164. data/lib/google/cloud/ai_platform/v1/tensorboard_service/rest.rb +54 -0
  165. data/lib/google/cloud/ai_platform/v1/tensorboard_service.rb +6 -0
  166. data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
  167. data/lib/google/cloud/ai_platform/v1/vizier_service/client.rb +33 -15
  168. data/lib/google/cloud/ai_platform/v1/vizier_service/operations.rb +13 -5
  169. data/lib/google/cloud/ai_platform/v1/vizier_service/rest/client.rb +1788 -0
  170. data/lib/google/cloud/ai_platform/v1/vizier_service/rest/operations.rb +3971 -0
  171. data/lib/google/cloud/ai_platform/v1/vizier_service/rest/service_stub.rb +963 -0
  172. data/lib/google/cloud/ai_platform/v1/vizier_service/rest.rb +58 -0
  173. data/lib/google/cloud/ai_platform/v1/vizier_service.rb +6 -0
  174. data/lib/google/cloud/ai_platform/v1.rb +6 -1
  175. data/lib/google/cloud/aiplatform/v1/accelerator_type_pb.rb +1 -1
  176. data/lib/google/cloud/aiplatform/v1/content_pb.rb +4 -4
  177. data/lib/google/cloud/aiplatform/v1/dataset_pb.rb +1 -1
  178. data/lib/google/cloud/aiplatform/v1/dataset_service_pb.rb +3 -2
  179. data/lib/google/cloud/aiplatform/v1/dataset_service_services_pb.rb +2 -0
  180. data/lib/google/cloud/aiplatform/v1/dataset_version_pb.rb +1 -1
  181. data/lib/google/cloud/aiplatform/v1/deployment_resource_pool_pb.rb +3 -1
  182. data/lib/google/cloud/aiplatform/v1/endpoint_pb.rb +3 -1
  183. data/lib/google/cloud/aiplatform/v1/feature_online_store_pb.rb +3 -1
  184. data/lib/google/cloud/aiplatform/v1/feature_pb.rb +1 -1
  185. data/lib/google/cloud/aiplatform/v1/featurestore_online_service_pb.rb +3 -1
  186. data/lib/google/cloud/aiplatform/v1/index_pb.rb +2 -1
  187. data/lib/google/cloud/aiplatform/v1/index_service_pb.rb +1 -1
  188. data/lib/google/cloud/aiplatform/v1/match_service_pb.rb +2 -1
  189. data/lib/google/cloud/aiplatform/v1/metadata_store_pb.rb +2 -1
  190. data/lib/google/cloud/aiplatform/v1/notebook_runtime_pb.rb +3 -1
  191. data/lib/google/cloud/aiplatform/v1/notebook_service_pb.rb +2 -1
  192. data/lib/google/cloud/aiplatform/v1/notebook_service_services_pb.rb +2 -0
  193. data/lib/google/cloud/aiplatform/v1/persistent_resource_pb.rb +2 -1
  194. data/lib/google/cloud/aiplatform/v1/prediction_service_pb.rb +1 -1
  195. data/lib/google/cloud/aiplatform/v1/publisher_model_pb.rb +1 -1
  196. data/lib/google/cloud/aiplatform/v1/tool_pb.rb +4 -1
  197. data/proto_docs/google/cloud/aiplatform/v1/accelerator_type.rb +3 -0
  198. data/proto_docs/google/cloud/aiplatform/v1/content.rb +26 -48
  199. data/proto_docs/google/cloud/aiplatform/v1/dataset.rb +4 -0
  200. data/proto_docs/google/cloud/aiplatform/v1/dataset_service.rb +17 -0
  201. data/proto_docs/google/cloud/aiplatform/v1/dataset_version.rb +4 -0
  202. data/proto_docs/google/cloud/aiplatform/v1/deployment_resource_pool.rb +23 -0
  203. data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +7 -0
  204. data/proto_docs/google/cloud/aiplatform/v1/feature.rb +3 -0
  205. data/proto_docs/google/cloud/aiplatform/v1/feature_group.rb +3 -3
  206. data/proto_docs/google/cloud/aiplatform/v1/feature_online_store.rb +4 -0
  207. data/proto_docs/google/cloud/aiplatform/v1/feature_registry_service.rb +1 -1
  208. data/proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb +24 -0
  209. data/proto_docs/google/cloud/aiplatform/v1/index.rb +23 -3
  210. data/proto_docs/google/cloud/aiplatform/v1/index_service.rb +20 -2
  211. data/proto_docs/google/cloud/aiplatform/v1/match_service.rb +18 -1
  212. data/proto_docs/google/cloud/aiplatform/v1/metadata_store.rb +13 -0
  213. data/proto_docs/google/cloud/aiplatform/v1/model.rb +1 -1
  214. data/proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb +17 -2
  215. data/proto_docs/google/cloud/aiplatform/v1/notebook_service.rb +18 -0
  216. data/proto_docs/google/cloud/aiplatform/v1/persistent_resource.rb +63 -0
  217. data/proto_docs/google/cloud/aiplatform/v1/prediction_service.rb +4 -0
  218. data/proto_docs/google/cloud/aiplatform/v1/publisher_model.rb +4 -0
  219. data/proto_docs/google/cloud/aiplatform/v1/tool.rb +43 -5
  220. data/proto_docs/google/cloud/aiplatform/v1/tuning_job.rb +8 -7
  221. metadata +101 -2
@@ -0,0 +1,3274 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 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/tensorboard_service_pb"
21
+ require "google/cloud/ai_platform/v1/tensorboard_service/rest/service_stub"
22
+ require "google/cloud/location/rest"
23
+ require "google/iam/v1/rest"
24
+
25
+ module Google
26
+ module Cloud
27
+ module AIPlatform
28
+ module V1
29
+ module TensorboardService
30
+ module Rest
31
+ ##
32
+ # REST client for the TensorboardService service.
33
+ #
34
+ # TensorboardService
35
+ #
36
+ class Client
37
+ # @private
38
+ API_VERSION = ""
39
+
40
+ # @private
41
+ DEFAULT_ENDPOINT_TEMPLATE = "aiplatform.$UNIVERSE_DOMAIN$"
42
+
43
+ include Paths
44
+
45
+ # @private
46
+ attr_reader :tensorboard_service_stub
47
+
48
+ ##
49
+ # Configure the TensorboardService Client class.
50
+ #
51
+ # See {::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client::Configuration}
52
+ # for a description of the configuration fields.
53
+ #
54
+ # @example
55
+ #
56
+ # # Modify the configuration for all TensorboardService clients
57
+ # ::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.configure do |config|
58
+ # config.timeout = 10.0
59
+ # end
60
+ #
61
+ # @yield [config] Configure the Client client.
62
+ # @yieldparam config [Client::Configuration]
63
+ #
64
+ # @return [Client::Configuration]
65
+ #
66
+ def self.configure
67
+ @configure ||= begin
68
+ namespace = ["Google", "Cloud", "AIPlatform", "V1"]
69
+ parent_config = while namespace.any?
70
+ parent_name = namespace.join "::"
71
+ parent_const = const_get parent_name
72
+ break parent_const.configure if parent_const.respond_to? :configure
73
+ namespace.pop
74
+ end
75
+ default_config = Client::Configuration.new parent_config
76
+
77
+ default_config
78
+ end
79
+ yield @configure if block_given?
80
+ @configure
81
+ end
82
+
83
+ ##
84
+ # Configure the TensorboardService Client instance.
85
+ #
86
+ # The configuration is set to the derived mode, meaning that values can be changed,
87
+ # but structural changes (adding new fields, etc.) are not allowed. Structural changes
88
+ # should be made on {Client.configure}.
89
+ #
90
+ # See {::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client::Configuration}
91
+ # for a description of the configuration fields.
92
+ #
93
+ # @yield [config] Configure the Client client.
94
+ # @yieldparam config [Client::Configuration]
95
+ #
96
+ # @return [Client::Configuration]
97
+ #
98
+ def configure
99
+ yield @config if block_given?
100
+ @config
101
+ end
102
+
103
+ ##
104
+ # The effective universe domain
105
+ #
106
+ # @return [String]
107
+ #
108
+ def universe_domain
109
+ @tensorboard_service_stub.universe_domain
110
+ end
111
+
112
+ ##
113
+ # Create a new TensorboardService REST client object.
114
+ #
115
+ # @example
116
+ #
117
+ # # Create a client using the default configuration
118
+ # client = ::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
119
+ #
120
+ # # Create a client using a custom configuration
121
+ # client = ::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new do |config|
122
+ # config.timeout = 10.0
123
+ # end
124
+ #
125
+ # @yield [config] Configure the TensorboardService client.
126
+ # @yieldparam config [Client::Configuration]
127
+ #
128
+ def initialize
129
+ # Create the configuration object
130
+ @config = Configuration.new Client.configure
131
+
132
+ # Yield the configuration if needed
133
+ yield @config if block_given?
134
+
135
+ # Create credentials
136
+ credentials = @config.credentials
137
+ # Use self-signed JWT if the endpoint is unchanged from default,
138
+ # but only if the default endpoint does not have a region prefix.
139
+ enable_self_signed_jwt = @config.endpoint.nil? ||
140
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
141
+ !@config.endpoint.split(".").first.include?("-"))
142
+ credentials ||= Credentials.default scope: @config.scope,
143
+ enable_self_signed_jwt: enable_self_signed_jwt
144
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
145
+ credentials = Credentials.new credentials, scope: @config.scope
146
+ end
147
+
148
+ @quota_project_id = @config.quota_project
149
+ @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
150
+
151
+ @operations_client = ::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Operations.new do |config|
152
+ config.credentials = credentials
153
+ config.quota_project = @quota_project_id
154
+ config.endpoint = @config.endpoint
155
+ config.universe_domain = @config.universe_domain
156
+ end
157
+
158
+ @tensorboard_service_stub = ::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::ServiceStub.new(
159
+ endpoint: @config.endpoint,
160
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
161
+ universe_domain: @config.universe_domain,
162
+ credentials: credentials
163
+ )
164
+
165
+ @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
166
+ config.credentials = credentials
167
+ config.quota_project = @quota_project_id
168
+ config.endpoint = @tensorboard_service_stub.endpoint
169
+ config.universe_domain = @tensorboard_service_stub.universe_domain
170
+ config.bindings_override = @config.bindings_override
171
+ end
172
+
173
+ @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
174
+ config.credentials = credentials
175
+ config.quota_project = @quota_project_id
176
+ config.endpoint = @tensorboard_service_stub.endpoint
177
+ config.universe_domain = @tensorboard_service_stub.universe_domain
178
+ config.bindings_override = @config.bindings_override
179
+ end
180
+ end
181
+
182
+ ##
183
+ # Get the associated client for long-running operations.
184
+ #
185
+ # @return [::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Operations]
186
+ #
187
+ attr_reader :operations_client
188
+
189
+ ##
190
+ # Get the associated client for mix-in of the Locations.
191
+ #
192
+ # @return [Google::Cloud::Location::Locations::Rest::Client]
193
+ #
194
+ attr_reader :location_client
195
+
196
+ ##
197
+ # Get the associated client for mix-in of the IAMPolicy.
198
+ #
199
+ # @return [Google::Iam::V1::IAMPolicy::Rest::Client]
200
+ #
201
+ attr_reader :iam_policy_client
202
+
203
+ # Service calls
204
+
205
+ ##
206
+ # Creates a Tensorboard.
207
+ #
208
+ # @overload create_tensorboard(request, options = nil)
209
+ # Pass arguments to `create_tensorboard` via a request object, either of type
210
+ # {::Google::Cloud::AIPlatform::V1::CreateTensorboardRequest} or an equivalent Hash.
211
+ #
212
+ # @param request [::Google::Cloud::AIPlatform::V1::CreateTensorboardRequest, ::Hash]
213
+ # A request object representing the call parameters. Required. To specify no
214
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
215
+ # @param options [::Gapic::CallOptions, ::Hash]
216
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
217
+ #
218
+ # @overload create_tensorboard(parent: nil, tensorboard: nil)
219
+ # Pass arguments to `create_tensorboard` via keyword arguments. Note that at
220
+ # least one keyword argument is required. To specify no parameters, or to keep all
221
+ # the default parameter values, pass an empty Hash as a request object (see above).
222
+ #
223
+ # @param parent [::String]
224
+ # Required. The resource name of the Location to create the Tensorboard in.
225
+ # Format: `projects/{project}/locations/{location}`
226
+ # @param tensorboard [::Google::Cloud::AIPlatform::V1::Tensorboard, ::Hash]
227
+ # Required. The Tensorboard to create.
228
+ # @yield [result, operation] Access the result along with the TransportOperation object
229
+ # @yieldparam result [::Gapic::Operation]
230
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
231
+ #
232
+ # @return [::Gapic::Operation]
233
+ #
234
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
235
+ #
236
+ # @example Basic example
237
+ # require "google/cloud/ai_platform/v1"
238
+ #
239
+ # # Create a client object. The client can be reused for multiple calls.
240
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
241
+ #
242
+ # # Create a request. To set request fields, pass in keyword arguments.
243
+ # request = Google::Cloud::AIPlatform::V1::CreateTensorboardRequest.new
244
+ #
245
+ # # Call the create_tensorboard method.
246
+ # result = client.create_tensorboard request
247
+ #
248
+ # # The returned object is of type Gapic::Operation. You can use it to
249
+ # # check the status of an operation, cancel it, or wait for results.
250
+ # # Here is how to wait for a response.
251
+ # result.wait_until_done! timeout: 60
252
+ # if result.response?
253
+ # p result.response
254
+ # else
255
+ # puts "No response received."
256
+ # end
257
+ #
258
+ def create_tensorboard request, options = nil
259
+ raise ::ArgumentError, "request must be provided" if request.nil?
260
+
261
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateTensorboardRequest
262
+
263
+ # Converts hash and nil to an options object
264
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
265
+
266
+ # Customize the options with defaults
267
+ call_metadata = @config.rpcs.create_tensorboard.metadata.to_h
268
+
269
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
270
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
271
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
272
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
273
+ transports_version_send: [:rest]
274
+
275
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
276
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
277
+
278
+ options.apply_defaults timeout: @config.rpcs.create_tensorboard.timeout,
279
+ metadata: call_metadata,
280
+ retry_policy: @config.rpcs.create_tensorboard.retry_policy
281
+
282
+ options.apply_defaults timeout: @config.timeout,
283
+ metadata: @config.metadata,
284
+ retry_policy: @config.retry_policy
285
+
286
+ @tensorboard_service_stub.create_tensorboard request, options do |result, operation|
287
+ result = ::Gapic::Operation.new result, @operations_client, options: options
288
+ yield result, operation if block_given?
289
+ return result
290
+ end
291
+ rescue ::Gapic::Rest::Error => e
292
+ raise ::Google::Cloud::Error.from_error(e)
293
+ end
294
+
295
+ ##
296
+ # Gets a Tensorboard.
297
+ #
298
+ # @overload get_tensorboard(request, options = nil)
299
+ # Pass arguments to `get_tensorboard` via a request object, either of type
300
+ # {::Google::Cloud::AIPlatform::V1::GetTensorboardRequest} or an equivalent Hash.
301
+ #
302
+ # @param request [::Google::Cloud::AIPlatform::V1::GetTensorboardRequest, ::Hash]
303
+ # A request object representing the call parameters. Required. To specify no
304
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
305
+ # @param options [::Gapic::CallOptions, ::Hash]
306
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
307
+ #
308
+ # @overload get_tensorboard(name: nil)
309
+ # Pass arguments to `get_tensorboard` via keyword arguments. Note that at
310
+ # least one keyword argument is required. To specify no parameters, or to keep all
311
+ # the default parameter values, pass an empty Hash as a request object (see above).
312
+ #
313
+ # @param name [::String]
314
+ # Required. The name of the Tensorboard resource.
315
+ # Format:
316
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
317
+ # @yield [result, operation] Access the result along with the TransportOperation object
318
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::Tensorboard]
319
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
320
+ #
321
+ # @return [::Google::Cloud::AIPlatform::V1::Tensorboard]
322
+ #
323
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
324
+ #
325
+ # @example Basic example
326
+ # require "google/cloud/ai_platform/v1"
327
+ #
328
+ # # Create a client object. The client can be reused for multiple calls.
329
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
330
+ #
331
+ # # Create a request. To set request fields, pass in keyword arguments.
332
+ # request = Google::Cloud::AIPlatform::V1::GetTensorboardRequest.new
333
+ #
334
+ # # Call the get_tensorboard method.
335
+ # result = client.get_tensorboard request
336
+ #
337
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::Tensorboard.
338
+ # p result
339
+ #
340
+ def get_tensorboard request, options = nil
341
+ raise ::ArgumentError, "request must be provided" if request.nil?
342
+
343
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetTensorboardRequest
344
+
345
+ # Converts hash and nil to an options object
346
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
347
+
348
+ # Customize the options with defaults
349
+ call_metadata = @config.rpcs.get_tensorboard.metadata.to_h
350
+
351
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
352
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
353
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
354
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
355
+ transports_version_send: [:rest]
356
+
357
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
358
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
359
+
360
+ options.apply_defaults timeout: @config.rpcs.get_tensorboard.timeout,
361
+ metadata: call_metadata,
362
+ retry_policy: @config.rpcs.get_tensorboard.retry_policy
363
+
364
+ options.apply_defaults timeout: @config.timeout,
365
+ metadata: @config.metadata,
366
+ retry_policy: @config.retry_policy
367
+
368
+ @tensorboard_service_stub.get_tensorboard request, options do |result, operation|
369
+ yield result, operation if block_given?
370
+ return result
371
+ end
372
+ rescue ::Gapic::Rest::Error => e
373
+ raise ::Google::Cloud::Error.from_error(e)
374
+ end
375
+
376
+ ##
377
+ # Updates a Tensorboard.
378
+ #
379
+ # @overload update_tensorboard(request, options = nil)
380
+ # Pass arguments to `update_tensorboard` via a request object, either of type
381
+ # {::Google::Cloud::AIPlatform::V1::UpdateTensorboardRequest} or an equivalent Hash.
382
+ #
383
+ # @param request [::Google::Cloud::AIPlatform::V1::UpdateTensorboardRequest, ::Hash]
384
+ # A request object representing the call parameters. Required. To specify no
385
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
386
+ # @param options [::Gapic::CallOptions, ::Hash]
387
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
388
+ #
389
+ # @overload update_tensorboard(update_mask: nil, tensorboard: nil)
390
+ # Pass arguments to `update_tensorboard` via keyword arguments. Note that at
391
+ # least one keyword argument is required. To specify no parameters, or to keep all
392
+ # the default parameter values, pass an empty Hash as a request object (see above).
393
+ #
394
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
395
+ # Required. Field mask is used to specify the fields to be overwritten in the
396
+ # Tensorboard resource by the update.
397
+ # The fields specified in the update_mask are relative to the resource, not
398
+ # the full request. A field is overwritten if it's in the mask. If the
399
+ # user does not provide a mask then all fields are overwritten if new
400
+ # values are specified.
401
+ # @param tensorboard [::Google::Cloud::AIPlatform::V1::Tensorboard, ::Hash]
402
+ # Required. The Tensorboard's `name` field is used to identify the
403
+ # Tensorboard to be updated. Format:
404
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
405
+ # @yield [result, operation] Access the result along with the TransportOperation object
406
+ # @yieldparam result [::Gapic::Operation]
407
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
408
+ #
409
+ # @return [::Gapic::Operation]
410
+ #
411
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
412
+ #
413
+ # @example Basic example
414
+ # require "google/cloud/ai_platform/v1"
415
+ #
416
+ # # Create a client object. The client can be reused for multiple calls.
417
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
418
+ #
419
+ # # Create a request. To set request fields, pass in keyword arguments.
420
+ # request = Google::Cloud::AIPlatform::V1::UpdateTensorboardRequest.new
421
+ #
422
+ # # Call the update_tensorboard method.
423
+ # result = client.update_tensorboard request
424
+ #
425
+ # # The returned object is of type Gapic::Operation. You can use it to
426
+ # # check the status of an operation, cancel it, or wait for results.
427
+ # # Here is how to wait for a response.
428
+ # result.wait_until_done! timeout: 60
429
+ # if result.response?
430
+ # p result.response
431
+ # else
432
+ # puts "No response received."
433
+ # end
434
+ #
435
+ def update_tensorboard request, options = nil
436
+ raise ::ArgumentError, "request must be provided" if request.nil?
437
+
438
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::UpdateTensorboardRequest
439
+
440
+ # Converts hash and nil to an options object
441
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
442
+
443
+ # Customize the options with defaults
444
+ call_metadata = @config.rpcs.update_tensorboard.metadata.to_h
445
+
446
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
447
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
448
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
449
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
450
+ transports_version_send: [:rest]
451
+
452
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
453
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
454
+
455
+ options.apply_defaults timeout: @config.rpcs.update_tensorboard.timeout,
456
+ metadata: call_metadata,
457
+ retry_policy: @config.rpcs.update_tensorboard.retry_policy
458
+
459
+ options.apply_defaults timeout: @config.timeout,
460
+ metadata: @config.metadata,
461
+ retry_policy: @config.retry_policy
462
+
463
+ @tensorboard_service_stub.update_tensorboard request, options do |result, operation|
464
+ result = ::Gapic::Operation.new result, @operations_client, options: options
465
+ yield result, operation if block_given?
466
+ return result
467
+ end
468
+ rescue ::Gapic::Rest::Error => e
469
+ raise ::Google::Cloud::Error.from_error(e)
470
+ end
471
+
472
+ ##
473
+ # Lists Tensorboards in a Location.
474
+ #
475
+ # @overload list_tensorboards(request, options = nil)
476
+ # Pass arguments to `list_tensorboards` via a request object, either of type
477
+ # {::Google::Cloud::AIPlatform::V1::ListTensorboardsRequest} or an equivalent Hash.
478
+ #
479
+ # @param request [::Google::Cloud::AIPlatform::V1::ListTensorboardsRequest, ::Hash]
480
+ # A request object representing the call parameters. Required. To specify no
481
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
482
+ # @param options [::Gapic::CallOptions, ::Hash]
483
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
484
+ #
485
+ # @overload list_tensorboards(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil)
486
+ # Pass arguments to `list_tensorboards` via keyword arguments. Note that at
487
+ # least one keyword argument is required. To specify no parameters, or to keep all
488
+ # the default parameter values, pass an empty Hash as a request object (see above).
489
+ #
490
+ # @param parent [::String]
491
+ # Required. The resource name of the Location to list Tensorboards.
492
+ # Format:
493
+ # `projects/{project}/locations/{location}`
494
+ # @param filter [::String]
495
+ # Lists the Tensorboards that match the filter expression.
496
+ # @param page_size [::Integer]
497
+ # The maximum number of Tensorboards to return. The service may return
498
+ # fewer than this value. If unspecified, at most 100 Tensorboards are
499
+ # returned. The maximum value is 100; values above 100 are coerced to
500
+ # 100.
501
+ # @param page_token [::String]
502
+ # A page token, received from a previous
503
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client#list_tensorboards TensorboardService.ListTensorboards}
504
+ # call. Provide this to retrieve the subsequent page.
505
+ #
506
+ # When paginating, all other parameters provided to
507
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client#list_tensorboards TensorboardService.ListTensorboards}
508
+ # must match the call that provided the page token.
509
+ # @param order_by [::String]
510
+ # Field to use to sort the list.
511
+ # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
512
+ # Mask specifying which fields to read.
513
+ # @yield [result, operation] Access the result along with the TransportOperation object
514
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Tensorboard>]
515
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
516
+ #
517
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Tensorboard>]
518
+ #
519
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
520
+ #
521
+ # @example Basic example
522
+ # require "google/cloud/ai_platform/v1"
523
+ #
524
+ # # Create a client object. The client can be reused for multiple calls.
525
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
526
+ #
527
+ # # Create a request. To set request fields, pass in keyword arguments.
528
+ # request = Google::Cloud::AIPlatform::V1::ListTensorboardsRequest.new
529
+ #
530
+ # # Call the list_tensorboards method.
531
+ # result = client.list_tensorboards request
532
+ #
533
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
534
+ # # over elements, and API calls will be issued to fetch pages as needed.
535
+ # result.each do |item|
536
+ # # Each element is of type ::Google::Cloud::AIPlatform::V1::Tensorboard.
537
+ # p item
538
+ # end
539
+ #
540
+ def list_tensorboards request, options = nil
541
+ raise ::ArgumentError, "request must be provided" if request.nil?
542
+
543
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListTensorboardsRequest
544
+
545
+ # Converts hash and nil to an options object
546
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
547
+
548
+ # Customize the options with defaults
549
+ call_metadata = @config.rpcs.list_tensorboards.metadata.to_h
550
+
551
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
552
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
553
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
554
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
555
+ transports_version_send: [:rest]
556
+
557
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
558
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
559
+
560
+ options.apply_defaults timeout: @config.rpcs.list_tensorboards.timeout,
561
+ metadata: call_metadata,
562
+ retry_policy: @config.rpcs.list_tensorboards.retry_policy
563
+
564
+ options.apply_defaults timeout: @config.timeout,
565
+ metadata: @config.metadata,
566
+ retry_policy: @config.retry_policy
567
+
568
+ @tensorboard_service_stub.list_tensorboards request, options do |result, operation|
569
+ result = ::Gapic::Rest::PagedEnumerable.new @tensorboard_service_stub, :list_tensorboards, "tensorboards", request, result, options
570
+ yield result, operation if block_given?
571
+ return result
572
+ end
573
+ rescue ::Gapic::Rest::Error => e
574
+ raise ::Google::Cloud::Error.from_error(e)
575
+ end
576
+
577
+ ##
578
+ # Deletes a Tensorboard.
579
+ #
580
+ # @overload delete_tensorboard(request, options = nil)
581
+ # Pass arguments to `delete_tensorboard` via a request object, either of type
582
+ # {::Google::Cloud::AIPlatform::V1::DeleteTensorboardRequest} or an equivalent Hash.
583
+ #
584
+ # @param request [::Google::Cloud::AIPlatform::V1::DeleteTensorboardRequest, ::Hash]
585
+ # A request object representing the call parameters. Required. To specify no
586
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
587
+ # @param options [::Gapic::CallOptions, ::Hash]
588
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
589
+ #
590
+ # @overload delete_tensorboard(name: nil)
591
+ # Pass arguments to `delete_tensorboard` via keyword arguments. Note that at
592
+ # least one keyword argument is required. To specify no parameters, or to keep all
593
+ # the default parameter values, pass an empty Hash as a request object (see above).
594
+ #
595
+ # @param name [::String]
596
+ # Required. The name of the Tensorboard to be deleted.
597
+ # Format:
598
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
599
+ # @yield [result, operation] Access the result along with the TransportOperation object
600
+ # @yieldparam result [::Gapic::Operation]
601
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
602
+ #
603
+ # @return [::Gapic::Operation]
604
+ #
605
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
606
+ #
607
+ # @example Basic example
608
+ # require "google/cloud/ai_platform/v1"
609
+ #
610
+ # # Create a client object. The client can be reused for multiple calls.
611
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
612
+ #
613
+ # # Create a request. To set request fields, pass in keyword arguments.
614
+ # request = Google::Cloud::AIPlatform::V1::DeleteTensorboardRequest.new
615
+ #
616
+ # # Call the delete_tensorboard method.
617
+ # result = client.delete_tensorboard request
618
+ #
619
+ # # The returned object is of type Gapic::Operation. You can use it to
620
+ # # check the status of an operation, cancel it, or wait for results.
621
+ # # Here is how to wait for a response.
622
+ # result.wait_until_done! timeout: 60
623
+ # if result.response?
624
+ # p result.response
625
+ # else
626
+ # puts "No response received."
627
+ # end
628
+ #
629
+ def delete_tensorboard request, options = nil
630
+ raise ::ArgumentError, "request must be provided" if request.nil?
631
+
632
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteTensorboardRequest
633
+
634
+ # Converts hash and nil to an options object
635
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
636
+
637
+ # Customize the options with defaults
638
+ call_metadata = @config.rpcs.delete_tensorboard.metadata.to_h
639
+
640
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
641
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
642
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
643
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
644
+ transports_version_send: [:rest]
645
+
646
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
647
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
648
+
649
+ options.apply_defaults timeout: @config.rpcs.delete_tensorboard.timeout,
650
+ metadata: call_metadata,
651
+ retry_policy: @config.rpcs.delete_tensorboard.retry_policy
652
+
653
+ options.apply_defaults timeout: @config.timeout,
654
+ metadata: @config.metadata,
655
+ retry_policy: @config.retry_policy
656
+
657
+ @tensorboard_service_stub.delete_tensorboard request, options do |result, operation|
658
+ result = ::Gapic::Operation.new result, @operations_client, options: options
659
+ yield result, operation if block_given?
660
+ return result
661
+ end
662
+ rescue ::Gapic::Rest::Error => e
663
+ raise ::Google::Cloud::Error.from_error(e)
664
+ end
665
+
666
+ ##
667
+ # Returns a list of monthly active users for a given TensorBoard instance.
668
+ #
669
+ # @overload read_tensorboard_usage(request, options = nil)
670
+ # Pass arguments to `read_tensorboard_usage` via a request object, either of type
671
+ # {::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageRequest} or an equivalent Hash.
672
+ #
673
+ # @param request [::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageRequest, ::Hash]
674
+ # A request object representing the call parameters. Required. To specify no
675
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
676
+ # @param options [::Gapic::CallOptions, ::Hash]
677
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
678
+ #
679
+ # @overload read_tensorboard_usage(tensorboard: nil)
680
+ # Pass arguments to `read_tensorboard_usage` via keyword arguments. Note that at
681
+ # least one keyword argument is required. To specify no parameters, or to keep all
682
+ # the default parameter values, pass an empty Hash as a request object (see above).
683
+ #
684
+ # @param tensorboard [::String]
685
+ # Required. The name of the Tensorboard resource.
686
+ # Format:
687
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
688
+ # @yield [result, operation] Access the result along with the TransportOperation object
689
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageResponse]
690
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
691
+ #
692
+ # @return [::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageResponse]
693
+ #
694
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
695
+ #
696
+ # @example Basic example
697
+ # require "google/cloud/ai_platform/v1"
698
+ #
699
+ # # Create a client object. The client can be reused for multiple calls.
700
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
701
+ #
702
+ # # Create a request. To set request fields, pass in keyword arguments.
703
+ # request = Google::Cloud::AIPlatform::V1::ReadTensorboardUsageRequest.new
704
+ #
705
+ # # Call the read_tensorboard_usage method.
706
+ # result = client.read_tensorboard_usage request
707
+ #
708
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::ReadTensorboardUsageResponse.
709
+ # p result
710
+ #
711
+ def read_tensorboard_usage request, options = nil
712
+ raise ::ArgumentError, "request must be provided" if request.nil?
713
+
714
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageRequest
715
+
716
+ # Converts hash and nil to an options object
717
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
718
+
719
+ # Customize the options with defaults
720
+ call_metadata = @config.rpcs.read_tensorboard_usage.metadata.to_h
721
+
722
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
723
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
724
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
725
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
726
+ transports_version_send: [:rest]
727
+
728
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
729
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
730
+
731
+ options.apply_defaults timeout: @config.rpcs.read_tensorboard_usage.timeout,
732
+ metadata: call_metadata,
733
+ retry_policy: @config.rpcs.read_tensorboard_usage.retry_policy
734
+
735
+ options.apply_defaults timeout: @config.timeout,
736
+ metadata: @config.metadata,
737
+ retry_policy: @config.retry_policy
738
+
739
+ @tensorboard_service_stub.read_tensorboard_usage request, options do |result, operation|
740
+ yield result, operation if block_given?
741
+ return result
742
+ end
743
+ rescue ::Gapic::Rest::Error => e
744
+ raise ::Google::Cloud::Error.from_error(e)
745
+ end
746
+
747
+ ##
748
+ # Returns the storage size for a given TensorBoard instance.
749
+ #
750
+ # @overload read_tensorboard_size(request, options = nil)
751
+ # Pass arguments to `read_tensorboard_size` via a request object, either of type
752
+ # {::Google::Cloud::AIPlatform::V1::ReadTensorboardSizeRequest} or an equivalent Hash.
753
+ #
754
+ # @param request [::Google::Cloud::AIPlatform::V1::ReadTensorboardSizeRequest, ::Hash]
755
+ # A request object representing the call parameters. Required. To specify no
756
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
757
+ # @param options [::Gapic::CallOptions, ::Hash]
758
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
759
+ #
760
+ # @overload read_tensorboard_size(tensorboard: nil)
761
+ # Pass arguments to `read_tensorboard_size` via keyword arguments. Note that at
762
+ # least one keyword argument is required. To specify no parameters, or to keep all
763
+ # the default parameter values, pass an empty Hash as a request object (see above).
764
+ #
765
+ # @param tensorboard [::String]
766
+ # Required. The name of the Tensorboard resource.
767
+ # Format:
768
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
769
+ # @yield [result, operation] Access the result along with the TransportOperation object
770
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::ReadTensorboardSizeResponse]
771
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
772
+ #
773
+ # @return [::Google::Cloud::AIPlatform::V1::ReadTensorboardSizeResponse]
774
+ #
775
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
776
+ #
777
+ # @example Basic example
778
+ # require "google/cloud/ai_platform/v1"
779
+ #
780
+ # # Create a client object. The client can be reused for multiple calls.
781
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
782
+ #
783
+ # # Create a request. To set request fields, pass in keyword arguments.
784
+ # request = Google::Cloud::AIPlatform::V1::ReadTensorboardSizeRequest.new
785
+ #
786
+ # # Call the read_tensorboard_size method.
787
+ # result = client.read_tensorboard_size request
788
+ #
789
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::ReadTensorboardSizeResponse.
790
+ # p result
791
+ #
792
+ def read_tensorboard_size request, options = nil
793
+ raise ::ArgumentError, "request must be provided" if request.nil?
794
+
795
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ReadTensorboardSizeRequest
796
+
797
+ # Converts hash and nil to an options object
798
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
799
+
800
+ # Customize the options with defaults
801
+ call_metadata = @config.rpcs.read_tensorboard_size.metadata.to_h
802
+
803
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
804
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
805
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
806
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
807
+ transports_version_send: [:rest]
808
+
809
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
810
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
811
+
812
+ options.apply_defaults timeout: @config.rpcs.read_tensorboard_size.timeout,
813
+ metadata: call_metadata,
814
+ retry_policy: @config.rpcs.read_tensorboard_size.retry_policy
815
+
816
+ options.apply_defaults timeout: @config.timeout,
817
+ metadata: @config.metadata,
818
+ retry_policy: @config.retry_policy
819
+
820
+ @tensorboard_service_stub.read_tensorboard_size request, options do |result, operation|
821
+ yield result, operation if block_given?
822
+ return result
823
+ end
824
+ rescue ::Gapic::Rest::Error => e
825
+ raise ::Google::Cloud::Error.from_error(e)
826
+ end
827
+
828
+ ##
829
+ # Creates a TensorboardExperiment.
830
+ #
831
+ # @overload create_tensorboard_experiment(request, options = nil)
832
+ # Pass arguments to `create_tensorboard_experiment` via a request object, either of type
833
+ # {::Google::Cloud::AIPlatform::V1::CreateTensorboardExperimentRequest} or an equivalent Hash.
834
+ #
835
+ # @param request [::Google::Cloud::AIPlatform::V1::CreateTensorboardExperimentRequest, ::Hash]
836
+ # A request object representing the call parameters. Required. To specify no
837
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
838
+ # @param options [::Gapic::CallOptions, ::Hash]
839
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
840
+ #
841
+ # @overload create_tensorboard_experiment(parent: nil, tensorboard_experiment: nil, tensorboard_experiment_id: nil)
842
+ # Pass arguments to `create_tensorboard_experiment` via keyword arguments. Note that at
843
+ # least one keyword argument is required. To specify no parameters, or to keep all
844
+ # the default parameter values, pass an empty Hash as a request object (see above).
845
+ #
846
+ # @param parent [::String]
847
+ # Required. The resource name of the Tensorboard to create the
848
+ # TensorboardExperiment in. Format:
849
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
850
+ # @param tensorboard_experiment [::Google::Cloud::AIPlatform::V1::TensorboardExperiment, ::Hash]
851
+ # The TensorboardExperiment to create.
852
+ # @param tensorboard_experiment_id [::String]
853
+ # Required. The ID to use for the Tensorboard experiment, which becomes the
854
+ # final component of the Tensorboard experiment's resource name.
855
+ #
856
+ # This value should be 1-128 characters, and valid characters
857
+ # are `/[a-z][0-9]-/`.
858
+ # @yield [result, operation] Access the result along with the TransportOperation object
859
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::TensorboardExperiment]
860
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
861
+ #
862
+ # @return [::Google::Cloud::AIPlatform::V1::TensorboardExperiment]
863
+ #
864
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
865
+ #
866
+ # @example Basic example
867
+ # require "google/cloud/ai_platform/v1"
868
+ #
869
+ # # Create a client object. The client can be reused for multiple calls.
870
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
871
+ #
872
+ # # Create a request. To set request fields, pass in keyword arguments.
873
+ # request = Google::Cloud::AIPlatform::V1::CreateTensorboardExperimentRequest.new
874
+ #
875
+ # # Call the create_tensorboard_experiment method.
876
+ # result = client.create_tensorboard_experiment request
877
+ #
878
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardExperiment.
879
+ # p result
880
+ #
881
+ def create_tensorboard_experiment request, options = nil
882
+ raise ::ArgumentError, "request must be provided" if request.nil?
883
+
884
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateTensorboardExperimentRequest
885
+
886
+ # Converts hash and nil to an options object
887
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
888
+
889
+ # Customize the options with defaults
890
+ call_metadata = @config.rpcs.create_tensorboard_experiment.metadata.to_h
891
+
892
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
893
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
894
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
895
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
896
+ transports_version_send: [:rest]
897
+
898
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
899
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
900
+
901
+ options.apply_defaults timeout: @config.rpcs.create_tensorboard_experiment.timeout,
902
+ metadata: call_metadata,
903
+ retry_policy: @config.rpcs.create_tensorboard_experiment.retry_policy
904
+
905
+ options.apply_defaults timeout: @config.timeout,
906
+ metadata: @config.metadata,
907
+ retry_policy: @config.retry_policy
908
+
909
+ @tensorboard_service_stub.create_tensorboard_experiment request, options do |result, operation|
910
+ yield result, operation if block_given?
911
+ return result
912
+ end
913
+ rescue ::Gapic::Rest::Error => e
914
+ raise ::Google::Cloud::Error.from_error(e)
915
+ end
916
+
917
+ ##
918
+ # Gets a TensorboardExperiment.
919
+ #
920
+ # @overload get_tensorboard_experiment(request, options = nil)
921
+ # Pass arguments to `get_tensorboard_experiment` via a request object, either of type
922
+ # {::Google::Cloud::AIPlatform::V1::GetTensorboardExperimentRequest} or an equivalent Hash.
923
+ #
924
+ # @param request [::Google::Cloud::AIPlatform::V1::GetTensorboardExperimentRequest, ::Hash]
925
+ # A request object representing the call parameters. Required. To specify no
926
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
927
+ # @param options [::Gapic::CallOptions, ::Hash]
928
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
929
+ #
930
+ # @overload get_tensorboard_experiment(name: nil)
931
+ # Pass arguments to `get_tensorboard_experiment` via keyword arguments. Note that at
932
+ # least one keyword argument is required. To specify no parameters, or to keep all
933
+ # the default parameter values, pass an empty Hash as a request object (see above).
934
+ #
935
+ # @param name [::String]
936
+ # Required. The name of the TensorboardExperiment resource.
937
+ # Format:
938
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
939
+ # @yield [result, operation] Access the result along with the TransportOperation object
940
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::TensorboardExperiment]
941
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
942
+ #
943
+ # @return [::Google::Cloud::AIPlatform::V1::TensorboardExperiment]
944
+ #
945
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
946
+ #
947
+ # @example Basic example
948
+ # require "google/cloud/ai_platform/v1"
949
+ #
950
+ # # Create a client object. The client can be reused for multiple calls.
951
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
952
+ #
953
+ # # Create a request. To set request fields, pass in keyword arguments.
954
+ # request = Google::Cloud::AIPlatform::V1::GetTensorboardExperimentRequest.new
955
+ #
956
+ # # Call the get_tensorboard_experiment method.
957
+ # result = client.get_tensorboard_experiment request
958
+ #
959
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardExperiment.
960
+ # p result
961
+ #
962
+ def get_tensorboard_experiment request, options = nil
963
+ raise ::ArgumentError, "request must be provided" if request.nil?
964
+
965
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetTensorboardExperimentRequest
966
+
967
+ # Converts hash and nil to an options object
968
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
969
+
970
+ # Customize the options with defaults
971
+ call_metadata = @config.rpcs.get_tensorboard_experiment.metadata.to_h
972
+
973
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
974
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
975
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
976
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
977
+ transports_version_send: [:rest]
978
+
979
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
980
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
981
+
982
+ options.apply_defaults timeout: @config.rpcs.get_tensorboard_experiment.timeout,
983
+ metadata: call_metadata,
984
+ retry_policy: @config.rpcs.get_tensorboard_experiment.retry_policy
985
+
986
+ options.apply_defaults timeout: @config.timeout,
987
+ metadata: @config.metadata,
988
+ retry_policy: @config.retry_policy
989
+
990
+ @tensorboard_service_stub.get_tensorboard_experiment request, options do |result, operation|
991
+ yield result, operation if block_given?
992
+ return result
993
+ end
994
+ rescue ::Gapic::Rest::Error => e
995
+ raise ::Google::Cloud::Error.from_error(e)
996
+ end
997
+
998
+ ##
999
+ # Updates a TensorboardExperiment.
1000
+ #
1001
+ # @overload update_tensorboard_experiment(request, options = nil)
1002
+ # Pass arguments to `update_tensorboard_experiment` via a request object, either of type
1003
+ # {::Google::Cloud::AIPlatform::V1::UpdateTensorboardExperimentRequest} or an equivalent Hash.
1004
+ #
1005
+ # @param request [::Google::Cloud::AIPlatform::V1::UpdateTensorboardExperimentRequest, ::Hash]
1006
+ # A request object representing the call parameters. Required. To specify no
1007
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1008
+ # @param options [::Gapic::CallOptions, ::Hash]
1009
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1010
+ #
1011
+ # @overload update_tensorboard_experiment(update_mask: nil, tensorboard_experiment: nil)
1012
+ # Pass arguments to `update_tensorboard_experiment` via keyword arguments. Note that at
1013
+ # least one keyword argument is required. To specify no parameters, or to keep all
1014
+ # the default parameter values, pass an empty Hash as a request object (see above).
1015
+ #
1016
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1017
+ # Required. Field mask is used to specify the fields to be overwritten in the
1018
+ # TensorboardExperiment resource by the update.
1019
+ # The fields specified in the update_mask are relative to the resource, not
1020
+ # the full request. A field is overwritten if it's in the mask. If the
1021
+ # user does not provide a mask then all fields are overwritten if new
1022
+ # values are specified.
1023
+ # @param tensorboard_experiment [::Google::Cloud::AIPlatform::V1::TensorboardExperiment, ::Hash]
1024
+ # Required. The TensorboardExperiment's `name` field is used to identify the
1025
+ # TensorboardExperiment to be updated. Format:
1026
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
1027
+ # @yield [result, operation] Access the result along with the TransportOperation object
1028
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::TensorboardExperiment]
1029
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1030
+ #
1031
+ # @return [::Google::Cloud::AIPlatform::V1::TensorboardExperiment]
1032
+ #
1033
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1034
+ #
1035
+ # @example Basic example
1036
+ # require "google/cloud/ai_platform/v1"
1037
+ #
1038
+ # # Create a client object. The client can be reused for multiple calls.
1039
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
1040
+ #
1041
+ # # Create a request. To set request fields, pass in keyword arguments.
1042
+ # request = Google::Cloud::AIPlatform::V1::UpdateTensorboardExperimentRequest.new
1043
+ #
1044
+ # # Call the update_tensorboard_experiment method.
1045
+ # result = client.update_tensorboard_experiment request
1046
+ #
1047
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardExperiment.
1048
+ # p result
1049
+ #
1050
+ def update_tensorboard_experiment request, options = nil
1051
+ raise ::ArgumentError, "request must be provided" if request.nil?
1052
+
1053
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::UpdateTensorboardExperimentRequest
1054
+
1055
+ # Converts hash and nil to an options object
1056
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1057
+
1058
+ # Customize the options with defaults
1059
+ call_metadata = @config.rpcs.update_tensorboard_experiment.metadata.to_h
1060
+
1061
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1062
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1063
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1064
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
1065
+ transports_version_send: [:rest]
1066
+
1067
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1068
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1069
+
1070
+ options.apply_defaults timeout: @config.rpcs.update_tensorboard_experiment.timeout,
1071
+ metadata: call_metadata,
1072
+ retry_policy: @config.rpcs.update_tensorboard_experiment.retry_policy
1073
+
1074
+ options.apply_defaults timeout: @config.timeout,
1075
+ metadata: @config.metadata,
1076
+ retry_policy: @config.retry_policy
1077
+
1078
+ @tensorboard_service_stub.update_tensorboard_experiment request, options do |result, operation|
1079
+ yield result, operation if block_given?
1080
+ return result
1081
+ end
1082
+ rescue ::Gapic::Rest::Error => e
1083
+ raise ::Google::Cloud::Error.from_error(e)
1084
+ end
1085
+
1086
+ ##
1087
+ # Lists TensorboardExperiments in a Location.
1088
+ #
1089
+ # @overload list_tensorboard_experiments(request, options = nil)
1090
+ # Pass arguments to `list_tensorboard_experiments` via a request object, either of type
1091
+ # {::Google::Cloud::AIPlatform::V1::ListTensorboardExperimentsRequest} or an equivalent Hash.
1092
+ #
1093
+ # @param request [::Google::Cloud::AIPlatform::V1::ListTensorboardExperimentsRequest, ::Hash]
1094
+ # A request object representing the call parameters. Required. To specify no
1095
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1096
+ # @param options [::Gapic::CallOptions, ::Hash]
1097
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1098
+ #
1099
+ # @overload list_tensorboard_experiments(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil)
1100
+ # Pass arguments to `list_tensorboard_experiments` via keyword arguments. Note that at
1101
+ # least one keyword argument is required. To specify no parameters, or to keep all
1102
+ # the default parameter values, pass an empty Hash as a request object (see above).
1103
+ #
1104
+ # @param parent [::String]
1105
+ # Required. The resource name of the Tensorboard to list
1106
+ # TensorboardExperiments. Format:
1107
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
1108
+ # @param filter [::String]
1109
+ # Lists the TensorboardExperiments that match the filter expression.
1110
+ # @param page_size [::Integer]
1111
+ # The maximum number of TensorboardExperiments to return. The service may
1112
+ # return fewer than this value. If unspecified, at most 50
1113
+ # TensorboardExperiments are returned. The maximum value is 1000; values
1114
+ # above 1000 are coerced to 1000.
1115
+ # @param page_token [::String]
1116
+ # A page token, received from a previous
1117
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client#list_tensorboard_experiments TensorboardService.ListTensorboardExperiments}
1118
+ # call. Provide this to retrieve the subsequent page.
1119
+ #
1120
+ # When paginating, all other parameters provided to
1121
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client#list_tensorboard_experiments TensorboardService.ListTensorboardExperiments}
1122
+ # must match the call that provided the page token.
1123
+ # @param order_by [::String]
1124
+ # Field to use to sort the list.
1125
+ # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
1126
+ # Mask specifying which fields to read.
1127
+ # @yield [result, operation] Access the result along with the TransportOperation object
1128
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardExperiment>]
1129
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1130
+ #
1131
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardExperiment>]
1132
+ #
1133
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1134
+ #
1135
+ # @example Basic example
1136
+ # require "google/cloud/ai_platform/v1"
1137
+ #
1138
+ # # Create a client object. The client can be reused for multiple calls.
1139
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
1140
+ #
1141
+ # # Create a request. To set request fields, pass in keyword arguments.
1142
+ # request = Google::Cloud::AIPlatform::V1::ListTensorboardExperimentsRequest.new
1143
+ #
1144
+ # # Call the list_tensorboard_experiments method.
1145
+ # result = client.list_tensorboard_experiments request
1146
+ #
1147
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1148
+ # # over elements, and API calls will be issued to fetch pages as needed.
1149
+ # result.each do |item|
1150
+ # # Each element is of type ::Google::Cloud::AIPlatform::V1::TensorboardExperiment.
1151
+ # p item
1152
+ # end
1153
+ #
1154
+ def list_tensorboard_experiments request, options = nil
1155
+ raise ::ArgumentError, "request must be provided" if request.nil?
1156
+
1157
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListTensorboardExperimentsRequest
1158
+
1159
+ # Converts hash and nil to an options object
1160
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1161
+
1162
+ # Customize the options with defaults
1163
+ call_metadata = @config.rpcs.list_tensorboard_experiments.metadata.to_h
1164
+
1165
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1166
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1167
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1168
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
1169
+ transports_version_send: [:rest]
1170
+
1171
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1172
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1173
+
1174
+ options.apply_defaults timeout: @config.rpcs.list_tensorboard_experiments.timeout,
1175
+ metadata: call_metadata,
1176
+ retry_policy: @config.rpcs.list_tensorboard_experiments.retry_policy
1177
+
1178
+ options.apply_defaults timeout: @config.timeout,
1179
+ metadata: @config.metadata,
1180
+ retry_policy: @config.retry_policy
1181
+
1182
+ @tensorboard_service_stub.list_tensorboard_experiments request, options do |result, operation|
1183
+ result = ::Gapic::Rest::PagedEnumerable.new @tensorboard_service_stub, :list_tensorboard_experiments, "tensorboard_experiments", request, result, options
1184
+ yield result, operation if block_given?
1185
+ return result
1186
+ end
1187
+ rescue ::Gapic::Rest::Error => e
1188
+ raise ::Google::Cloud::Error.from_error(e)
1189
+ end
1190
+
1191
+ ##
1192
+ # Deletes a TensorboardExperiment.
1193
+ #
1194
+ # @overload delete_tensorboard_experiment(request, options = nil)
1195
+ # Pass arguments to `delete_tensorboard_experiment` via a request object, either of type
1196
+ # {::Google::Cloud::AIPlatform::V1::DeleteTensorboardExperimentRequest} or an equivalent Hash.
1197
+ #
1198
+ # @param request [::Google::Cloud::AIPlatform::V1::DeleteTensorboardExperimentRequest, ::Hash]
1199
+ # A request object representing the call parameters. Required. To specify no
1200
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1201
+ # @param options [::Gapic::CallOptions, ::Hash]
1202
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1203
+ #
1204
+ # @overload delete_tensorboard_experiment(name: nil)
1205
+ # Pass arguments to `delete_tensorboard_experiment` via keyword arguments. Note that at
1206
+ # least one keyword argument is required. To specify no parameters, or to keep all
1207
+ # the default parameter values, pass an empty Hash as a request object (see above).
1208
+ #
1209
+ # @param name [::String]
1210
+ # Required. The name of the TensorboardExperiment to be deleted.
1211
+ # Format:
1212
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
1213
+ # @yield [result, operation] Access the result along with the TransportOperation object
1214
+ # @yieldparam result [::Gapic::Operation]
1215
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1216
+ #
1217
+ # @return [::Gapic::Operation]
1218
+ #
1219
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1220
+ #
1221
+ # @example Basic example
1222
+ # require "google/cloud/ai_platform/v1"
1223
+ #
1224
+ # # Create a client object. The client can be reused for multiple calls.
1225
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
1226
+ #
1227
+ # # Create a request. To set request fields, pass in keyword arguments.
1228
+ # request = Google::Cloud::AIPlatform::V1::DeleteTensorboardExperimentRequest.new
1229
+ #
1230
+ # # Call the delete_tensorboard_experiment method.
1231
+ # result = client.delete_tensorboard_experiment request
1232
+ #
1233
+ # # The returned object is of type Gapic::Operation. You can use it to
1234
+ # # check the status of an operation, cancel it, or wait for results.
1235
+ # # Here is how to wait for a response.
1236
+ # result.wait_until_done! timeout: 60
1237
+ # if result.response?
1238
+ # p result.response
1239
+ # else
1240
+ # puts "No response received."
1241
+ # end
1242
+ #
1243
+ def delete_tensorboard_experiment request, options = nil
1244
+ raise ::ArgumentError, "request must be provided" if request.nil?
1245
+
1246
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteTensorboardExperimentRequest
1247
+
1248
+ # Converts hash and nil to an options object
1249
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1250
+
1251
+ # Customize the options with defaults
1252
+ call_metadata = @config.rpcs.delete_tensorboard_experiment.metadata.to_h
1253
+
1254
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1255
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1256
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1257
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
1258
+ transports_version_send: [:rest]
1259
+
1260
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1261
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1262
+
1263
+ options.apply_defaults timeout: @config.rpcs.delete_tensorboard_experiment.timeout,
1264
+ metadata: call_metadata,
1265
+ retry_policy: @config.rpcs.delete_tensorboard_experiment.retry_policy
1266
+
1267
+ options.apply_defaults timeout: @config.timeout,
1268
+ metadata: @config.metadata,
1269
+ retry_policy: @config.retry_policy
1270
+
1271
+ @tensorboard_service_stub.delete_tensorboard_experiment request, options do |result, operation|
1272
+ result = ::Gapic::Operation.new result, @operations_client, options: options
1273
+ yield result, operation if block_given?
1274
+ return result
1275
+ end
1276
+ rescue ::Gapic::Rest::Error => e
1277
+ raise ::Google::Cloud::Error.from_error(e)
1278
+ end
1279
+
1280
+ ##
1281
+ # Creates a TensorboardRun.
1282
+ #
1283
+ # @overload create_tensorboard_run(request, options = nil)
1284
+ # Pass arguments to `create_tensorboard_run` via a request object, either of type
1285
+ # {::Google::Cloud::AIPlatform::V1::CreateTensorboardRunRequest} or an equivalent Hash.
1286
+ #
1287
+ # @param request [::Google::Cloud::AIPlatform::V1::CreateTensorboardRunRequest, ::Hash]
1288
+ # A request object representing the call parameters. Required. To specify no
1289
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1290
+ # @param options [::Gapic::CallOptions, ::Hash]
1291
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1292
+ #
1293
+ # @overload create_tensorboard_run(parent: nil, tensorboard_run: nil, tensorboard_run_id: nil)
1294
+ # Pass arguments to `create_tensorboard_run` via keyword arguments. Note that at
1295
+ # least one keyword argument is required. To specify no parameters, or to keep all
1296
+ # the default parameter values, pass an empty Hash as a request object (see above).
1297
+ #
1298
+ # @param parent [::String]
1299
+ # Required. The resource name of the TensorboardExperiment to create the
1300
+ # TensorboardRun in. Format:
1301
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
1302
+ # @param tensorboard_run [::Google::Cloud::AIPlatform::V1::TensorboardRun, ::Hash]
1303
+ # Required. The TensorboardRun to create.
1304
+ # @param tensorboard_run_id [::String]
1305
+ # Required. The ID to use for the Tensorboard run, which becomes the final
1306
+ # component of the Tensorboard run's resource name.
1307
+ #
1308
+ # This value should be 1-128 characters, and valid characters
1309
+ # are `/[a-z][0-9]-/`.
1310
+ # @yield [result, operation] Access the result along with the TransportOperation object
1311
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::TensorboardRun]
1312
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1313
+ #
1314
+ # @return [::Google::Cloud::AIPlatform::V1::TensorboardRun]
1315
+ #
1316
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1317
+ #
1318
+ # @example Basic example
1319
+ # require "google/cloud/ai_platform/v1"
1320
+ #
1321
+ # # Create a client object. The client can be reused for multiple calls.
1322
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
1323
+ #
1324
+ # # Create a request. To set request fields, pass in keyword arguments.
1325
+ # request = Google::Cloud::AIPlatform::V1::CreateTensorboardRunRequest.new
1326
+ #
1327
+ # # Call the create_tensorboard_run method.
1328
+ # result = client.create_tensorboard_run request
1329
+ #
1330
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardRun.
1331
+ # p result
1332
+ #
1333
+ def create_tensorboard_run request, options = nil
1334
+ raise ::ArgumentError, "request must be provided" if request.nil?
1335
+
1336
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateTensorboardRunRequest
1337
+
1338
+ # Converts hash and nil to an options object
1339
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1340
+
1341
+ # Customize the options with defaults
1342
+ call_metadata = @config.rpcs.create_tensorboard_run.metadata.to_h
1343
+
1344
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1345
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1346
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1347
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
1348
+ transports_version_send: [:rest]
1349
+
1350
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1351
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1352
+
1353
+ options.apply_defaults timeout: @config.rpcs.create_tensorboard_run.timeout,
1354
+ metadata: call_metadata,
1355
+ retry_policy: @config.rpcs.create_tensorboard_run.retry_policy
1356
+
1357
+ options.apply_defaults timeout: @config.timeout,
1358
+ metadata: @config.metadata,
1359
+ retry_policy: @config.retry_policy
1360
+
1361
+ @tensorboard_service_stub.create_tensorboard_run request, options do |result, operation|
1362
+ yield result, operation if block_given?
1363
+ return result
1364
+ end
1365
+ rescue ::Gapic::Rest::Error => e
1366
+ raise ::Google::Cloud::Error.from_error(e)
1367
+ end
1368
+
1369
+ ##
1370
+ # Batch create TensorboardRuns.
1371
+ #
1372
+ # @overload batch_create_tensorboard_runs(request, options = nil)
1373
+ # Pass arguments to `batch_create_tensorboard_runs` via a request object, either of type
1374
+ # {::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsRequest} or an equivalent Hash.
1375
+ #
1376
+ # @param request [::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsRequest, ::Hash]
1377
+ # A request object representing the call parameters. Required. To specify no
1378
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1379
+ # @param options [::Gapic::CallOptions, ::Hash]
1380
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1381
+ #
1382
+ # @overload batch_create_tensorboard_runs(parent: nil, requests: nil)
1383
+ # Pass arguments to `batch_create_tensorboard_runs` via keyword arguments. Note that at
1384
+ # least one keyword argument is required. To specify no parameters, or to keep all
1385
+ # the default parameter values, pass an empty Hash as a request object (see above).
1386
+ #
1387
+ # @param parent [::String]
1388
+ # Required. The resource name of the TensorboardExperiment to create the
1389
+ # TensorboardRuns in. Format:
1390
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
1391
+ # The parent field in the CreateTensorboardRunRequest messages must match
1392
+ # this field.
1393
+ # @param requests [::Array<::Google::Cloud::AIPlatform::V1::CreateTensorboardRunRequest, ::Hash>]
1394
+ # Required. The request message specifying the TensorboardRuns to create.
1395
+ # A maximum of 1000 TensorboardRuns can be created in a batch.
1396
+ # @yield [result, operation] Access the result along with the TransportOperation object
1397
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsResponse]
1398
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1399
+ #
1400
+ # @return [::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsResponse]
1401
+ #
1402
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1403
+ #
1404
+ # @example Basic example
1405
+ # require "google/cloud/ai_platform/v1"
1406
+ #
1407
+ # # Create a client object. The client can be reused for multiple calls.
1408
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
1409
+ #
1410
+ # # Create a request. To set request fields, pass in keyword arguments.
1411
+ # request = Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsRequest.new
1412
+ #
1413
+ # # Call the batch_create_tensorboard_runs method.
1414
+ # result = client.batch_create_tensorboard_runs request
1415
+ #
1416
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsResponse.
1417
+ # p result
1418
+ #
1419
+ def batch_create_tensorboard_runs request, options = nil
1420
+ raise ::ArgumentError, "request must be provided" if request.nil?
1421
+
1422
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsRequest
1423
+
1424
+ # Converts hash and nil to an options object
1425
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1426
+
1427
+ # Customize the options with defaults
1428
+ call_metadata = @config.rpcs.batch_create_tensorboard_runs.metadata.to_h
1429
+
1430
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1431
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1432
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1433
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
1434
+ transports_version_send: [:rest]
1435
+
1436
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1437
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1438
+
1439
+ options.apply_defaults timeout: @config.rpcs.batch_create_tensorboard_runs.timeout,
1440
+ metadata: call_metadata,
1441
+ retry_policy: @config.rpcs.batch_create_tensorboard_runs.retry_policy
1442
+
1443
+ options.apply_defaults timeout: @config.timeout,
1444
+ metadata: @config.metadata,
1445
+ retry_policy: @config.retry_policy
1446
+
1447
+ @tensorboard_service_stub.batch_create_tensorboard_runs request, options do |result, operation|
1448
+ yield result, operation if block_given?
1449
+ return result
1450
+ end
1451
+ rescue ::Gapic::Rest::Error => e
1452
+ raise ::Google::Cloud::Error.from_error(e)
1453
+ end
1454
+
1455
+ ##
1456
+ # Gets a TensorboardRun.
1457
+ #
1458
+ # @overload get_tensorboard_run(request, options = nil)
1459
+ # Pass arguments to `get_tensorboard_run` via a request object, either of type
1460
+ # {::Google::Cloud::AIPlatform::V1::GetTensorboardRunRequest} or an equivalent Hash.
1461
+ #
1462
+ # @param request [::Google::Cloud::AIPlatform::V1::GetTensorboardRunRequest, ::Hash]
1463
+ # A request object representing the call parameters. Required. To specify no
1464
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1465
+ # @param options [::Gapic::CallOptions, ::Hash]
1466
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1467
+ #
1468
+ # @overload get_tensorboard_run(name: nil)
1469
+ # Pass arguments to `get_tensorboard_run` via keyword arguments. Note that at
1470
+ # least one keyword argument is required. To specify no parameters, or to keep all
1471
+ # the default parameter values, pass an empty Hash as a request object (see above).
1472
+ #
1473
+ # @param name [::String]
1474
+ # Required. The name of the TensorboardRun resource.
1475
+ # Format:
1476
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
1477
+ # @yield [result, operation] Access the result along with the TransportOperation object
1478
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::TensorboardRun]
1479
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1480
+ #
1481
+ # @return [::Google::Cloud::AIPlatform::V1::TensorboardRun]
1482
+ #
1483
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1484
+ #
1485
+ # @example Basic example
1486
+ # require "google/cloud/ai_platform/v1"
1487
+ #
1488
+ # # Create a client object. The client can be reused for multiple calls.
1489
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
1490
+ #
1491
+ # # Create a request. To set request fields, pass in keyword arguments.
1492
+ # request = Google::Cloud::AIPlatform::V1::GetTensorboardRunRequest.new
1493
+ #
1494
+ # # Call the get_tensorboard_run method.
1495
+ # result = client.get_tensorboard_run request
1496
+ #
1497
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardRun.
1498
+ # p result
1499
+ #
1500
+ def get_tensorboard_run request, options = nil
1501
+ raise ::ArgumentError, "request must be provided" if request.nil?
1502
+
1503
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetTensorboardRunRequest
1504
+
1505
+ # Converts hash and nil to an options object
1506
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1507
+
1508
+ # Customize the options with defaults
1509
+ call_metadata = @config.rpcs.get_tensorboard_run.metadata.to_h
1510
+
1511
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1512
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1513
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1514
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
1515
+ transports_version_send: [:rest]
1516
+
1517
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1518
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1519
+
1520
+ options.apply_defaults timeout: @config.rpcs.get_tensorboard_run.timeout,
1521
+ metadata: call_metadata,
1522
+ retry_policy: @config.rpcs.get_tensorboard_run.retry_policy
1523
+
1524
+ options.apply_defaults timeout: @config.timeout,
1525
+ metadata: @config.metadata,
1526
+ retry_policy: @config.retry_policy
1527
+
1528
+ @tensorboard_service_stub.get_tensorboard_run request, options do |result, operation|
1529
+ yield result, operation if block_given?
1530
+ return result
1531
+ end
1532
+ rescue ::Gapic::Rest::Error => e
1533
+ raise ::Google::Cloud::Error.from_error(e)
1534
+ end
1535
+
1536
+ ##
1537
+ # Updates a TensorboardRun.
1538
+ #
1539
+ # @overload update_tensorboard_run(request, options = nil)
1540
+ # Pass arguments to `update_tensorboard_run` via a request object, either of type
1541
+ # {::Google::Cloud::AIPlatform::V1::UpdateTensorboardRunRequest} or an equivalent Hash.
1542
+ #
1543
+ # @param request [::Google::Cloud::AIPlatform::V1::UpdateTensorboardRunRequest, ::Hash]
1544
+ # A request object representing the call parameters. Required. To specify no
1545
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1546
+ # @param options [::Gapic::CallOptions, ::Hash]
1547
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1548
+ #
1549
+ # @overload update_tensorboard_run(update_mask: nil, tensorboard_run: nil)
1550
+ # Pass arguments to `update_tensorboard_run` via keyword arguments. Note that at
1551
+ # least one keyword argument is required. To specify no parameters, or to keep all
1552
+ # the default parameter values, pass an empty Hash as a request object (see above).
1553
+ #
1554
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1555
+ # Required. Field mask is used to specify the fields to be overwritten in the
1556
+ # TensorboardRun resource by the update.
1557
+ # The fields specified in the update_mask are relative to the resource, not
1558
+ # the full request. A field is overwritten if it's in the mask. If the
1559
+ # user does not provide a mask then all fields are overwritten if new
1560
+ # values are specified.
1561
+ # @param tensorboard_run [::Google::Cloud::AIPlatform::V1::TensorboardRun, ::Hash]
1562
+ # Required. The TensorboardRun's `name` field is used to identify the
1563
+ # TensorboardRun to be updated. Format:
1564
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
1565
+ # @yield [result, operation] Access the result along with the TransportOperation object
1566
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::TensorboardRun]
1567
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1568
+ #
1569
+ # @return [::Google::Cloud::AIPlatform::V1::TensorboardRun]
1570
+ #
1571
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1572
+ #
1573
+ # @example Basic example
1574
+ # require "google/cloud/ai_platform/v1"
1575
+ #
1576
+ # # Create a client object. The client can be reused for multiple calls.
1577
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
1578
+ #
1579
+ # # Create a request. To set request fields, pass in keyword arguments.
1580
+ # request = Google::Cloud::AIPlatform::V1::UpdateTensorboardRunRequest.new
1581
+ #
1582
+ # # Call the update_tensorboard_run method.
1583
+ # result = client.update_tensorboard_run request
1584
+ #
1585
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardRun.
1586
+ # p result
1587
+ #
1588
+ def update_tensorboard_run request, options = nil
1589
+ raise ::ArgumentError, "request must be provided" if request.nil?
1590
+
1591
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::UpdateTensorboardRunRequest
1592
+
1593
+ # Converts hash and nil to an options object
1594
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1595
+
1596
+ # Customize the options with defaults
1597
+ call_metadata = @config.rpcs.update_tensorboard_run.metadata.to_h
1598
+
1599
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1600
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1601
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1602
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
1603
+ transports_version_send: [:rest]
1604
+
1605
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1606
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1607
+
1608
+ options.apply_defaults timeout: @config.rpcs.update_tensorboard_run.timeout,
1609
+ metadata: call_metadata,
1610
+ retry_policy: @config.rpcs.update_tensorboard_run.retry_policy
1611
+
1612
+ options.apply_defaults timeout: @config.timeout,
1613
+ metadata: @config.metadata,
1614
+ retry_policy: @config.retry_policy
1615
+
1616
+ @tensorboard_service_stub.update_tensorboard_run request, options do |result, operation|
1617
+ yield result, operation if block_given?
1618
+ return result
1619
+ end
1620
+ rescue ::Gapic::Rest::Error => e
1621
+ raise ::Google::Cloud::Error.from_error(e)
1622
+ end
1623
+
1624
+ ##
1625
+ # Lists TensorboardRuns in a Location.
1626
+ #
1627
+ # @overload list_tensorboard_runs(request, options = nil)
1628
+ # Pass arguments to `list_tensorboard_runs` via a request object, either of type
1629
+ # {::Google::Cloud::AIPlatform::V1::ListTensorboardRunsRequest} or an equivalent Hash.
1630
+ #
1631
+ # @param request [::Google::Cloud::AIPlatform::V1::ListTensorboardRunsRequest, ::Hash]
1632
+ # A request object representing the call parameters. Required. To specify no
1633
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1634
+ # @param options [::Gapic::CallOptions, ::Hash]
1635
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1636
+ #
1637
+ # @overload list_tensorboard_runs(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil)
1638
+ # Pass arguments to `list_tensorboard_runs` via keyword arguments. Note that at
1639
+ # least one keyword argument is required. To specify no parameters, or to keep all
1640
+ # the default parameter values, pass an empty Hash as a request object (see above).
1641
+ #
1642
+ # @param parent [::String]
1643
+ # Required. The resource name of the TensorboardExperiment to list
1644
+ # TensorboardRuns. Format:
1645
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
1646
+ # @param filter [::String]
1647
+ # Lists the TensorboardRuns that match the filter expression.
1648
+ # @param page_size [::Integer]
1649
+ # The maximum number of TensorboardRuns to return. The service may return
1650
+ # fewer than this value. If unspecified, at most 50 TensorboardRuns are
1651
+ # returned. The maximum value is 1000; values above 1000 are coerced to
1652
+ # 1000.
1653
+ # @param page_token [::String]
1654
+ # A page token, received from a previous
1655
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client#list_tensorboard_runs TensorboardService.ListTensorboardRuns}
1656
+ # call. Provide this to retrieve the subsequent page.
1657
+ #
1658
+ # When paginating, all other parameters provided to
1659
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client#list_tensorboard_runs TensorboardService.ListTensorboardRuns}
1660
+ # must match the call that provided the page token.
1661
+ # @param order_by [::String]
1662
+ # Field to use to sort the list.
1663
+ # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
1664
+ # Mask specifying which fields to read.
1665
+ # @yield [result, operation] Access the result along with the TransportOperation object
1666
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardRun>]
1667
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1668
+ #
1669
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardRun>]
1670
+ #
1671
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1672
+ #
1673
+ # @example Basic example
1674
+ # require "google/cloud/ai_platform/v1"
1675
+ #
1676
+ # # Create a client object. The client can be reused for multiple calls.
1677
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
1678
+ #
1679
+ # # Create a request. To set request fields, pass in keyword arguments.
1680
+ # request = Google::Cloud::AIPlatform::V1::ListTensorboardRunsRequest.new
1681
+ #
1682
+ # # Call the list_tensorboard_runs method.
1683
+ # result = client.list_tensorboard_runs request
1684
+ #
1685
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1686
+ # # over elements, and API calls will be issued to fetch pages as needed.
1687
+ # result.each do |item|
1688
+ # # Each element is of type ::Google::Cloud::AIPlatform::V1::TensorboardRun.
1689
+ # p item
1690
+ # end
1691
+ #
1692
+ def list_tensorboard_runs request, options = nil
1693
+ raise ::ArgumentError, "request must be provided" if request.nil?
1694
+
1695
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListTensorboardRunsRequest
1696
+
1697
+ # Converts hash and nil to an options object
1698
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1699
+
1700
+ # Customize the options with defaults
1701
+ call_metadata = @config.rpcs.list_tensorboard_runs.metadata.to_h
1702
+
1703
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1704
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1705
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1706
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
1707
+ transports_version_send: [:rest]
1708
+
1709
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1710
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1711
+
1712
+ options.apply_defaults timeout: @config.rpcs.list_tensorboard_runs.timeout,
1713
+ metadata: call_metadata,
1714
+ retry_policy: @config.rpcs.list_tensorboard_runs.retry_policy
1715
+
1716
+ options.apply_defaults timeout: @config.timeout,
1717
+ metadata: @config.metadata,
1718
+ retry_policy: @config.retry_policy
1719
+
1720
+ @tensorboard_service_stub.list_tensorboard_runs request, options do |result, operation|
1721
+ result = ::Gapic::Rest::PagedEnumerable.new @tensorboard_service_stub, :list_tensorboard_runs, "tensorboard_runs", request, result, options
1722
+ yield result, operation if block_given?
1723
+ return result
1724
+ end
1725
+ rescue ::Gapic::Rest::Error => e
1726
+ raise ::Google::Cloud::Error.from_error(e)
1727
+ end
1728
+
1729
+ ##
1730
+ # Deletes a TensorboardRun.
1731
+ #
1732
+ # @overload delete_tensorboard_run(request, options = nil)
1733
+ # Pass arguments to `delete_tensorboard_run` via a request object, either of type
1734
+ # {::Google::Cloud::AIPlatform::V1::DeleteTensorboardRunRequest} or an equivalent Hash.
1735
+ #
1736
+ # @param request [::Google::Cloud::AIPlatform::V1::DeleteTensorboardRunRequest, ::Hash]
1737
+ # A request object representing the call parameters. Required. To specify no
1738
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1739
+ # @param options [::Gapic::CallOptions, ::Hash]
1740
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1741
+ #
1742
+ # @overload delete_tensorboard_run(name: nil)
1743
+ # Pass arguments to `delete_tensorboard_run` via keyword arguments. Note that at
1744
+ # least one keyword argument is required. To specify no parameters, or to keep all
1745
+ # the default parameter values, pass an empty Hash as a request object (see above).
1746
+ #
1747
+ # @param name [::String]
1748
+ # Required. The name of the TensorboardRun to be deleted.
1749
+ # Format:
1750
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
1751
+ # @yield [result, operation] Access the result along with the TransportOperation object
1752
+ # @yieldparam result [::Gapic::Operation]
1753
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1754
+ #
1755
+ # @return [::Gapic::Operation]
1756
+ #
1757
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1758
+ #
1759
+ # @example Basic example
1760
+ # require "google/cloud/ai_platform/v1"
1761
+ #
1762
+ # # Create a client object. The client can be reused for multiple calls.
1763
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
1764
+ #
1765
+ # # Create a request. To set request fields, pass in keyword arguments.
1766
+ # request = Google::Cloud::AIPlatform::V1::DeleteTensorboardRunRequest.new
1767
+ #
1768
+ # # Call the delete_tensorboard_run method.
1769
+ # result = client.delete_tensorboard_run request
1770
+ #
1771
+ # # The returned object is of type Gapic::Operation. You can use it to
1772
+ # # check the status of an operation, cancel it, or wait for results.
1773
+ # # Here is how to wait for a response.
1774
+ # result.wait_until_done! timeout: 60
1775
+ # if result.response?
1776
+ # p result.response
1777
+ # else
1778
+ # puts "No response received."
1779
+ # end
1780
+ #
1781
+ def delete_tensorboard_run request, options = nil
1782
+ raise ::ArgumentError, "request must be provided" if request.nil?
1783
+
1784
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteTensorboardRunRequest
1785
+
1786
+ # Converts hash and nil to an options object
1787
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1788
+
1789
+ # Customize the options with defaults
1790
+ call_metadata = @config.rpcs.delete_tensorboard_run.metadata.to_h
1791
+
1792
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1793
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1794
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1795
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
1796
+ transports_version_send: [:rest]
1797
+
1798
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1799
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1800
+
1801
+ options.apply_defaults timeout: @config.rpcs.delete_tensorboard_run.timeout,
1802
+ metadata: call_metadata,
1803
+ retry_policy: @config.rpcs.delete_tensorboard_run.retry_policy
1804
+
1805
+ options.apply_defaults timeout: @config.timeout,
1806
+ metadata: @config.metadata,
1807
+ retry_policy: @config.retry_policy
1808
+
1809
+ @tensorboard_service_stub.delete_tensorboard_run request, options do |result, operation|
1810
+ result = ::Gapic::Operation.new result, @operations_client, options: options
1811
+ yield result, operation if block_given?
1812
+ return result
1813
+ end
1814
+ rescue ::Gapic::Rest::Error => e
1815
+ raise ::Google::Cloud::Error.from_error(e)
1816
+ end
1817
+
1818
+ ##
1819
+ # Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
1820
+ #
1821
+ # @overload batch_create_tensorboard_time_series(request, options = nil)
1822
+ # Pass arguments to `batch_create_tensorboard_time_series` via a request object, either of type
1823
+ # {::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesRequest} or an equivalent Hash.
1824
+ #
1825
+ # @param request [::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesRequest, ::Hash]
1826
+ # A request object representing the call parameters. Required. To specify no
1827
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1828
+ # @param options [::Gapic::CallOptions, ::Hash]
1829
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1830
+ #
1831
+ # @overload batch_create_tensorboard_time_series(parent: nil, requests: nil)
1832
+ # Pass arguments to `batch_create_tensorboard_time_series` via keyword arguments. Note that at
1833
+ # least one keyword argument is required. To specify no parameters, or to keep all
1834
+ # the default parameter values, pass an empty Hash as a request object (see above).
1835
+ #
1836
+ # @param parent [::String]
1837
+ # Required. The resource name of the TensorboardExperiment to create the
1838
+ # TensorboardTimeSeries in.
1839
+ # Format:
1840
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
1841
+ # The TensorboardRuns referenced by the parent fields in the
1842
+ # CreateTensorboardTimeSeriesRequest messages must be sub resources of this
1843
+ # TensorboardExperiment.
1844
+ # @param requests [::Array<::Google::Cloud::AIPlatform::V1::CreateTensorboardTimeSeriesRequest, ::Hash>]
1845
+ # Required. The request message specifying the TensorboardTimeSeries to
1846
+ # create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.
1847
+ # @yield [result, operation] Access the result along with the TransportOperation object
1848
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesResponse]
1849
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1850
+ #
1851
+ # @return [::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesResponse]
1852
+ #
1853
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1854
+ #
1855
+ # @example Basic example
1856
+ # require "google/cloud/ai_platform/v1"
1857
+ #
1858
+ # # Create a client object. The client can be reused for multiple calls.
1859
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
1860
+ #
1861
+ # # Create a request. To set request fields, pass in keyword arguments.
1862
+ # request = Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesRequest.new
1863
+ #
1864
+ # # Call the batch_create_tensorboard_time_series method.
1865
+ # result = client.batch_create_tensorboard_time_series request
1866
+ #
1867
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesResponse.
1868
+ # p result
1869
+ #
1870
+ def batch_create_tensorboard_time_series request, options = nil
1871
+ raise ::ArgumentError, "request must be provided" if request.nil?
1872
+
1873
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesRequest
1874
+
1875
+ # Converts hash and nil to an options object
1876
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1877
+
1878
+ # Customize the options with defaults
1879
+ call_metadata = @config.rpcs.batch_create_tensorboard_time_series.metadata.to_h
1880
+
1881
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1882
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1883
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1884
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
1885
+ transports_version_send: [:rest]
1886
+
1887
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1888
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1889
+
1890
+ options.apply_defaults timeout: @config.rpcs.batch_create_tensorboard_time_series.timeout,
1891
+ metadata: call_metadata,
1892
+ retry_policy: @config.rpcs.batch_create_tensorboard_time_series.retry_policy
1893
+
1894
+ options.apply_defaults timeout: @config.timeout,
1895
+ metadata: @config.metadata,
1896
+ retry_policy: @config.retry_policy
1897
+
1898
+ @tensorboard_service_stub.batch_create_tensorboard_time_series request, options do |result, operation|
1899
+ yield result, operation if block_given?
1900
+ return result
1901
+ end
1902
+ rescue ::Gapic::Rest::Error => e
1903
+ raise ::Google::Cloud::Error.from_error(e)
1904
+ end
1905
+
1906
+ ##
1907
+ # Creates a TensorboardTimeSeries.
1908
+ #
1909
+ # @overload create_tensorboard_time_series(request, options = nil)
1910
+ # Pass arguments to `create_tensorboard_time_series` via a request object, either of type
1911
+ # {::Google::Cloud::AIPlatform::V1::CreateTensorboardTimeSeriesRequest} or an equivalent Hash.
1912
+ #
1913
+ # @param request [::Google::Cloud::AIPlatform::V1::CreateTensorboardTimeSeriesRequest, ::Hash]
1914
+ # A request object representing the call parameters. Required. To specify no
1915
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1916
+ # @param options [::Gapic::CallOptions, ::Hash]
1917
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1918
+ #
1919
+ # @overload create_tensorboard_time_series(parent: nil, tensorboard_time_series_id: nil, tensorboard_time_series: nil)
1920
+ # Pass arguments to `create_tensorboard_time_series` via keyword arguments. Note that at
1921
+ # least one keyword argument is required. To specify no parameters, or to keep all
1922
+ # the default parameter values, pass an empty Hash as a request object (see above).
1923
+ #
1924
+ # @param parent [::String]
1925
+ # Required. The resource name of the TensorboardRun to create the
1926
+ # TensorboardTimeSeries in.
1927
+ # Format:
1928
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
1929
+ # @param tensorboard_time_series_id [::String]
1930
+ # Optional. The user specified unique ID to use for the
1931
+ # TensorboardTimeSeries, which becomes the final component of the
1932
+ # TensorboardTimeSeries's resource name. This value should match
1933
+ # "[a-z0-9][a-z0-9-]\\{0, 127}"
1934
+ # @param tensorboard_time_series [::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries, ::Hash]
1935
+ # Required. The TensorboardTimeSeries to create.
1936
+ # @yield [result, operation] Access the result along with the TransportOperation object
1937
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries]
1938
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1939
+ #
1940
+ # @return [::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries]
1941
+ #
1942
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1943
+ #
1944
+ # @example Basic example
1945
+ # require "google/cloud/ai_platform/v1"
1946
+ #
1947
+ # # Create a client object. The client can be reused for multiple calls.
1948
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
1949
+ #
1950
+ # # Create a request. To set request fields, pass in keyword arguments.
1951
+ # request = Google::Cloud::AIPlatform::V1::CreateTensorboardTimeSeriesRequest.new
1952
+ #
1953
+ # # Call the create_tensorboard_time_series method.
1954
+ # result = client.create_tensorboard_time_series request
1955
+ #
1956
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardTimeSeries.
1957
+ # p result
1958
+ #
1959
+ def create_tensorboard_time_series request, options = nil
1960
+ raise ::ArgumentError, "request must be provided" if request.nil?
1961
+
1962
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateTensorboardTimeSeriesRequest
1963
+
1964
+ # Converts hash and nil to an options object
1965
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1966
+
1967
+ # Customize the options with defaults
1968
+ call_metadata = @config.rpcs.create_tensorboard_time_series.metadata.to_h
1969
+
1970
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1971
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1972
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1973
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
1974
+ transports_version_send: [:rest]
1975
+
1976
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1977
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1978
+
1979
+ options.apply_defaults timeout: @config.rpcs.create_tensorboard_time_series.timeout,
1980
+ metadata: call_metadata,
1981
+ retry_policy: @config.rpcs.create_tensorboard_time_series.retry_policy
1982
+
1983
+ options.apply_defaults timeout: @config.timeout,
1984
+ metadata: @config.metadata,
1985
+ retry_policy: @config.retry_policy
1986
+
1987
+ @tensorboard_service_stub.create_tensorboard_time_series request, options do |result, operation|
1988
+ yield result, operation if block_given?
1989
+ return result
1990
+ end
1991
+ rescue ::Gapic::Rest::Error => e
1992
+ raise ::Google::Cloud::Error.from_error(e)
1993
+ end
1994
+
1995
+ ##
1996
+ # Gets a TensorboardTimeSeries.
1997
+ #
1998
+ # @overload get_tensorboard_time_series(request, options = nil)
1999
+ # Pass arguments to `get_tensorboard_time_series` via a request object, either of type
2000
+ # {::Google::Cloud::AIPlatform::V1::GetTensorboardTimeSeriesRequest} or an equivalent Hash.
2001
+ #
2002
+ # @param request [::Google::Cloud::AIPlatform::V1::GetTensorboardTimeSeriesRequest, ::Hash]
2003
+ # A request object representing the call parameters. Required. To specify no
2004
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2005
+ # @param options [::Gapic::CallOptions, ::Hash]
2006
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2007
+ #
2008
+ # @overload get_tensorboard_time_series(name: nil)
2009
+ # Pass arguments to `get_tensorboard_time_series` via keyword arguments. Note that at
2010
+ # least one keyword argument is required. To specify no parameters, or to keep all
2011
+ # the default parameter values, pass an empty Hash as a request object (see above).
2012
+ #
2013
+ # @param name [::String]
2014
+ # Required. The name of the TensorboardTimeSeries resource.
2015
+ # Format:
2016
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
2017
+ # @yield [result, operation] Access the result along with the TransportOperation object
2018
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries]
2019
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2020
+ #
2021
+ # @return [::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries]
2022
+ #
2023
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2024
+ #
2025
+ # @example Basic example
2026
+ # require "google/cloud/ai_platform/v1"
2027
+ #
2028
+ # # Create a client object. The client can be reused for multiple calls.
2029
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
2030
+ #
2031
+ # # Create a request. To set request fields, pass in keyword arguments.
2032
+ # request = Google::Cloud::AIPlatform::V1::GetTensorboardTimeSeriesRequest.new
2033
+ #
2034
+ # # Call the get_tensorboard_time_series method.
2035
+ # result = client.get_tensorboard_time_series request
2036
+ #
2037
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardTimeSeries.
2038
+ # p result
2039
+ #
2040
+ def get_tensorboard_time_series request, options = nil
2041
+ raise ::ArgumentError, "request must be provided" if request.nil?
2042
+
2043
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetTensorboardTimeSeriesRequest
2044
+
2045
+ # Converts hash and nil to an options object
2046
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2047
+
2048
+ # Customize the options with defaults
2049
+ call_metadata = @config.rpcs.get_tensorboard_time_series.metadata.to_h
2050
+
2051
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2052
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2053
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2054
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
2055
+ transports_version_send: [:rest]
2056
+
2057
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2058
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2059
+
2060
+ options.apply_defaults timeout: @config.rpcs.get_tensorboard_time_series.timeout,
2061
+ metadata: call_metadata,
2062
+ retry_policy: @config.rpcs.get_tensorboard_time_series.retry_policy
2063
+
2064
+ options.apply_defaults timeout: @config.timeout,
2065
+ metadata: @config.metadata,
2066
+ retry_policy: @config.retry_policy
2067
+
2068
+ @tensorboard_service_stub.get_tensorboard_time_series request, options do |result, operation|
2069
+ yield result, operation if block_given?
2070
+ return result
2071
+ end
2072
+ rescue ::Gapic::Rest::Error => e
2073
+ raise ::Google::Cloud::Error.from_error(e)
2074
+ end
2075
+
2076
+ ##
2077
+ # Updates a TensorboardTimeSeries.
2078
+ #
2079
+ # @overload update_tensorboard_time_series(request, options = nil)
2080
+ # Pass arguments to `update_tensorboard_time_series` via a request object, either of type
2081
+ # {::Google::Cloud::AIPlatform::V1::UpdateTensorboardTimeSeriesRequest} or an equivalent Hash.
2082
+ #
2083
+ # @param request [::Google::Cloud::AIPlatform::V1::UpdateTensorboardTimeSeriesRequest, ::Hash]
2084
+ # A request object representing the call parameters. Required. To specify no
2085
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2086
+ # @param options [::Gapic::CallOptions, ::Hash]
2087
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2088
+ #
2089
+ # @overload update_tensorboard_time_series(update_mask: nil, tensorboard_time_series: nil)
2090
+ # Pass arguments to `update_tensorboard_time_series` via keyword arguments. Note that at
2091
+ # least one keyword argument is required. To specify no parameters, or to keep all
2092
+ # the default parameter values, pass an empty Hash as a request object (see above).
2093
+ #
2094
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2095
+ # Required. Field mask is used to specify the fields to be overwritten in the
2096
+ # TensorboardTimeSeries resource by the update.
2097
+ # The fields specified in the update_mask are relative to the resource, not
2098
+ # the full request. A field is overwritten if it's in the mask. If the
2099
+ # user does not provide a mask then all fields are overwritten if new
2100
+ # values are specified.
2101
+ # @param tensorboard_time_series [::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries, ::Hash]
2102
+ # Required. The TensorboardTimeSeries' `name` field is used to identify the
2103
+ # TensorboardTimeSeries to be updated.
2104
+ # Format:
2105
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
2106
+ # @yield [result, operation] Access the result along with the TransportOperation object
2107
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries]
2108
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2109
+ #
2110
+ # @return [::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries]
2111
+ #
2112
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2113
+ #
2114
+ # @example Basic example
2115
+ # require "google/cloud/ai_platform/v1"
2116
+ #
2117
+ # # Create a client object. The client can be reused for multiple calls.
2118
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
2119
+ #
2120
+ # # Create a request. To set request fields, pass in keyword arguments.
2121
+ # request = Google::Cloud::AIPlatform::V1::UpdateTensorboardTimeSeriesRequest.new
2122
+ #
2123
+ # # Call the update_tensorboard_time_series method.
2124
+ # result = client.update_tensorboard_time_series request
2125
+ #
2126
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardTimeSeries.
2127
+ # p result
2128
+ #
2129
+ def update_tensorboard_time_series request, options = nil
2130
+ raise ::ArgumentError, "request must be provided" if request.nil?
2131
+
2132
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::UpdateTensorboardTimeSeriesRequest
2133
+
2134
+ # Converts hash and nil to an options object
2135
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2136
+
2137
+ # Customize the options with defaults
2138
+ call_metadata = @config.rpcs.update_tensorboard_time_series.metadata.to_h
2139
+
2140
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2141
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2142
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2143
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
2144
+ transports_version_send: [:rest]
2145
+
2146
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2147
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2148
+
2149
+ options.apply_defaults timeout: @config.rpcs.update_tensorboard_time_series.timeout,
2150
+ metadata: call_metadata,
2151
+ retry_policy: @config.rpcs.update_tensorboard_time_series.retry_policy
2152
+
2153
+ options.apply_defaults timeout: @config.timeout,
2154
+ metadata: @config.metadata,
2155
+ retry_policy: @config.retry_policy
2156
+
2157
+ @tensorboard_service_stub.update_tensorboard_time_series request, options do |result, operation|
2158
+ yield result, operation if block_given?
2159
+ return result
2160
+ end
2161
+ rescue ::Gapic::Rest::Error => e
2162
+ raise ::Google::Cloud::Error.from_error(e)
2163
+ end
2164
+
2165
+ ##
2166
+ # Lists TensorboardTimeSeries in a Location.
2167
+ #
2168
+ # @overload list_tensorboard_time_series(request, options = nil)
2169
+ # Pass arguments to `list_tensorboard_time_series` via a request object, either of type
2170
+ # {::Google::Cloud::AIPlatform::V1::ListTensorboardTimeSeriesRequest} or an equivalent Hash.
2171
+ #
2172
+ # @param request [::Google::Cloud::AIPlatform::V1::ListTensorboardTimeSeriesRequest, ::Hash]
2173
+ # A request object representing the call parameters. Required. To specify no
2174
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2175
+ # @param options [::Gapic::CallOptions, ::Hash]
2176
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2177
+ #
2178
+ # @overload list_tensorboard_time_series(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil)
2179
+ # Pass arguments to `list_tensorboard_time_series` via keyword arguments. Note that at
2180
+ # least one keyword argument is required. To specify no parameters, or to keep all
2181
+ # the default parameter values, pass an empty Hash as a request object (see above).
2182
+ #
2183
+ # @param parent [::String]
2184
+ # Required. The resource name of the TensorboardRun to list
2185
+ # TensorboardTimeSeries. Format:
2186
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
2187
+ # @param filter [::String]
2188
+ # Lists the TensorboardTimeSeries that match the filter expression.
2189
+ # @param page_size [::Integer]
2190
+ # The maximum number of TensorboardTimeSeries to return. The service may
2191
+ # return fewer than this value. If unspecified, at most 50
2192
+ # TensorboardTimeSeries are returned. The maximum value is 1000; values
2193
+ # above 1000 are coerced to 1000.
2194
+ # @param page_token [::String]
2195
+ # A page token, received from a previous
2196
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client#list_tensorboard_time_series TensorboardService.ListTensorboardTimeSeries}
2197
+ # call. Provide this to retrieve the subsequent page.
2198
+ #
2199
+ # When paginating, all other parameters provided to
2200
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client#list_tensorboard_time_series TensorboardService.ListTensorboardTimeSeries}
2201
+ # must match the call that provided the page token.
2202
+ # @param order_by [::String]
2203
+ # Field to use to sort the list.
2204
+ # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
2205
+ # Mask specifying which fields to read.
2206
+ # @yield [result, operation] Access the result along with the TransportOperation object
2207
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries>]
2208
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2209
+ #
2210
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries>]
2211
+ #
2212
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2213
+ #
2214
+ # @example Basic example
2215
+ # require "google/cloud/ai_platform/v1"
2216
+ #
2217
+ # # Create a client object. The client can be reused for multiple calls.
2218
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
2219
+ #
2220
+ # # Create a request. To set request fields, pass in keyword arguments.
2221
+ # request = Google::Cloud::AIPlatform::V1::ListTensorboardTimeSeriesRequest.new
2222
+ #
2223
+ # # Call the list_tensorboard_time_series method.
2224
+ # result = client.list_tensorboard_time_series request
2225
+ #
2226
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2227
+ # # over elements, and API calls will be issued to fetch pages as needed.
2228
+ # result.each do |item|
2229
+ # # Each element is of type ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries.
2230
+ # p item
2231
+ # end
2232
+ #
2233
+ def list_tensorboard_time_series request, options = nil
2234
+ raise ::ArgumentError, "request must be provided" if request.nil?
2235
+
2236
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListTensorboardTimeSeriesRequest
2237
+
2238
+ # Converts hash and nil to an options object
2239
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2240
+
2241
+ # Customize the options with defaults
2242
+ call_metadata = @config.rpcs.list_tensorboard_time_series.metadata.to_h
2243
+
2244
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2245
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2246
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2247
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
2248
+ transports_version_send: [:rest]
2249
+
2250
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2251
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2252
+
2253
+ options.apply_defaults timeout: @config.rpcs.list_tensorboard_time_series.timeout,
2254
+ metadata: call_metadata,
2255
+ retry_policy: @config.rpcs.list_tensorboard_time_series.retry_policy
2256
+
2257
+ options.apply_defaults timeout: @config.timeout,
2258
+ metadata: @config.metadata,
2259
+ retry_policy: @config.retry_policy
2260
+
2261
+ @tensorboard_service_stub.list_tensorboard_time_series request, options do |result, operation|
2262
+ result = ::Gapic::Rest::PagedEnumerable.new @tensorboard_service_stub, :list_tensorboard_time_series, "tensorboard_time_series", request, result, options
2263
+ yield result, operation if block_given?
2264
+ return result
2265
+ end
2266
+ rescue ::Gapic::Rest::Error => e
2267
+ raise ::Google::Cloud::Error.from_error(e)
2268
+ end
2269
+
2270
+ ##
2271
+ # Deletes a TensorboardTimeSeries.
2272
+ #
2273
+ # @overload delete_tensorboard_time_series(request, options = nil)
2274
+ # Pass arguments to `delete_tensorboard_time_series` via a request object, either of type
2275
+ # {::Google::Cloud::AIPlatform::V1::DeleteTensorboardTimeSeriesRequest} or an equivalent Hash.
2276
+ #
2277
+ # @param request [::Google::Cloud::AIPlatform::V1::DeleteTensorboardTimeSeriesRequest, ::Hash]
2278
+ # A request object representing the call parameters. Required. To specify no
2279
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2280
+ # @param options [::Gapic::CallOptions, ::Hash]
2281
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2282
+ #
2283
+ # @overload delete_tensorboard_time_series(name: nil)
2284
+ # Pass arguments to `delete_tensorboard_time_series` via keyword arguments. Note that at
2285
+ # least one keyword argument is required. To specify no parameters, or to keep all
2286
+ # the default parameter values, pass an empty Hash as a request object (see above).
2287
+ #
2288
+ # @param name [::String]
2289
+ # Required. The name of the TensorboardTimeSeries to be deleted.
2290
+ # Format:
2291
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
2292
+ # @yield [result, operation] Access the result along with the TransportOperation object
2293
+ # @yieldparam result [::Gapic::Operation]
2294
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2295
+ #
2296
+ # @return [::Gapic::Operation]
2297
+ #
2298
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2299
+ #
2300
+ # @example Basic example
2301
+ # require "google/cloud/ai_platform/v1"
2302
+ #
2303
+ # # Create a client object. The client can be reused for multiple calls.
2304
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
2305
+ #
2306
+ # # Create a request. To set request fields, pass in keyword arguments.
2307
+ # request = Google::Cloud::AIPlatform::V1::DeleteTensorboardTimeSeriesRequest.new
2308
+ #
2309
+ # # Call the delete_tensorboard_time_series method.
2310
+ # result = client.delete_tensorboard_time_series request
2311
+ #
2312
+ # # The returned object is of type Gapic::Operation. You can use it to
2313
+ # # check the status of an operation, cancel it, or wait for results.
2314
+ # # Here is how to wait for a response.
2315
+ # result.wait_until_done! timeout: 60
2316
+ # if result.response?
2317
+ # p result.response
2318
+ # else
2319
+ # puts "No response received."
2320
+ # end
2321
+ #
2322
+ def delete_tensorboard_time_series request, options = nil
2323
+ raise ::ArgumentError, "request must be provided" if request.nil?
2324
+
2325
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteTensorboardTimeSeriesRequest
2326
+
2327
+ # Converts hash and nil to an options object
2328
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2329
+
2330
+ # Customize the options with defaults
2331
+ call_metadata = @config.rpcs.delete_tensorboard_time_series.metadata.to_h
2332
+
2333
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2334
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2335
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2336
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
2337
+ transports_version_send: [:rest]
2338
+
2339
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2340
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2341
+
2342
+ options.apply_defaults timeout: @config.rpcs.delete_tensorboard_time_series.timeout,
2343
+ metadata: call_metadata,
2344
+ retry_policy: @config.rpcs.delete_tensorboard_time_series.retry_policy
2345
+
2346
+ options.apply_defaults timeout: @config.timeout,
2347
+ metadata: @config.metadata,
2348
+ retry_policy: @config.retry_policy
2349
+
2350
+ @tensorboard_service_stub.delete_tensorboard_time_series request, options do |result, operation|
2351
+ result = ::Gapic::Operation.new result, @operations_client, options: options
2352
+ yield result, operation if block_given?
2353
+ return result
2354
+ end
2355
+ rescue ::Gapic::Rest::Error => e
2356
+ raise ::Google::Cloud::Error.from_error(e)
2357
+ end
2358
+
2359
+ ##
2360
+ # Reads multiple TensorboardTimeSeries' data. The data point number limit is
2361
+ # 1000 for scalars, 100 for tensors and blob references. If the number of
2362
+ # data points stored is less than the limit, all data is returned.
2363
+ # Otherwise, the number limit of data points is randomly selected from
2364
+ # this time series and returned.
2365
+ #
2366
+ # @overload batch_read_tensorboard_time_series_data(request, options = nil)
2367
+ # Pass arguments to `batch_read_tensorboard_time_series_data` via a request object, either of type
2368
+ # {::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataRequest} or an equivalent Hash.
2369
+ #
2370
+ # @param request [::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataRequest, ::Hash]
2371
+ # A request object representing the call parameters. Required. To specify no
2372
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2373
+ # @param options [::Gapic::CallOptions, ::Hash]
2374
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2375
+ #
2376
+ # @overload batch_read_tensorboard_time_series_data(tensorboard: nil, time_series: nil)
2377
+ # Pass arguments to `batch_read_tensorboard_time_series_data` via keyword arguments. Note that at
2378
+ # least one keyword argument is required. To specify no parameters, or to keep all
2379
+ # the default parameter values, pass an empty Hash as a request object (see above).
2380
+ #
2381
+ # @param tensorboard [::String]
2382
+ # Required. The resource name of the Tensorboard containing
2383
+ # TensorboardTimeSeries to read data from. Format:
2384
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}`.
2385
+ # The TensorboardTimeSeries referenced by
2386
+ # {::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataRequest#time_series time_series}
2387
+ # must be sub resources of this Tensorboard.
2388
+ # @param time_series [::Array<::String>]
2389
+ # Required. The resource names of the TensorboardTimeSeries to read data
2390
+ # from. Format:
2391
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
2392
+ # @yield [result, operation] Access the result along with the TransportOperation object
2393
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataResponse]
2394
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2395
+ #
2396
+ # @return [::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataResponse]
2397
+ #
2398
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2399
+ #
2400
+ # @example Basic example
2401
+ # require "google/cloud/ai_platform/v1"
2402
+ #
2403
+ # # Create a client object. The client can be reused for multiple calls.
2404
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
2405
+ #
2406
+ # # Create a request. To set request fields, pass in keyword arguments.
2407
+ # request = Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataRequest.new
2408
+ #
2409
+ # # Call the batch_read_tensorboard_time_series_data method.
2410
+ # result = client.batch_read_tensorboard_time_series_data request
2411
+ #
2412
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataResponse.
2413
+ # p result
2414
+ #
2415
+ def batch_read_tensorboard_time_series_data request, options = nil
2416
+ raise ::ArgumentError, "request must be provided" if request.nil?
2417
+
2418
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataRequest
2419
+
2420
+ # Converts hash and nil to an options object
2421
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2422
+
2423
+ # Customize the options with defaults
2424
+ call_metadata = @config.rpcs.batch_read_tensorboard_time_series_data.metadata.to_h
2425
+
2426
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2427
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2428
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2429
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
2430
+ transports_version_send: [:rest]
2431
+
2432
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2433
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2434
+
2435
+ options.apply_defaults timeout: @config.rpcs.batch_read_tensorboard_time_series_data.timeout,
2436
+ metadata: call_metadata,
2437
+ retry_policy: @config.rpcs.batch_read_tensorboard_time_series_data.retry_policy
2438
+
2439
+ options.apply_defaults timeout: @config.timeout,
2440
+ metadata: @config.metadata,
2441
+ retry_policy: @config.retry_policy
2442
+
2443
+ @tensorboard_service_stub.batch_read_tensorboard_time_series_data request, options do |result, operation|
2444
+ yield result, operation if block_given?
2445
+ return result
2446
+ end
2447
+ rescue ::Gapic::Rest::Error => e
2448
+ raise ::Google::Cloud::Error.from_error(e)
2449
+ end
2450
+
2451
+ ##
2452
+ # Reads a TensorboardTimeSeries' data. By default, if the number of data
2453
+ # points stored is less than 1000, all data is returned. Otherwise, 1000
2454
+ # data points is randomly selected from this time series and returned.
2455
+ # This value can be changed by changing max_data_points, which can't be
2456
+ # greater than 10k.
2457
+ #
2458
+ # @overload read_tensorboard_time_series_data(request, options = nil)
2459
+ # Pass arguments to `read_tensorboard_time_series_data` via a request object, either of type
2460
+ # {::Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataRequest} or an equivalent Hash.
2461
+ #
2462
+ # @param request [::Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataRequest, ::Hash]
2463
+ # A request object representing the call parameters. Required. To specify no
2464
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2465
+ # @param options [::Gapic::CallOptions, ::Hash]
2466
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2467
+ #
2468
+ # @overload read_tensorboard_time_series_data(tensorboard_time_series: nil, max_data_points: nil, filter: nil)
2469
+ # Pass arguments to `read_tensorboard_time_series_data` via keyword arguments. Note that at
2470
+ # least one keyword argument is required. To specify no parameters, or to keep all
2471
+ # the default parameter values, pass an empty Hash as a request object (see above).
2472
+ #
2473
+ # @param tensorboard_time_series [::String]
2474
+ # Required. The resource name of the TensorboardTimeSeries to read data from.
2475
+ # Format:
2476
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
2477
+ # @param max_data_points [::Integer]
2478
+ # The maximum number of TensorboardTimeSeries' data to return.
2479
+ #
2480
+ # This value should be a positive integer.
2481
+ # This value can be set to -1 to return all data.
2482
+ # @param filter [::String]
2483
+ # Reads the TensorboardTimeSeries' data that match the filter expression.
2484
+ # @yield [result, operation] Access the result along with the TransportOperation object
2485
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataResponse]
2486
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2487
+ #
2488
+ # @return [::Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataResponse]
2489
+ #
2490
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2491
+ #
2492
+ # @example Basic example
2493
+ # require "google/cloud/ai_platform/v1"
2494
+ #
2495
+ # # Create a client object. The client can be reused for multiple calls.
2496
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
2497
+ #
2498
+ # # Create a request. To set request fields, pass in keyword arguments.
2499
+ # request = Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataRequest.new
2500
+ #
2501
+ # # Call the read_tensorboard_time_series_data method.
2502
+ # result = client.read_tensorboard_time_series_data request
2503
+ #
2504
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataResponse.
2505
+ # p result
2506
+ #
2507
+ def read_tensorboard_time_series_data request, options = nil
2508
+ raise ::ArgumentError, "request must be provided" if request.nil?
2509
+
2510
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataRequest
2511
+
2512
+ # Converts hash and nil to an options object
2513
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2514
+
2515
+ # Customize the options with defaults
2516
+ call_metadata = @config.rpcs.read_tensorboard_time_series_data.metadata.to_h
2517
+
2518
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2519
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2520
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2521
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
2522
+ transports_version_send: [:rest]
2523
+
2524
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2525
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2526
+
2527
+ options.apply_defaults timeout: @config.rpcs.read_tensorboard_time_series_data.timeout,
2528
+ metadata: call_metadata,
2529
+ retry_policy: @config.rpcs.read_tensorboard_time_series_data.retry_policy
2530
+
2531
+ options.apply_defaults timeout: @config.timeout,
2532
+ metadata: @config.metadata,
2533
+ retry_policy: @config.retry_policy
2534
+
2535
+ @tensorboard_service_stub.read_tensorboard_time_series_data request, options do |result, operation|
2536
+ yield result, operation if block_given?
2537
+ return result
2538
+ end
2539
+ rescue ::Gapic::Rest::Error => e
2540
+ raise ::Google::Cloud::Error.from_error(e)
2541
+ end
2542
+
2543
+ ##
2544
+ # Gets bytes of TensorboardBlobs.
2545
+ # This is to allow reading blob data stored in consumer project's Cloud
2546
+ # Storage bucket without users having to obtain Cloud Storage access
2547
+ # permission.
2548
+ #
2549
+ # @overload read_tensorboard_blob_data(request, options = nil)
2550
+ # Pass arguments to `read_tensorboard_blob_data` via a request object, either of type
2551
+ # {::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataRequest} or an equivalent Hash.
2552
+ #
2553
+ # @param request [::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataRequest, ::Hash]
2554
+ # A request object representing the call parameters. Required. To specify no
2555
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2556
+ # @param options [::Gapic::CallOptions, ::Hash]
2557
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2558
+ #
2559
+ # @overload read_tensorboard_blob_data(time_series: nil, blob_ids: nil)
2560
+ # Pass arguments to `read_tensorboard_blob_data` via keyword arguments. Note that at
2561
+ # least one keyword argument is required. To specify no parameters, or to keep all
2562
+ # the default parameter values, pass an empty Hash as a request object (see above).
2563
+ #
2564
+ # @param time_series [::String]
2565
+ # Required. The resource name of the TensorboardTimeSeries to list Blobs.
2566
+ # Format:
2567
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
2568
+ # @param blob_ids [::Array<::String>]
2569
+ # IDs of the blobs to read.
2570
+ # @return [::Enumerable<::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataResponse>]
2571
+ #
2572
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2573
+ #
2574
+ # @example Basic example
2575
+ # require "google/cloud/ai_platform/v1"
2576
+ #
2577
+ # # Create a client object. The client can be reused for multiple calls.
2578
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
2579
+ #
2580
+ # # Create a request. To set request fields, pass in keyword arguments.
2581
+ # request = Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataRequest.new
2582
+ #
2583
+ # # Call the read_tensorboard_blob_data method to start streaming.
2584
+ # output = client.read_tensorboard_blob_data request
2585
+ #
2586
+ # # The returned object is a streamed enumerable yielding elements of type
2587
+ # # ::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataResponse
2588
+ # output.each do |current_response|
2589
+ # p current_response
2590
+ # end
2591
+ #
2592
+ def read_tensorboard_blob_data request, options = nil
2593
+ raise ::ArgumentError, "request must be provided" if request.nil?
2594
+
2595
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataRequest
2596
+
2597
+ # Converts hash and nil to an options object
2598
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2599
+
2600
+ # Customize the options with defaults
2601
+ call_metadata = @config.rpcs.read_tensorboard_blob_data.metadata.to_h
2602
+
2603
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2604
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2605
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2606
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
2607
+ transports_version_send: [:rest]
2608
+
2609
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2610
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2611
+
2612
+ options.apply_defaults timeout: @config.rpcs.read_tensorboard_blob_data.timeout,
2613
+ metadata: call_metadata,
2614
+ retry_policy: @config.rpcs.read_tensorboard_blob_data.retry_policy
2615
+
2616
+ options.apply_defaults timeout: @config.timeout,
2617
+ metadata: @config.metadata,
2618
+ retry_policy: @config.retry_policy
2619
+
2620
+ ::Gapic::Rest::ServerStream.new(
2621
+ ::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataResponse,
2622
+ ::Gapic::Rest::ThreadedEnumerator.new do |in_q, out_q|
2623
+ @tensorboard_service_stub.read_tensorboard_blob_data request, options do |chunk|
2624
+ in_q.deq
2625
+ out_q.enq chunk
2626
+ end
2627
+ end
2628
+ )
2629
+ rescue ::Gapic::Rest::Error => e
2630
+ raise ::Google::Cloud::Error.from_error(e)
2631
+ end
2632
+
2633
+ ##
2634
+ # Write time series data points of multiple TensorboardTimeSeries in multiple
2635
+ # TensorboardRun's. If any data fail to be ingested, an error is returned.
2636
+ #
2637
+ # @overload write_tensorboard_experiment_data(request, options = nil)
2638
+ # Pass arguments to `write_tensorboard_experiment_data` via a request object, either of type
2639
+ # {::Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataRequest} or an equivalent Hash.
2640
+ #
2641
+ # @param request [::Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataRequest, ::Hash]
2642
+ # A request object representing the call parameters. Required. To specify no
2643
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2644
+ # @param options [::Gapic::CallOptions, ::Hash]
2645
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2646
+ #
2647
+ # @overload write_tensorboard_experiment_data(tensorboard_experiment: nil, write_run_data_requests: nil)
2648
+ # Pass arguments to `write_tensorboard_experiment_data` via keyword arguments. Note that at
2649
+ # least one keyword argument is required. To specify no parameters, or to keep all
2650
+ # the default parameter values, pass an empty Hash as a request object (see above).
2651
+ #
2652
+ # @param tensorboard_experiment [::String]
2653
+ # Required. The resource name of the TensorboardExperiment to write data to.
2654
+ # Format:
2655
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
2656
+ # @param write_run_data_requests [::Array<::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataRequest, ::Hash>]
2657
+ # Required. Requests containing per-run TensorboardTimeSeries data to write.
2658
+ # @yield [result, operation] Access the result along with the TransportOperation object
2659
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataResponse]
2660
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2661
+ #
2662
+ # @return [::Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataResponse]
2663
+ #
2664
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2665
+ #
2666
+ # @example Basic example
2667
+ # require "google/cloud/ai_platform/v1"
2668
+ #
2669
+ # # Create a client object. The client can be reused for multiple calls.
2670
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
2671
+ #
2672
+ # # Create a request. To set request fields, pass in keyword arguments.
2673
+ # request = Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataRequest.new
2674
+ #
2675
+ # # Call the write_tensorboard_experiment_data method.
2676
+ # result = client.write_tensorboard_experiment_data request
2677
+ #
2678
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataResponse.
2679
+ # p result
2680
+ #
2681
+ def write_tensorboard_experiment_data request, options = nil
2682
+ raise ::ArgumentError, "request must be provided" if request.nil?
2683
+
2684
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataRequest
2685
+
2686
+ # Converts hash and nil to an options object
2687
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2688
+
2689
+ # Customize the options with defaults
2690
+ call_metadata = @config.rpcs.write_tensorboard_experiment_data.metadata.to_h
2691
+
2692
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2693
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2694
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2695
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
2696
+ transports_version_send: [:rest]
2697
+
2698
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2699
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2700
+
2701
+ options.apply_defaults timeout: @config.rpcs.write_tensorboard_experiment_data.timeout,
2702
+ metadata: call_metadata,
2703
+ retry_policy: @config.rpcs.write_tensorboard_experiment_data.retry_policy
2704
+
2705
+ options.apply_defaults timeout: @config.timeout,
2706
+ metadata: @config.metadata,
2707
+ retry_policy: @config.retry_policy
2708
+
2709
+ @tensorboard_service_stub.write_tensorboard_experiment_data request, options do |result, operation|
2710
+ yield result, operation if block_given?
2711
+ return result
2712
+ end
2713
+ rescue ::Gapic::Rest::Error => e
2714
+ raise ::Google::Cloud::Error.from_error(e)
2715
+ end
2716
+
2717
+ ##
2718
+ # Write time series data points into multiple TensorboardTimeSeries under
2719
+ # a TensorboardRun. If any data fail to be ingested, an error is returned.
2720
+ #
2721
+ # @overload write_tensorboard_run_data(request, options = nil)
2722
+ # Pass arguments to `write_tensorboard_run_data` via a request object, either of type
2723
+ # {::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataRequest} or an equivalent Hash.
2724
+ #
2725
+ # @param request [::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataRequest, ::Hash]
2726
+ # A request object representing the call parameters. Required. To specify no
2727
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2728
+ # @param options [::Gapic::CallOptions, ::Hash]
2729
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2730
+ #
2731
+ # @overload write_tensorboard_run_data(tensorboard_run: nil, time_series_data: nil)
2732
+ # Pass arguments to `write_tensorboard_run_data` via keyword arguments. Note that at
2733
+ # least one keyword argument is required. To specify no parameters, or to keep all
2734
+ # the default parameter values, pass an empty Hash as a request object (see above).
2735
+ #
2736
+ # @param tensorboard_run [::String]
2737
+ # Required. The resource name of the TensorboardRun to write data to.
2738
+ # Format:
2739
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
2740
+ # @param time_series_data [::Array<::Google::Cloud::AIPlatform::V1::TimeSeriesData, ::Hash>]
2741
+ # Required. The TensorboardTimeSeries data to write.
2742
+ # Values with in a time series are indexed by their step value.
2743
+ # Repeated writes to the same step will overwrite the existing value for that
2744
+ # step.
2745
+ # The upper limit of data points per write request is 5000.
2746
+ # @yield [result, operation] Access the result along with the TransportOperation object
2747
+ # @yieldparam result [::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataResponse]
2748
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2749
+ #
2750
+ # @return [::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataResponse]
2751
+ #
2752
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2753
+ #
2754
+ # @example Basic example
2755
+ # require "google/cloud/ai_platform/v1"
2756
+ #
2757
+ # # Create a client object. The client can be reused for multiple calls.
2758
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
2759
+ #
2760
+ # # Create a request. To set request fields, pass in keyword arguments.
2761
+ # request = Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataRequest.new
2762
+ #
2763
+ # # Call the write_tensorboard_run_data method.
2764
+ # result = client.write_tensorboard_run_data request
2765
+ #
2766
+ # # The returned object is of type Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataResponse.
2767
+ # p result
2768
+ #
2769
+ def write_tensorboard_run_data request, options = nil
2770
+ raise ::ArgumentError, "request must be provided" if request.nil?
2771
+
2772
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataRequest
2773
+
2774
+ # Converts hash and nil to an options object
2775
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2776
+
2777
+ # Customize the options with defaults
2778
+ call_metadata = @config.rpcs.write_tensorboard_run_data.metadata.to_h
2779
+
2780
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2781
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2782
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2783
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
2784
+ transports_version_send: [:rest]
2785
+
2786
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2787
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2788
+
2789
+ options.apply_defaults timeout: @config.rpcs.write_tensorboard_run_data.timeout,
2790
+ metadata: call_metadata,
2791
+ retry_policy: @config.rpcs.write_tensorboard_run_data.retry_policy
2792
+
2793
+ options.apply_defaults timeout: @config.timeout,
2794
+ metadata: @config.metadata,
2795
+ retry_policy: @config.retry_policy
2796
+
2797
+ @tensorboard_service_stub.write_tensorboard_run_data request, options do |result, operation|
2798
+ yield result, operation if block_given?
2799
+ return result
2800
+ end
2801
+ rescue ::Gapic::Rest::Error => e
2802
+ raise ::Google::Cloud::Error.from_error(e)
2803
+ end
2804
+
2805
+ ##
2806
+ # Exports a TensorboardTimeSeries' data. Data is returned in paginated
2807
+ # responses.
2808
+ #
2809
+ # @overload export_tensorboard_time_series_data(request, options = nil)
2810
+ # Pass arguments to `export_tensorboard_time_series_data` via a request object, either of type
2811
+ # {::Google::Cloud::AIPlatform::V1::ExportTensorboardTimeSeriesDataRequest} or an equivalent Hash.
2812
+ #
2813
+ # @param request [::Google::Cloud::AIPlatform::V1::ExportTensorboardTimeSeriesDataRequest, ::Hash]
2814
+ # A request object representing the call parameters. Required. To specify no
2815
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2816
+ # @param options [::Gapic::CallOptions, ::Hash]
2817
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2818
+ #
2819
+ # @overload export_tensorboard_time_series_data(tensorboard_time_series: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil)
2820
+ # Pass arguments to `export_tensorboard_time_series_data` via keyword arguments. Note that at
2821
+ # least one keyword argument is required. To specify no parameters, or to keep all
2822
+ # the default parameter values, pass an empty Hash as a request object (see above).
2823
+ #
2824
+ # @param tensorboard_time_series [::String]
2825
+ # Required. The resource name of the TensorboardTimeSeries to export data
2826
+ # from. Format:
2827
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
2828
+ # @param filter [::String]
2829
+ # Exports the TensorboardTimeSeries' data that match the filter expression.
2830
+ # @param page_size [::Integer]
2831
+ # The maximum number of data points to return per page.
2832
+ # The default page_size is 1000. Values must be between 1 and 10000.
2833
+ # Values above 10000 are coerced to 10000.
2834
+ # @param page_token [::String]
2835
+ # A page token, received from a previous
2836
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client#export_tensorboard_time_series_data ExportTensorboardTimeSeriesData}
2837
+ # call. Provide this to retrieve the subsequent page.
2838
+ #
2839
+ # When paginating, all other parameters provided to
2840
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client#export_tensorboard_time_series_data ExportTensorboardTimeSeriesData}
2841
+ # must match the call that provided the page token.
2842
+ # @param order_by [::String]
2843
+ # Field to use to sort the TensorboardTimeSeries' data.
2844
+ # By default, TensorboardTimeSeries' data is returned in a pseudo random
2845
+ # order.
2846
+ # @yield [result, operation] Access the result along with the TransportOperation object
2847
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TimeSeriesDataPoint>]
2848
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2849
+ #
2850
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TimeSeriesDataPoint>]
2851
+ #
2852
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2853
+ #
2854
+ # @example Basic example
2855
+ # require "google/cloud/ai_platform/v1"
2856
+ #
2857
+ # # Create a client object. The client can be reused for multiple calls.
2858
+ # client = Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new
2859
+ #
2860
+ # # Create a request. To set request fields, pass in keyword arguments.
2861
+ # request = Google::Cloud::AIPlatform::V1::ExportTensorboardTimeSeriesDataRequest.new
2862
+ #
2863
+ # # Call the export_tensorboard_time_series_data method.
2864
+ # result = client.export_tensorboard_time_series_data request
2865
+ #
2866
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2867
+ # # over elements, and API calls will be issued to fetch pages as needed.
2868
+ # result.each do |item|
2869
+ # # Each element is of type ::Google::Cloud::AIPlatform::V1::TimeSeriesDataPoint.
2870
+ # p item
2871
+ # end
2872
+ #
2873
+ def export_tensorboard_time_series_data request, options = nil
2874
+ raise ::ArgumentError, "request must be provided" if request.nil?
2875
+
2876
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ExportTensorboardTimeSeriesDataRequest
2877
+
2878
+ # Converts hash and nil to an options object
2879
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2880
+
2881
+ # Customize the options with defaults
2882
+ call_metadata = @config.rpcs.export_tensorboard_time_series_data.metadata.to_h
2883
+
2884
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2885
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2886
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2887
+ gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
2888
+ transports_version_send: [:rest]
2889
+
2890
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2891
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2892
+
2893
+ options.apply_defaults timeout: @config.rpcs.export_tensorboard_time_series_data.timeout,
2894
+ metadata: call_metadata,
2895
+ retry_policy: @config.rpcs.export_tensorboard_time_series_data.retry_policy
2896
+
2897
+ options.apply_defaults timeout: @config.timeout,
2898
+ metadata: @config.metadata,
2899
+ retry_policy: @config.retry_policy
2900
+
2901
+ @tensorboard_service_stub.export_tensorboard_time_series_data request, options do |result, operation|
2902
+ result = ::Gapic::Rest::PagedEnumerable.new @tensorboard_service_stub, :export_tensorboard_time_series_data, "time_series_data_points", request, result, options
2903
+ yield result, operation if block_given?
2904
+ return result
2905
+ end
2906
+ rescue ::Gapic::Rest::Error => e
2907
+ raise ::Google::Cloud::Error.from_error(e)
2908
+ end
2909
+
2910
+ ##
2911
+ # Configuration class for the TensorboardService REST API.
2912
+ #
2913
+ # This class represents the configuration for TensorboardService REST,
2914
+ # providing control over timeouts, retry behavior, logging, transport
2915
+ # parameters, and other low-level controls. Certain parameters can also be
2916
+ # applied individually to specific RPCs. See
2917
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client::Configuration::Rpcs}
2918
+ # for a list of RPCs that can be configured independently.
2919
+ #
2920
+ # Configuration can be applied globally to all clients, or to a single client
2921
+ # on construction.
2922
+ #
2923
+ # @example
2924
+ #
2925
+ # # Modify the global config, setting the timeout for
2926
+ # # create_tensorboard to 20 seconds,
2927
+ # # and all remaining timeouts to 10 seconds.
2928
+ # ::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.configure do |config|
2929
+ # config.timeout = 10.0
2930
+ # config.rpcs.create_tensorboard.timeout = 20.0
2931
+ # end
2932
+ #
2933
+ # # Apply the above configuration only to a new client.
2934
+ # client = ::Google::Cloud::AIPlatform::V1::TensorboardService::Rest::Client.new do |config|
2935
+ # config.timeout = 10.0
2936
+ # config.rpcs.create_tensorboard.timeout = 20.0
2937
+ # end
2938
+ #
2939
+ # @!attribute [rw] endpoint
2940
+ # A custom service endpoint, as a hostname or hostname:port. The default is
2941
+ # nil, indicating to use the default endpoint in the current universe domain.
2942
+ # @return [::String,nil]
2943
+ # @!attribute [rw] credentials
2944
+ # Credentials to send with calls. You may provide any of the following types:
2945
+ # * (`String`) The path to a service account key file in JSON format
2946
+ # * (`Hash`) A service account key as a Hash
2947
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
2948
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
2949
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
2950
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
2951
+ # * (`nil`) indicating no credentials
2952
+ # @return [::Object]
2953
+ # @!attribute [rw] scope
2954
+ # The OAuth scopes
2955
+ # @return [::Array<::String>]
2956
+ # @!attribute [rw] lib_name
2957
+ # The library name as recorded in instrumentation and logging
2958
+ # @return [::String]
2959
+ # @!attribute [rw] lib_version
2960
+ # The library version as recorded in instrumentation and logging
2961
+ # @return [::String]
2962
+ # @!attribute [rw] timeout
2963
+ # The call timeout in seconds.
2964
+ # @return [::Numeric]
2965
+ # @!attribute [rw] metadata
2966
+ # Additional headers to be sent with the call.
2967
+ # @return [::Hash{::Symbol=>::String}]
2968
+ # @!attribute [rw] retry_policy
2969
+ # The retry policy. The value is a hash with the following keys:
2970
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
2971
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
2972
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
2973
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
2974
+ # trigger a retry.
2975
+ # @return [::Hash]
2976
+ # @!attribute [rw] quota_project
2977
+ # A separate project against which to charge quota.
2978
+ # @return [::String]
2979
+ # @!attribute [rw] universe_domain
2980
+ # The universe domain within which to make requests. This determines the
2981
+ # default endpoint URL. The default value of nil uses the environment
2982
+ # universe (usually the default "googleapis.com" universe).
2983
+ # @return [::String,nil]
2984
+ #
2985
+ class Configuration
2986
+ extend ::Gapic::Config
2987
+
2988
+ # @private
2989
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
2990
+ DEFAULT_ENDPOINT = "aiplatform.googleapis.com"
2991
+
2992
+ config_attr :endpoint, nil, ::String, nil
2993
+ config_attr :credentials, nil do |value|
2994
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2995
+ allowed.any? { |klass| klass === value }
2996
+ end
2997
+ config_attr :scope, nil, ::String, ::Array, nil
2998
+ config_attr :lib_name, nil, ::String, nil
2999
+ config_attr :lib_version, nil, ::String, nil
3000
+ config_attr :timeout, nil, ::Numeric, nil
3001
+ config_attr :metadata, nil, ::Hash, nil
3002
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
3003
+ config_attr :quota_project, nil, ::String, nil
3004
+ config_attr :universe_domain, nil, ::String, nil
3005
+
3006
+ # @private
3007
+ # Overrides for http bindings for the RPCs of this service
3008
+ # are only used when this service is used as mixin, and only
3009
+ # by the host service.
3010
+ # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
3011
+ config_attr :bindings_override, {}, ::Hash, nil
3012
+
3013
+ # @private
3014
+ def initialize parent_config = nil
3015
+ @parent_config = parent_config unless parent_config.nil?
3016
+
3017
+ yield self if block_given?
3018
+ end
3019
+
3020
+ ##
3021
+ # Configurations for individual RPCs
3022
+ # @return [Rpcs]
3023
+ #
3024
+ def rpcs
3025
+ @rpcs ||= begin
3026
+ parent_rpcs = nil
3027
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
3028
+ Rpcs.new parent_rpcs
3029
+ end
3030
+ end
3031
+
3032
+ ##
3033
+ # Configuration RPC class for the TensorboardService API.
3034
+ #
3035
+ # Includes fields providing the configuration for each RPC in this service.
3036
+ # Each configuration object is of type `Gapic::Config::Method` and includes
3037
+ # the following configuration fields:
3038
+ #
3039
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
3040
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
3041
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
3042
+ # include the following keys:
3043
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
3044
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
3045
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
3046
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
3047
+ # trigger a retry.
3048
+ #
3049
+ class Rpcs
3050
+ ##
3051
+ # RPC-specific configuration for `create_tensorboard`
3052
+ # @return [::Gapic::Config::Method]
3053
+ #
3054
+ attr_reader :create_tensorboard
3055
+ ##
3056
+ # RPC-specific configuration for `get_tensorboard`
3057
+ # @return [::Gapic::Config::Method]
3058
+ #
3059
+ attr_reader :get_tensorboard
3060
+ ##
3061
+ # RPC-specific configuration for `update_tensorboard`
3062
+ # @return [::Gapic::Config::Method]
3063
+ #
3064
+ attr_reader :update_tensorboard
3065
+ ##
3066
+ # RPC-specific configuration for `list_tensorboards`
3067
+ # @return [::Gapic::Config::Method]
3068
+ #
3069
+ attr_reader :list_tensorboards
3070
+ ##
3071
+ # RPC-specific configuration for `delete_tensorboard`
3072
+ # @return [::Gapic::Config::Method]
3073
+ #
3074
+ attr_reader :delete_tensorboard
3075
+ ##
3076
+ # RPC-specific configuration for `read_tensorboard_usage`
3077
+ # @return [::Gapic::Config::Method]
3078
+ #
3079
+ attr_reader :read_tensorboard_usage
3080
+ ##
3081
+ # RPC-specific configuration for `read_tensorboard_size`
3082
+ # @return [::Gapic::Config::Method]
3083
+ #
3084
+ attr_reader :read_tensorboard_size
3085
+ ##
3086
+ # RPC-specific configuration for `create_tensorboard_experiment`
3087
+ # @return [::Gapic::Config::Method]
3088
+ #
3089
+ attr_reader :create_tensorboard_experiment
3090
+ ##
3091
+ # RPC-specific configuration for `get_tensorboard_experiment`
3092
+ # @return [::Gapic::Config::Method]
3093
+ #
3094
+ attr_reader :get_tensorboard_experiment
3095
+ ##
3096
+ # RPC-specific configuration for `update_tensorboard_experiment`
3097
+ # @return [::Gapic::Config::Method]
3098
+ #
3099
+ attr_reader :update_tensorboard_experiment
3100
+ ##
3101
+ # RPC-specific configuration for `list_tensorboard_experiments`
3102
+ # @return [::Gapic::Config::Method]
3103
+ #
3104
+ attr_reader :list_tensorboard_experiments
3105
+ ##
3106
+ # RPC-specific configuration for `delete_tensorboard_experiment`
3107
+ # @return [::Gapic::Config::Method]
3108
+ #
3109
+ attr_reader :delete_tensorboard_experiment
3110
+ ##
3111
+ # RPC-specific configuration for `create_tensorboard_run`
3112
+ # @return [::Gapic::Config::Method]
3113
+ #
3114
+ attr_reader :create_tensorboard_run
3115
+ ##
3116
+ # RPC-specific configuration for `batch_create_tensorboard_runs`
3117
+ # @return [::Gapic::Config::Method]
3118
+ #
3119
+ attr_reader :batch_create_tensorboard_runs
3120
+ ##
3121
+ # RPC-specific configuration for `get_tensorboard_run`
3122
+ # @return [::Gapic::Config::Method]
3123
+ #
3124
+ attr_reader :get_tensorboard_run
3125
+ ##
3126
+ # RPC-specific configuration for `update_tensorboard_run`
3127
+ # @return [::Gapic::Config::Method]
3128
+ #
3129
+ attr_reader :update_tensorboard_run
3130
+ ##
3131
+ # RPC-specific configuration for `list_tensorboard_runs`
3132
+ # @return [::Gapic::Config::Method]
3133
+ #
3134
+ attr_reader :list_tensorboard_runs
3135
+ ##
3136
+ # RPC-specific configuration for `delete_tensorboard_run`
3137
+ # @return [::Gapic::Config::Method]
3138
+ #
3139
+ attr_reader :delete_tensorboard_run
3140
+ ##
3141
+ # RPC-specific configuration for `batch_create_tensorboard_time_series`
3142
+ # @return [::Gapic::Config::Method]
3143
+ #
3144
+ attr_reader :batch_create_tensorboard_time_series
3145
+ ##
3146
+ # RPC-specific configuration for `create_tensorboard_time_series`
3147
+ # @return [::Gapic::Config::Method]
3148
+ #
3149
+ attr_reader :create_tensorboard_time_series
3150
+ ##
3151
+ # RPC-specific configuration for `get_tensorboard_time_series`
3152
+ # @return [::Gapic::Config::Method]
3153
+ #
3154
+ attr_reader :get_tensorboard_time_series
3155
+ ##
3156
+ # RPC-specific configuration for `update_tensorboard_time_series`
3157
+ # @return [::Gapic::Config::Method]
3158
+ #
3159
+ attr_reader :update_tensorboard_time_series
3160
+ ##
3161
+ # RPC-specific configuration for `list_tensorboard_time_series`
3162
+ # @return [::Gapic::Config::Method]
3163
+ #
3164
+ attr_reader :list_tensorboard_time_series
3165
+ ##
3166
+ # RPC-specific configuration for `delete_tensorboard_time_series`
3167
+ # @return [::Gapic::Config::Method]
3168
+ #
3169
+ attr_reader :delete_tensorboard_time_series
3170
+ ##
3171
+ # RPC-specific configuration for `batch_read_tensorboard_time_series_data`
3172
+ # @return [::Gapic::Config::Method]
3173
+ #
3174
+ attr_reader :batch_read_tensorboard_time_series_data
3175
+ ##
3176
+ # RPC-specific configuration for `read_tensorboard_time_series_data`
3177
+ # @return [::Gapic::Config::Method]
3178
+ #
3179
+ attr_reader :read_tensorboard_time_series_data
3180
+ ##
3181
+ # RPC-specific configuration for `read_tensorboard_blob_data`
3182
+ # @return [::Gapic::Config::Method]
3183
+ #
3184
+ attr_reader :read_tensorboard_blob_data
3185
+ ##
3186
+ # RPC-specific configuration for `write_tensorboard_experiment_data`
3187
+ # @return [::Gapic::Config::Method]
3188
+ #
3189
+ attr_reader :write_tensorboard_experiment_data
3190
+ ##
3191
+ # RPC-specific configuration for `write_tensorboard_run_data`
3192
+ # @return [::Gapic::Config::Method]
3193
+ #
3194
+ attr_reader :write_tensorboard_run_data
3195
+ ##
3196
+ # RPC-specific configuration for `export_tensorboard_time_series_data`
3197
+ # @return [::Gapic::Config::Method]
3198
+ #
3199
+ attr_reader :export_tensorboard_time_series_data
3200
+
3201
+ # @private
3202
+ def initialize parent_rpcs = nil
3203
+ create_tensorboard_config = parent_rpcs.create_tensorboard if parent_rpcs.respond_to? :create_tensorboard
3204
+ @create_tensorboard = ::Gapic::Config::Method.new create_tensorboard_config
3205
+ get_tensorboard_config = parent_rpcs.get_tensorboard if parent_rpcs.respond_to? :get_tensorboard
3206
+ @get_tensorboard = ::Gapic::Config::Method.new get_tensorboard_config
3207
+ update_tensorboard_config = parent_rpcs.update_tensorboard if parent_rpcs.respond_to? :update_tensorboard
3208
+ @update_tensorboard = ::Gapic::Config::Method.new update_tensorboard_config
3209
+ list_tensorboards_config = parent_rpcs.list_tensorboards if parent_rpcs.respond_to? :list_tensorboards
3210
+ @list_tensorboards = ::Gapic::Config::Method.new list_tensorboards_config
3211
+ delete_tensorboard_config = parent_rpcs.delete_tensorboard if parent_rpcs.respond_to? :delete_tensorboard
3212
+ @delete_tensorboard = ::Gapic::Config::Method.new delete_tensorboard_config
3213
+ read_tensorboard_usage_config = parent_rpcs.read_tensorboard_usage if parent_rpcs.respond_to? :read_tensorboard_usage
3214
+ @read_tensorboard_usage = ::Gapic::Config::Method.new read_tensorboard_usage_config
3215
+ read_tensorboard_size_config = parent_rpcs.read_tensorboard_size if parent_rpcs.respond_to? :read_tensorboard_size
3216
+ @read_tensorboard_size = ::Gapic::Config::Method.new read_tensorboard_size_config
3217
+ create_tensorboard_experiment_config = parent_rpcs.create_tensorboard_experiment if parent_rpcs.respond_to? :create_tensorboard_experiment
3218
+ @create_tensorboard_experiment = ::Gapic::Config::Method.new create_tensorboard_experiment_config
3219
+ get_tensorboard_experiment_config = parent_rpcs.get_tensorboard_experiment if parent_rpcs.respond_to? :get_tensorboard_experiment
3220
+ @get_tensorboard_experiment = ::Gapic::Config::Method.new get_tensorboard_experiment_config
3221
+ update_tensorboard_experiment_config = parent_rpcs.update_tensorboard_experiment if parent_rpcs.respond_to? :update_tensorboard_experiment
3222
+ @update_tensorboard_experiment = ::Gapic::Config::Method.new update_tensorboard_experiment_config
3223
+ list_tensorboard_experiments_config = parent_rpcs.list_tensorboard_experiments if parent_rpcs.respond_to? :list_tensorboard_experiments
3224
+ @list_tensorboard_experiments = ::Gapic::Config::Method.new list_tensorboard_experiments_config
3225
+ delete_tensorboard_experiment_config = parent_rpcs.delete_tensorboard_experiment if parent_rpcs.respond_to? :delete_tensorboard_experiment
3226
+ @delete_tensorboard_experiment = ::Gapic::Config::Method.new delete_tensorboard_experiment_config
3227
+ create_tensorboard_run_config = parent_rpcs.create_tensorboard_run if parent_rpcs.respond_to? :create_tensorboard_run
3228
+ @create_tensorboard_run = ::Gapic::Config::Method.new create_tensorboard_run_config
3229
+ batch_create_tensorboard_runs_config = parent_rpcs.batch_create_tensorboard_runs if parent_rpcs.respond_to? :batch_create_tensorboard_runs
3230
+ @batch_create_tensorboard_runs = ::Gapic::Config::Method.new batch_create_tensorboard_runs_config
3231
+ get_tensorboard_run_config = parent_rpcs.get_tensorboard_run if parent_rpcs.respond_to? :get_tensorboard_run
3232
+ @get_tensorboard_run = ::Gapic::Config::Method.new get_tensorboard_run_config
3233
+ update_tensorboard_run_config = parent_rpcs.update_tensorboard_run if parent_rpcs.respond_to? :update_tensorboard_run
3234
+ @update_tensorboard_run = ::Gapic::Config::Method.new update_tensorboard_run_config
3235
+ list_tensorboard_runs_config = parent_rpcs.list_tensorboard_runs if parent_rpcs.respond_to? :list_tensorboard_runs
3236
+ @list_tensorboard_runs = ::Gapic::Config::Method.new list_tensorboard_runs_config
3237
+ delete_tensorboard_run_config = parent_rpcs.delete_tensorboard_run if parent_rpcs.respond_to? :delete_tensorboard_run
3238
+ @delete_tensorboard_run = ::Gapic::Config::Method.new delete_tensorboard_run_config
3239
+ batch_create_tensorboard_time_series_config = parent_rpcs.batch_create_tensorboard_time_series if parent_rpcs.respond_to? :batch_create_tensorboard_time_series
3240
+ @batch_create_tensorboard_time_series = ::Gapic::Config::Method.new batch_create_tensorboard_time_series_config
3241
+ create_tensorboard_time_series_config = parent_rpcs.create_tensorboard_time_series if parent_rpcs.respond_to? :create_tensorboard_time_series
3242
+ @create_tensorboard_time_series = ::Gapic::Config::Method.new create_tensorboard_time_series_config
3243
+ get_tensorboard_time_series_config = parent_rpcs.get_tensorboard_time_series if parent_rpcs.respond_to? :get_tensorboard_time_series
3244
+ @get_tensorboard_time_series = ::Gapic::Config::Method.new get_tensorboard_time_series_config
3245
+ update_tensorboard_time_series_config = parent_rpcs.update_tensorboard_time_series if parent_rpcs.respond_to? :update_tensorboard_time_series
3246
+ @update_tensorboard_time_series = ::Gapic::Config::Method.new update_tensorboard_time_series_config
3247
+ list_tensorboard_time_series_config = parent_rpcs.list_tensorboard_time_series if parent_rpcs.respond_to? :list_tensorboard_time_series
3248
+ @list_tensorboard_time_series = ::Gapic::Config::Method.new list_tensorboard_time_series_config
3249
+ delete_tensorboard_time_series_config = parent_rpcs.delete_tensorboard_time_series if parent_rpcs.respond_to? :delete_tensorboard_time_series
3250
+ @delete_tensorboard_time_series = ::Gapic::Config::Method.new delete_tensorboard_time_series_config
3251
+ batch_read_tensorboard_time_series_data_config = parent_rpcs.batch_read_tensorboard_time_series_data if parent_rpcs.respond_to? :batch_read_tensorboard_time_series_data
3252
+ @batch_read_tensorboard_time_series_data = ::Gapic::Config::Method.new batch_read_tensorboard_time_series_data_config
3253
+ read_tensorboard_time_series_data_config = parent_rpcs.read_tensorboard_time_series_data if parent_rpcs.respond_to? :read_tensorboard_time_series_data
3254
+ @read_tensorboard_time_series_data = ::Gapic::Config::Method.new read_tensorboard_time_series_data_config
3255
+ read_tensorboard_blob_data_config = parent_rpcs.read_tensorboard_blob_data if parent_rpcs.respond_to? :read_tensorboard_blob_data
3256
+ @read_tensorboard_blob_data = ::Gapic::Config::Method.new read_tensorboard_blob_data_config
3257
+ write_tensorboard_experiment_data_config = parent_rpcs.write_tensorboard_experiment_data if parent_rpcs.respond_to? :write_tensorboard_experiment_data
3258
+ @write_tensorboard_experiment_data = ::Gapic::Config::Method.new write_tensorboard_experiment_data_config
3259
+ write_tensorboard_run_data_config = parent_rpcs.write_tensorboard_run_data if parent_rpcs.respond_to? :write_tensorboard_run_data
3260
+ @write_tensorboard_run_data = ::Gapic::Config::Method.new write_tensorboard_run_data_config
3261
+ export_tensorboard_time_series_data_config = parent_rpcs.export_tensorboard_time_series_data if parent_rpcs.respond_to? :export_tensorboard_time_series_data
3262
+ @export_tensorboard_time_series_data = ::Gapic::Config::Method.new export_tensorboard_time_series_data_config
3263
+
3264
+ yield self if block_given?
3265
+ end
3266
+ end
3267
+ end
3268
+ end
3269
+ end
3270
+ end
3271
+ end
3272
+ end
3273
+ end
3274
+ end