google-cloud-ai_platform-v1 0.16.0 → 0.18.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (101) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/ai_platform/v1/dataset_service/client.rb +10 -7
  3. data/lib/google/cloud/ai_platform/v1/dataset_service.rb +1 -1
  4. data/lib/google/cloud/ai_platform/v1/endpoint_service/client.rb +28 -21
  5. data/lib/google/cloud/ai_platform/v1/endpoint_service.rb +1 -1
  6. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb +10 -9
  7. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service.rb +1 -1
  8. data/lib/google/cloud/ai_platform/v1/featurestore_service/client.rb +53 -50
  9. data/lib/google/cloud/ai_platform/v1/featurestore_service.rb +1 -1
  10. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/client.rb +18 -14
  11. data/lib/google/cloud/ai_platform/v1/index_endpoint_service.rb +1 -1
  12. data/lib/google/cloud/ai_platform/v1/index_service/client.rb +8 -4
  13. data/lib/google/cloud/ai_platform/v1/index_service.rb +1 -1
  14. data/lib/google/cloud/ai_platform/v1/job_service/client.rb +53 -36
  15. data/lib/google/cloud/ai_platform/v1/job_service.rb +1 -1
  16. data/lib/google/cloud/ai_platform/v1/metadata_service/client.rb +33 -36
  17. data/lib/google/cloud/ai_platform/v1/metadata_service.rb +1 -1
  18. data/lib/google/cloud/ai_platform/v1/migration_service/client.rb +3 -4
  19. data/lib/google/cloud/ai_platform/v1/migration_service.rb +1 -1
  20. data/lib/google/cloud/ai_platform/v1/model_service/client.rb +44 -22
  21. data/lib/google/cloud/ai_platform/v1/model_service.rb +1 -1
  22. data/lib/google/cloud/ai_platform/v1/pipeline_service/client.rb +28 -17
  23. data/lib/google/cloud/ai_platform/v1/pipeline_service.rb +1 -1
  24. data/lib/google/cloud/ai_platform/v1/prediction_service/client.rb +28 -19
  25. data/lib/google/cloud/ai_platform/v1/prediction_service.rb +1 -1
  26. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/client.rb +5 -3
  27. data/lib/google/cloud/ai_platform/v1/specialist_pool_service.rb +1 -1
  28. data/lib/google/cloud/ai_platform/v1/tensorboard_service/client.rb +165 -71
  29. data/lib/google/cloud/ai_platform/v1/tensorboard_service.rb +1 -1
  30. data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
  31. data/lib/google/cloud/ai_platform/v1/vizier_service.rb +1 -1
  32. data/lib/google/cloud/ai_platform/v1.rb +2 -2
  33. data/lib/google/cloud/aiplatform/v1/batch_prediction_job_pb.rb +8 -0
  34. data/lib/google/cloud/aiplatform/v1/custom_job_pb.rb +1 -0
  35. data/lib/google/cloud/aiplatform/v1/dataset_pb.rb +2 -0
  36. data/lib/google/cloud/aiplatform/v1/index_service_services_pb.rb +2 -1
  37. data/lib/google/cloud/aiplatform/v1/job_service_services_pb.rb +24 -14
  38. data/lib/google/cloud/aiplatform/v1/model_service_pb.rb +1 -0
  39. data/lib/google/cloud/aiplatform/v1/model_service_services_pb.rb +10 -5
  40. data/lib/google/cloud/aiplatform/v1/pipeline_service_services_pb.rb +16 -9
  41. data/lib/google/cloud/aiplatform/v1/prediction_service_services_pb.rb +10 -6
  42. data/lib/google/cloud/aiplatform/v1/study_pb.rb +1 -0
  43. data/lib/google/cloud/aiplatform/v1/tensorboard_service_pb.rb +17 -0
  44. data/lib/google/cloud/aiplatform/v1/tensorboard_service_services_pb.rb +8 -8
  45. data/proto_docs/google/cloud/aiplatform/v1/annotation.rb +9 -6
  46. data/proto_docs/google/cloud/aiplatform/v1/annotation_spec.rb +2 -2
  47. data/proto_docs/google/cloud/aiplatform/v1/batch_prediction_job.rb +183 -50
  48. data/proto_docs/google/cloud/aiplatform/v1/completion_stats.rb +8 -7
  49. data/proto_docs/google/cloud/aiplatform/v1/context.rb +2 -2
  50. data/proto_docs/google/cloud/aiplatform/v1/custom_job.rb +34 -17
  51. data/proto_docs/google/cloud/aiplatform/v1/data_item.rb +6 -5
  52. data/proto_docs/google/cloud/aiplatform/v1/data_labeling_job.rb +16 -16
  53. data/proto_docs/google/cloud/aiplatform/v1/dataset.rb +33 -17
  54. data/proto_docs/google/cloud/aiplatform/v1/dataset_service.rb +59 -32
  55. data/proto_docs/google/cloud/aiplatform/v1/encryption_spec.rb +2 -2
  56. data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +38 -23
  57. data/proto_docs/google/cloud/aiplatform/v1/endpoint_service.rb +57 -35
  58. data/proto_docs/google/cloud/aiplatform/v1/entity_type.rb +8 -6
  59. data/proto_docs/google/cloud/aiplatform/v1/explanation.rb +111 -75
  60. data/proto_docs/google/cloud/aiplatform/v1/explanation_metadata.rb +58 -38
  61. data/proto_docs/google/cloud/aiplatform/v1/feature.rb +9 -6
  62. data/proto_docs/google/cloud/aiplatform/v1/feature_monitoring_stats.rb +2 -1
  63. data/proto_docs/google/cloud/aiplatform/v1/featurestore.rb +12 -11
  64. data/proto_docs/google/cloud/aiplatform/v1/featurestore_monitoring.rb +6 -2
  65. data/proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb +27 -19
  66. data/proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb +138 -99
  67. data/proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb +9 -7
  68. data/proto_docs/google/cloud/aiplatform/v1/index.rb +18 -17
  69. data/proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb +36 -24
  70. data/proto_docs/google/cloud/aiplatform/v1/index_endpoint_service.rb +49 -29
  71. data/proto_docs/google/cloud/aiplatform/v1/index_service.rb +35 -17
  72. data/proto_docs/google/cloud/aiplatform/v1/io.rb +2 -1
  73. data/proto_docs/google/cloud/aiplatform/v1/job_service.rb +94 -57
  74. data/proto_docs/google/cloud/aiplatform/v1/machine_resources.rb +53 -43
  75. data/proto_docs/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.rb +5 -5
  76. data/proto_docs/google/cloud/aiplatform/v1/metadata_schema.rb +3 -3
  77. data/proto_docs/google/cloud/aiplatform/v1/metadata_service.rb +141 -91
  78. data/proto_docs/google/cloud/aiplatform/v1/migratable_resource.rb +3 -3
  79. data/proto_docs/google/cloud/aiplatform/v1/migration_service.rb +18 -15
  80. data/proto_docs/google/cloud/aiplatform/v1/model.rb +179 -132
  81. data/proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb +21 -17
  82. data/proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb +7 -6
  83. data/proto_docs/google/cloud/aiplatform/v1/model_evaluation_slice.rb +11 -7
  84. data/proto_docs/google/cloud/aiplatform/v1/model_monitoring.rb +4 -2
  85. data/proto_docs/google/cloud/aiplatform/v1/model_service.rb +110 -54
  86. data/proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb +56 -42
  87. data/proto_docs/google/cloud/aiplatform/v1/pipeline_service.rb +42 -22
  88. data/proto_docs/google/cloud/aiplatform/v1/prediction_service.rb +42 -28
  89. data/proto_docs/google/cloud/aiplatform/v1/saved_query.rb +2 -2
  90. data/proto_docs/google/cloud/aiplatform/v1/specialist_pool_service.rb +19 -11
  91. data/proto_docs/google/cloud/aiplatform/v1/study.rb +42 -25
  92. data/proto_docs/google/cloud/aiplatform/v1/tensorboard.rb +2 -2
  93. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_data.rb +8 -7
  94. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb +2 -1
  95. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb +203 -109
  96. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_time_series.rb +8 -6
  97. data/proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb +84 -59
  98. data/proto_docs/google/cloud/aiplatform/v1/unmanaged_container_model.rb +2 -2
  99. data/proto_docs/google/cloud/aiplatform/v1/vizier_service.rb +40 -20
  100. data/proto_docs/google/rpc/status.rb +4 -2
  101. metadata +9 -9
@@ -21,7 +21,8 @@ module Google
21
21
  module Cloud
22
22
  module AIPlatform
23
23
  module V1
24
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#create_tensorboard TensorboardService.CreateTensorboard}.
24
+ # Request message for
25
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#create_tensorboard TensorboardService.CreateTensorboard}.
25
26
  # @!attribute [rw] parent
26
27
  # @return [::String]
27
28
  # Required. The resource name of the Location to create the Tensorboard in.
@@ -34,7 +35,8 @@ module Google
34
35
  extend ::Google::Protobuf::MessageExts::ClassMethods
35
36
  end
36
37
 
37
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#get_tensorboard TensorboardService.GetTensorboard}.
38
+ # Request message for
39
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#get_tensorboard TensorboardService.GetTensorboard}.
38
40
  # @!attribute [rw] name
39
41
  # @return [::String]
40
42
  # Required. The name of the Tensorboard resource.
@@ -45,7 +47,58 @@ module Google
45
47
  extend ::Google::Protobuf::MessageExts::ClassMethods
46
48
  end
47
49
 
48
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboards TensorboardService.ListTensorboards}.
50
+ # Request message for [TensorboardService.GetTensorboardUsage][].
51
+ # @!attribute [rw] tensorboard
52
+ # @return [::String]
53
+ # Required. The name of the Tensorboard resource.
54
+ # Format:
55
+ # `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
56
+ class ReadTensorboardUsageRequest
57
+ include ::Google::Protobuf::MessageExts
58
+ extend ::Google::Protobuf::MessageExts::ClassMethods
59
+ end
60
+
61
+ # Response message for [TensorboardService.GetTensorboardUsage][].
62
+ # @!attribute [rw] monthly_usage_data
63
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageResponse::PerMonthUsageData}]
64
+ # Maps year-month (YYYYMM) string to per month usage data.
65
+ class ReadTensorboardUsageResponse
66
+ include ::Google::Protobuf::MessageExts
67
+ extend ::Google::Protobuf::MessageExts::ClassMethods
68
+
69
+ # Per user usage data.
70
+ # @!attribute [rw] username
71
+ # @return [::String]
72
+ # User's username
73
+ # @!attribute [rw] view_count
74
+ # @return [::Integer]
75
+ # Number of times the user has read data within the Tensorboard.
76
+ class PerUserUsageData
77
+ include ::Google::Protobuf::MessageExts
78
+ extend ::Google::Protobuf::MessageExts::ClassMethods
79
+ end
80
+
81
+ # Per month usage data
82
+ # @!attribute [rw] user_usage_data
83
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageResponse::PerUserUsageData>]
84
+ # Usage data for each user in the given month.
85
+ class PerMonthUsageData
86
+ include ::Google::Protobuf::MessageExts
87
+ extend ::Google::Protobuf::MessageExts::ClassMethods
88
+ end
89
+
90
+ # @!attribute [rw] key
91
+ # @return [::String]
92
+ # @!attribute [rw] value
93
+ # @return [::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageResponse::PerMonthUsageData]
94
+ class MonthlyUsageDataEntry
95
+ include ::Google::Protobuf::MessageExts
96
+ extend ::Google::Protobuf::MessageExts::ClassMethods
97
+ end
98
+ end
99
+
100
+ # Request message for
101
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboards TensorboardService.ListTensorboards}.
49
102
  # @!attribute [rw] parent
50
103
  # @return [::String]
51
104
  # Required. The resource name of the Location to list Tensorboards.
@@ -57,18 +110,18 @@ module Google
57
110
  # @!attribute [rw] page_size
58
111
  # @return [::Integer]
59
112
  # The maximum number of Tensorboards to return. The service may return
60
- # fewer than this value. If unspecified, at most 100 Tensorboards will be
61
- # returned. The maximum value is 100; values above 100 will be coerced to
113
+ # fewer than this value. If unspecified, at most 100 Tensorboards are
114
+ # returned. The maximum value is 100; values above 100 are coerced to
62
115
  # 100.
63
116
  # @!attribute [rw] page_token
64
117
  # @return [::String]
65
118
  # A page token, received from a previous
66
- # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboards TensorboardService.ListTensorboards} call.
67
- # Provide this to retrieve the subsequent page.
119
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboards TensorboardService.ListTensorboards}
120
+ # call. Provide this to retrieve the subsequent page.
68
121
  #
69
122
  # When paginating, all other parameters provided to
70
- # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboards TensorboardService.ListTensorboards} must
71
- # match the call that provided the page token.
123
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboards TensorboardService.ListTensorboards}
124
+ # must match the call that provided the page token.
72
125
  # @!attribute [rw] order_by
73
126
  # @return [::String]
74
127
  # Field to use to sort the list.
@@ -80,13 +133,15 @@ module Google
80
133
  extend ::Google::Protobuf::MessageExts::ClassMethods
81
134
  end
82
135
 
83
- # Response message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboards TensorboardService.ListTensorboards}.
136
+ # Response message for
137
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboards TensorboardService.ListTensorboards}.
84
138
  # @!attribute [rw] tensorboards
85
139
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Tensorboard>]
86
140
  # The Tensorboards mathching the request.
87
141
  # @!attribute [rw] next_page_token
88
142
  # @return [::String]
89
- # A token, which can be sent as {::Google::Cloud::AIPlatform::V1::ListTensorboardsRequest#page_token ListTensorboardsRequest.page_token}
143
+ # A token, which can be sent as
144
+ # {::Google::Cloud::AIPlatform::V1::ListTensorboardsRequest#page_token ListTensorboardsRequest.page_token}
90
145
  # to retrieve the next page. If this field is omitted, there are no
91
146
  # subsequent pages.
92
147
  class ListTensorboardsResponse
@@ -94,14 +149,15 @@ module Google
94
149
  extend ::Google::Protobuf::MessageExts::ClassMethods
95
150
  end
96
151
 
97
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#update_tensorboard TensorboardService.UpdateTensorboard}.
152
+ # Request message for
153
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#update_tensorboard TensorboardService.UpdateTensorboard}.
98
154
  # @!attribute [rw] update_mask
99
155
  # @return [::Google::Protobuf::FieldMask]
100
156
  # Required. Field mask is used to specify the fields to be overwritten in the
101
157
  # Tensorboard resource by the update.
102
158
  # The fields specified in the update_mask are relative to the resource, not
103
- # the full request. A field will be overwritten if it is in the mask. If the
104
- # user does not provide a mask then all fields will be overwritten if new
159
+ # the full request. A field is overwritten if it's in the mask. If the
160
+ # user does not provide a mask then all fields are overwritten if new
105
161
  # values are specified.
106
162
  # @!attribute [rw] tensorboard
107
163
  # @return [::Google::Cloud::AIPlatform::V1::Tensorboard]
@@ -113,7 +169,8 @@ module Google
113
169
  extend ::Google::Protobuf::MessageExts::ClassMethods
114
170
  end
115
171
 
116
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#delete_tensorboard TensorboardService.DeleteTensorboard}.
172
+ # Request message for
173
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#delete_tensorboard TensorboardService.DeleteTensorboard}.
117
174
  # @!attribute [rw] name
118
175
  # @return [::String]
119
176
  # Required. The name of the Tensorboard to be deleted.
@@ -124,19 +181,20 @@ module Google
124
181
  extend ::Google::Protobuf::MessageExts::ClassMethods
125
182
  end
126
183
 
127
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#create_tensorboard_experiment TensorboardService.CreateTensorboardExperiment}.
184
+ # Request message for
185
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#create_tensorboard_experiment TensorboardService.CreateTensorboardExperiment}.
128
186
  # @!attribute [rw] parent
129
187
  # @return [::String]
130
- # Required. The resource name of the Tensorboard to create the TensorboardExperiment
131
- # in. Format:
188
+ # Required. The resource name of the Tensorboard to create the
189
+ # TensorboardExperiment in. Format:
132
190
  # `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
133
191
  # @!attribute [rw] tensorboard_experiment
134
192
  # @return [::Google::Cloud::AIPlatform::V1::TensorboardExperiment]
135
193
  # The TensorboardExperiment to create.
136
194
  # @!attribute [rw] tensorboard_experiment_id
137
195
  # @return [::String]
138
- # Required. The ID to use for the Tensorboard experiment, which will become the final
139
- # component of the Tensorboard experiment's resource name.
196
+ # Required. The ID to use for the Tensorboard experiment, which becomes the
197
+ # final component of the Tensorboard experiment's resource name.
140
198
  #
141
199
  # This value should be 1-128 characters, and valid characters
142
200
  # are /[a-z][0-9]-/.
@@ -145,7 +203,8 @@ module Google
145
203
  extend ::Google::Protobuf::MessageExts::ClassMethods
146
204
  end
147
205
 
148
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#get_tensorboard_experiment TensorboardService.GetTensorboardExperiment}.
206
+ # Request message for
207
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#get_tensorboard_experiment TensorboardService.GetTensorboardExperiment}.
149
208
  # @!attribute [rw] name
150
209
  # @return [::String]
151
210
  # Required. The name of the TensorboardExperiment resource.
@@ -156,11 +215,12 @@ module Google
156
215
  extend ::Google::Protobuf::MessageExts::ClassMethods
157
216
  end
158
217
 
159
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_experiments TensorboardService.ListTensorboardExperiments}.
218
+ # Request message for
219
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_experiments TensorboardService.ListTensorboardExperiments}.
160
220
  # @!attribute [rw] parent
161
221
  # @return [::String]
162
- # Required. The resource name of the Tensorboard to list TensorboardExperiments.
163
- # Format:
222
+ # Required. The resource name of the Tensorboard to list
223
+ # TensorboardExperiments. Format:
164
224
  # `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
165
225
  # @!attribute [rw] filter
166
226
  # @return [::String]
@@ -169,17 +229,17 @@ module Google
169
229
  # @return [::Integer]
170
230
  # The maximum number of TensorboardExperiments to return. The service may
171
231
  # return fewer than this value. If unspecified, at most 50
172
- # TensorboardExperiments will be returned. The maximum value is 1000; values
173
- # above 1000 will be coerced to 1000.
232
+ # TensorboardExperiments are returned. The maximum value is 1000; values
233
+ # above 1000 are coerced to 1000.
174
234
  # @!attribute [rw] page_token
175
235
  # @return [::String]
176
236
  # A page token, received from a previous
177
- # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_experiments TensorboardService.ListTensorboardExperiments} call.
178
- # Provide this to retrieve the subsequent page.
237
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_experiments TensorboardService.ListTensorboardExperiments}
238
+ # call. Provide this to retrieve the subsequent page.
179
239
  #
180
240
  # When paginating, all other parameters provided to
181
- # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_experiments TensorboardService.ListTensorboardExperiments} must
182
- # match the call that provided the page token.
241
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_experiments TensorboardService.ListTensorboardExperiments}
242
+ # must match the call that provided the page token.
183
243
  # @!attribute [rw] order_by
184
244
  # @return [::String]
185
245
  # Field to use to sort the list.
@@ -191,28 +251,31 @@ module Google
191
251
  extend ::Google::Protobuf::MessageExts::ClassMethods
192
252
  end
193
253
 
194
- # Response message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_experiments TensorboardService.ListTensorboardExperiments}.
254
+ # Response message for
255
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_experiments TensorboardService.ListTensorboardExperiments}.
195
256
  # @!attribute [rw] tensorboard_experiments
196
257
  # @return [::Array<::Google::Cloud::AIPlatform::V1::TensorboardExperiment>]
197
258
  # The TensorboardExperiments mathching the request.
198
259
  # @!attribute [rw] next_page_token
199
260
  # @return [::String]
200
261
  # A token, which can be sent as
201
- # {::Google::Cloud::AIPlatform::V1::ListTensorboardExperimentsRequest#page_token ListTensorboardExperimentsRequest.page_token} to retrieve the next page.
202
- # If this field is omitted, there are no subsequent pages.
262
+ # {::Google::Cloud::AIPlatform::V1::ListTensorboardExperimentsRequest#page_token ListTensorboardExperimentsRequest.page_token}
263
+ # to retrieve the next page. If this field is omitted, there are no
264
+ # subsequent pages.
203
265
  class ListTensorboardExperimentsResponse
204
266
  include ::Google::Protobuf::MessageExts
205
267
  extend ::Google::Protobuf::MessageExts::ClassMethods
206
268
  end
207
269
 
208
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#update_tensorboard_experiment TensorboardService.UpdateTensorboardExperiment}.
270
+ # Request message for
271
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#update_tensorboard_experiment TensorboardService.UpdateTensorboardExperiment}.
209
272
  # @!attribute [rw] update_mask
210
273
  # @return [::Google::Protobuf::FieldMask]
211
274
  # Required. Field mask is used to specify the fields to be overwritten in the
212
275
  # TensorboardExperiment resource by the update.
213
276
  # The fields specified in the update_mask are relative to the resource, not
214
- # the full request. A field will be overwritten if it is in the mask. If the
215
- # user does not provide a mask then all fields will be overwritten if new
277
+ # the full request. A field is overwritten if it's in the mask. If the
278
+ # user does not provide a mask then all fields are overwritten if new
216
279
  # values are specified.
217
280
  # @!attribute [rw] tensorboard_experiment
218
281
  # @return [::Google::Cloud::AIPlatform::V1::TensorboardExperiment]
@@ -224,7 +287,8 @@ module Google
224
287
  extend ::Google::Protobuf::MessageExts::ClassMethods
225
288
  end
226
289
 
227
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#delete_tensorboard_experiment TensorboardService.DeleteTensorboardExperiment}.
290
+ # Request message for
291
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#delete_tensorboard_experiment TensorboardService.DeleteTensorboardExperiment}.
228
292
  # @!attribute [rw] name
229
293
  # @return [::String]
230
294
  # Required. The name of the TensorboardExperiment to be deleted.
@@ -235,7 +299,8 @@ module Google
235
299
  extend ::Google::Protobuf::MessageExts::ClassMethods
236
300
  end
237
301
 
238
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#batch_create_tensorboard_runs TensorboardService.BatchCreateTensorboardRuns}.
302
+ # Request message for
303
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#batch_create_tensorboard_runs TensorboardService.BatchCreateTensorboardRuns}.
239
304
  # @!attribute [rw] parent
240
305
  # @return [::String]
241
306
  # Required. The resource name of the TensorboardExperiment to create the
@@ -252,7 +317,8 @@ module Google
252
317
  extend ::Google::Protobuf::MessageExts::ClassMethods
253
318
  end
254
319
 
255
- # Response message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#batch_create_tensorboard_runs TensorboardService.BatchCreateTensorboardRuns}.
320
+ # Response message for
321
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#batch_create_tensorboard_runs TensorboardService.BatchCreateTensorboardRuns}.
256
322
  # @!attribute [rw] tensorboard_runs
257
323
  # @return [::Array<::Google::Cloud::AIPlatform::V1::TensorboardRun>]
258
324
  # The created TensorboardRuns.
@@ -261,18 +327,19 @@ module Google
261
327
  extend ::Google::Protobuf::MessageExts::ClassMethods
262
328
  end
263
329
 
264
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#create_tensorboard_run TensorboardService.CreateTensorboardRun}.
330
+ # Request message for
331
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#create_tensorboard_run TensorboardService.CreateTensorboardRun}.
265
332
  # @!attribute [rw] parent
266
333
  # @return [::String]
267
- # Required. The resource name of the TensorboardExperiment to create the TensorboardRun
268
- # in. Format:
334
+ # Required. The resource name of the TensorboardExperiment to create the
335
+ # TensorboardRun in. Format:
269
336
  # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
270
337
  # @!attribute [rw] tensorboard_run
271
338
  # @return [::Google::Cloud::AIPlatform::V1::TensorboardRun]
272
339
  # Required. The TensorboardRun to create.
273
340
  # @!attribute [rw] tensorboard_run_id
274
341
  # @return [::String]
275
- # Required. The ID to use for the Tensorboard run, which will become the final
342
+ # Required. The ID to use for the Tensorboard run, which becomes the final
276
343
  # component of the Tensorboard run's resource name.
277
344
  #
278
345
  # This value should be 1-128 characters, and valid characters
@@ -282,7 +349,8 @@ module Google
282
349
  extend ::Google::Protobuf::MessageExts::ClassMethods
283
350
  end
284
351
 
285
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#get_tensorboard_run TensorboardService.GetTensorboardRun}.
352
+ # Request message for
353
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#get_tensorboard_run TensorboardService.GetTensorboardRun}.
286
354
  # @!attribute [rw] name
287
355
  # @return [::String]
288
356
  # Required. The name of the TensorboardRun resource.
@@ -293,7 +361,8 @@ module Google
293
361
  extend ::Google::Protobuf::MessageExts::ClassMethods
294
362
  end
295
363
 
296
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#read_tensorboard_blob_data TensorboardService.ReadTensorboardBlobData}.
364
+ # Request message for
365
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#read_tensorboard_blob_data TensorboardService.ReadTensorboardBlobData}.
297
366
  # @!attribute [rw] time_series
298
367
  # @return [::String]
299
368
  # Required. The resource name of the TensorboardTimeSeries to list Blobs.
@@ -307,7 +376,8 @@ module Google
307
376
  extend ::Google::Protobuf::MessageExts::ClassMethods
308
377
  end
309
378
 
310
- # Response message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#read_tensorboard_blob_data TensorboardService.ReadTensorboardBlobData}.
379
+ # Response message for
380
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#read_tensorboard_blob_data TensorboardService.ReadTensorboardBlobData}.
311
381
  # @!attribute [rw] blobs
312
382
  # @return [::Array<::Google::Cloud::AIPlatform::V1::TensorboardBlob>]
313
383
  # Blob messages containing blob bytes.
@@ -316,11 +386,12 @@ module Google
316
386
  extend ::Google::Protobuf::MessageExts::ClassMethods
317
387
  end
318
388
 
319
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_runs TensorboardService.ListTensorboardRuns}.
389
+ # Request message for
390
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_runs TensorboardService.ListTensorboardRuns}.
320
391
  # @!attribute [rw] parent
321
392
  # @return [::String]
322
- # Required. The resource name of the TensorboardExperiment to list TensorboardRuns.
323
- # Format:
393
+ # Required. The resource name of the TensorboardExperiment to list
394
+ # TensorboardRuns. Format:
324
395
  # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
325
396
  # @!attribute [rw] filter
326
397
  # @return [::String]
@@ -328,18 +399,18 @@ module Google
328
399
  # @!attribute [rw] page_size
329
400
  # @return [::Integer]
330
401
  # The maximum number of TensorboardRuns to return. The service may return
331
- # fewer than this value. If unspecified, at most 50 TensorboardRuns will be
332
- # returned. The maximum value is 1000; values above 1000 will be coerced to
402
+ # fewer than this value. If unspecified, at most 50 TensorboardRuns are
403
+ # returned. The maximum value is 1000; values above 1000 are coerced to
333
404
  # 1000.
334
405
  # @!attribute [rw] page_token
335
406
  # @return [::String]
336
407
  # A page token, received from a previous
337
- # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_runs TensorboardService.ListTensorboardRuns} call.
338
- # Provide this to retrieve the subsequent page.
408
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_runs TensorboardService.ListTensorboardRuns}
409
+ # call. Provide this to retrieve the subsequent page.
339
410
  #
340
411
  # When paginating, all other parameters provided to
341
- # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_runs TensorboardService.ListTensorboardRuns} must
342
- # match the call that provided the page token.
412
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_runs TensorboardService.ListTensorboardRuns}
413
+ # must match the call that provided the page token.
343
414
  # @!attribute [rw] order_by
344
415
  # @return [::String]
345
416
  # Field to use to sort the list.
@@ -351,40 +422,44 @@ module Google
351
422
  extend ::Google::Protobuf::MessageExts::ClassMethods
352
423
  end
353
424
 
354
- # Response message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_runs TensorboardService.ListTensorboardRuns}.
425
+ # Response message for
426
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_runs TensorboardService.ListTensorboardRuns}.
355
427
  # @!attribute [rw] tensorboard_runs
356
428
  # @return [::Array<::Google::Cloud::AIPlatform::V1::TensorboardRun>]
357
429
  # The TensorboardRuns mathching the request.
358
430
  # @!attribute [rw] next_page_token
359
431
  # @return [::String]
360
- # A token, which can be sent as {::Google::Cloud::AIPlatform::V1::ListTensorboardRunsRequest#page_token ListTensorboardRunsRequest.page_token} to
361
- # retrieve the next page.
362
- # If this field is omitted, there are no subsequent pages.
432
+ # A token, which can be sent as
433
+ # {::Google::Cloud::AIPlatform::V1::ListTensorboardRunsRequest#page_token ListTensorboardRunsRequest.page_token}
434
+ # to retrieve the next page. If this field is omitted, there are no
435
+ # subsequent pages.
363
436
  class ListTensorboardRunsResponse
364
437
  include ::Google::Protobuf::MessageExts
365
438
  extend ::Google::Protobuf::MessageExts::ClassMethods
366
439
  end
367
440
 
368
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#update_tensorboard_run TensorboardService.UpdateTensorboardRun}.
441
+ # Request message for
442
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#update_tensorboard_run TensorboardService.UpdateTensorboardRun}.
369
443
  # @!attribute [rw] update_mask
370
444
  # @return [::Google::Protobuf::FieldMask]
371
445
  # Required. Field mask is used to specify the fields to be overwritten in the
372
446
  # TensorboardRun resource by the update.
373
447
  # The fields specified in the update_mask are relative to the resource, not
374
- # the full request. A field will be overwritten if it is in the mask. If the
375
- # user does not provide a mask then all fields will be overwritten if new
448
+ # the full request. A field is overwritten if it's in the mask. If the
449
+ # user does not provide a mask then all fields are overwritten if new
376
450
  # values are specified.
377
451
  # @!attribute [rw] tensorboard_run
378
452
  # @return [::Google::Cloud::AIPlatform::V1::TensorboardRun]
379
- # Required. The TensorboardRun's `name` field is used to identify the TensorboardRun to
380
- # be updated. Format:
453
+ # Required. The TensorboardRun's `name` field is used to identify the
454
+ # TensorboardRun to be updated. Format:
381
455
  # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
382
456
  class UpdateTensorboardRunRequest
383
457
  include ::Google::Protobuf::MessageExts
384
458
  extend ::Google::Protobuf::MessageExts::ClassMethods
385
459
  end
386
460
 
387
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#delete_tensorboard_run TensorboardService.DeleteTensorboardRun}.
461
+ # Request message for
462
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#delete_tensorboard_run TensorboardService.DeleteTensorboardRun}.
388
463
  # @!attribute [rw] name
389
464
  # @return [::String]
390
465
  # Required. The name of the TensorboardRun to be deleted.
@@ -395,7 +470,8 @@ module Google
395
470
  extend ::Google::Protobuf::MessageExts::ClassMethods
396
471
  end
397
472
 
398
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#batch_create_tensorboard_time_series TensorboardService.BatchCreateTensorboardTimeSeries}.
473
+ # Request message for
474
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#batch_create_tensorboard_time_series TensorboardService.BatchCreateTensorboardTimeSeries}.
399
475
  # @!attribute [rw] parent
400
476
  # @return [::String]
401
477
  # Required. The resource name of the TensorboardExperiment to create the
@@ -407,14 +483,15 @@ module Google
407
483
  # TensorboardExperiment.
408
484
  # @!attribute [rw] requests
409
485
  # @return [::Array<::Google::Cloud::AIPlatform::V1::CreateTensorboardTimeSeriesRequest>]
410
- # Required. The request message specifying the TensorboardTimeSeries to create.
411
- # A maximum of 1000 TensorboardTimeSeries can be created in a batch.
486
+ # Required. The request message specifying the TensorboardTimeSeries to
487
+ # create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.
412
488
  class BatchCreateTensorboardTimeSeriesRequest
413
489
  include ::Google::Protobuf::MessageExts
414
490
  extend ::Google::Protobuf::MessageExts::ClassMethods
415
491
  end
416
492
 
417
- # Response message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#batch_create_tensorboard_time_series TensorboardService.BatchCreateTensorboardTimeSeries}.
493
+ # Response message for
494
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#batch_create_tensorboard_time_series TensorboardService.BatchCreateTensorboardTimeSeries}.
418
495
  # @!attribute [rw] tensorboard_time_series
419
496
  # @return [::Array<::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries>]
420
497
  # The created TensorboardTimeSeries.
@@ -423,7 +500,8 @@ module Google
423
500
  extend ::Google::Protobuf::MessageExts::ClassMethods
424
501
  end
425
502
 
426
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#create_tensorboard_time_series TensorboardService.CreateTensorboardTimeSeries}.
503
+ # Request message for
504
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#create_tensorboard_time_series TensorboardService.CreateTensorboardTimeSeries}.
427
505
  # @!attribute [rw] parent
428
506
  # @return [::String]
429
507
  # Required. The resource name of the TensorboardRun to create the
@@ -432,10 +510,10 @@ module Google
432
510
  # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
433
511
  # @!attribute [rw] tensorboard_time_series_id
434
512
  # @return [::String]
435
- # Optional. The user specified unique ID to use for the TensorboardTimeSeries, which
436
- # will become the final component of the TensorboardTimeSeries's resource
437
- # name.
438
- # This value should match "[a-z0-9][a-z0-9-]\\{0, 127}"
513
+ # Optional. The user specified unique ID to use for the
514
+ # TensorboardTimeSeries, which becomes the final component of the
515
+ # TensorboardTimeSeries's resource name. This value should match
516
+ # "[a-z0-9][a-z0-9-]\\{0, 127}"
439
517
  # @!attribute [rw] tensorboard_time_series
440
518
  # @return [::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries]
441
519
  # Required. The TensorboardTimeSeries to create.
@@ -444,7 +522,8 @@ module Google
444
522
  extend ::Google::Protobuf::MessageExts::ClassMethods
445
523
  end
446
524
 
447
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#get_tensorboard_time_series TensorboardService.GetTensorboardTimeSeries}.
525
+ # Request message for
526
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#get_tensorboard_time_series TensorboardService.GetTensorboardTimeSeries}.
448
527
  # @!attribute [rw] name
449
528
  # @return [::String]
450
529
  # Required. The name of the TensorboardTimeSeries resource.
@@ -455,11 +534,12 @@ module Google
455
534
  extend ::Google::Protobuf::MessageExts::ClassMethods
456
535
  end
457
536
 
458
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_time_series TensorboardService.ListTensorboardTimeSeries}.
537
+ # Request message for
538
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_time_series TensorboardService.ListTensorboardTimeSeries}.
459
539
  # @!attribute [rw] parent
460
540
  # @return [::String]
461
- # Required. The resource name of the TensorboardRun to list TensorboardTimeSeries.
462
- # Format:
541
+ # Required. The resource name of the TensorboardRun to list
542
+ # TensorboardTimeSeries. Format:
463
543
  # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
464
544
  # @!attribute [rw] filter
465
545
  # @return [::String]
@@ -468,17 +548,17 @@ module Google
468
548
  # @return [::Integer]
469
549
  # The maximum number of TensorboardTimeSeries to return. The service may
470
550
  # return fewer than this value. If unspecified, at most 50
471
- # TensorboardTimeSeries will be returned. The maximum value is 1000; values
472
- # above 1000 will be coerced to 1000.
551
+ # TensorboardTimeSeries are returned. The maximum value is 1000; values
552
+ # above 1000 are coerced to 1000.
473
553
  # @!attribute [rw] page_token
474
554
  # @return [::String]
475
555
  # A page token, received from a previous
476
- # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_time_series TensorboardService.ListTensorboardTimeSeries} call.
477
- # Provide this to retrieve the subsequent page.
556
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_time_series TensorboardService.ListTensorboardTimeSeries}
557
+ # call. Provide this to retrieve the subsequent page.
478
558
  #
479
559
  # When paginating, all other parameters provided to
480
- # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_time_series TensorboardService.ListTensorboardTimeSeries} must
481
- # match the call that provided the page token.
560
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_time_series TensorboardService.ListTensorboardTimeSeries}
561
+ # must match the call that provided the page token.
482
562
  # @!attribute [rw] order_by
483
563
  # @return [::String]
484
564
  # Field to use to sort the list.
@@ -490,28 +570,31 @@ module Google
490
570
  extend ::Google::Protobuf::MessageExts::ClassMethods
491
571
  end
492
572
 
493
- # Response message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_time_series TensorboardService.ListTensorboardTimeSeries}.
573
+ # Response message for
574
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#list_tensorboard_time_series TensorboardService.ListTensorboardTimeSeries}.
494
575
  # @!attribute [rw] tensorboard_time_series
495
576
  # @return [::Array<::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries>]
496
577
  # The TensorboardTimeSeries mathching the request.
497
578
  # @!attribute [rw] next_page_token
498
579
  # @return [::String]
499
580
  # A token, which can be sent as
500
- # {::Google::Cloud::AIPlatform::V1::ListTensorboardTimeSeriesRequest#page_token ListTensorboardTimeSeriesRequest.page_token} to retrieve the next page.
501
- # If this field is omitted, there are no subsequent pages.
581
+ # {::Google::Cloud::AIPlatform::V1::ListTensorboardTimeSeriesRequest#page_token ListTensorboardTimeSeriesRequest.page_token}
582
+ # to retrieve the next page. If this field is omitted, there are no
583
+ # subsequent pages.
502
584
  class ListTensorboardTimeSeriesResponse
503
585
  include ::Google::Protobuf::MessageExts
504
586
  extend ::Google::Protobuf::MessageExts::ClassMethods
505
587
  end
506
588
 
507
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#update_tensorboard_time_series TensorboardService.UpdateTensorboardTimeSeries}.
589
+ # Request message for
590
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#update_tensorboard_time_series TensorboardService.UpdateTensorboardTimeSeries}.
508
591
  # @!attribute [rw] update_mask
509
592
  # @return [::Google::Protobuf::FieldMask]
510
593
  # Required. Field mask is used to specify the fields to be overwritten in the
511
594
  # TensorboardTimeSeries resource by the update.
512
595
  # The fields specified in the update_mask are relative to the resource, not
513
- # the full request. A field will be overwritten if it is in the mask. If the
514
- # user does not provide a mask then all fields will be overwritten if new
596
+ # the full request. A field is overwritten if it's in the mask. If the
597
+ # user does not provide a mask then all fields are overwritten if new
515
598
  # values are specified.
516
599
  # @!attribute [rw] tensorboard_time_series
517
600
  # @return [::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries]
@@ -524,7 +607,8 @@ module Google
524
607
  extend ::Google::Protobuf::MessageExts::ClassMethods
525
608
  end
526
609
 
527
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#delete_tensorboard_time_series TensorboardService.DeleteTensorboardTimeSeries}.
610
+ # Request message for
611
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#delete_tensorboard_time_series TensorboardService.DeleteTensorboardTimeSeries}.
528
612
  # @!attribute [rw] name
529
613
  # @return [::String]
530
614
  # Required. The name of the TensorboardTimeSeries to be deleted.
@@ -539,14 +623,16 @@ module Google
539
623
  # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#batch_read_tensorboard_time_series_data TensorboardService.BatchReadTensorboardTimeSeriesData}.
540
624
  # @!attribute [rw] tensorboard
541
625
  # @return [::String]
542
- # Required. The resource name of the Tensorboard containing TensorboardTimeSeries to
543
- # read data from. Format:
626
+ # Required. The resource name of the Tensorboard containing
627
+ # TensorboardTimeSeries to read data from. Format:
544
628
  # `projects/{project}/locations/{location}/tensorboards/{tensorboard}`.
545
- # The TensorboardTimeSeries referenced by {::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataRequest#time_series time_series} must be sub
546
- # resources of this Tensorboard.
629
+ # The TensorboardTimeSeries referenced by
630
+ # {::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataRequest#time_series time_series}
631
+ # must be sub resources of this Tensorboard.
547
632
  # @!attribute [rw] time_series
548
633
  # @return [::Array<::String>]
549
- # Required. The resource names of the TensorboardTimeSeries to read data from. Format:
634
+ # Required. The resource names of the TensorboardTimeSeries to read data
635
+ # from. Format:
550
636
  # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
551
637
  class BatchReadTensorboardTimeSeriesDataRequest
552
638
  include ::Google::Protobuf::MessageExts
@@ -563,7 +649,8 @@ module Google
563
649
  extend ::Google::Protobuf::MessageExts::ClassMethods
564
650
  end
565
651
 
566
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#read_tensorboard_time_series_data TensorboardService.ReadTensorboardTimeSeriesData}.
652
+ # Request message for
653
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#read_tensorboard_time_series_data TensorboardService.ReadTensorboardTimeSeriesData}.
567
654
  # @!attribute [rw] tensorboard_time_series
568
655
  # @return [::String]
569
656
  # Required. The resource name of the TensorboardTimeSeries to read data from.
@@ -583,7 +670,8 @@ module Google
583
670
  extend ::Google::Protobuf::MessageExts::ClassMethods
584
671
  end
585
672
 
586
- # Response message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#read_tensorboard_time_series_data TensorboardService.ReadTensorboardTimeSeriesData}.
673
+ # Response message for
674
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#read_tensorboard_time_series_data TensorboardService.ReadTensorboardTimeSeriesData}.
587
675
  # @!attribute [rw] time_series_data
588
676
  # @return [::Google::Cloud::AIPlatform::V1::TimeSeriesData]
589
677
  # The returned time series data.
@@ -592,7 +680,8 @@ module Google
592
680
  extend ::Google::Protobuf::MessageExts::ClassMethods
593
681
  end
594
682
 
595
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#write_tensorboard_experiment_data TensorboardService.WriteTensorboardExperimentData}.
683
+ # Request message for
684
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#write_tensorboard_experiment_data TensorboardService.WriteTensorboardExperimentData}.
596
685
  # @!attribute [rw] tensorboard_experiment
597
686
  # @return [::String]
598
687
  # Required. The resource name of the TensorboardExperiment to write data to.
@@ -606,13 +695,15 @@ module Google
606
695
  extend ::Google::Protobuf::MessageExts::ClassMethods
607
696
  end
608
697
 
609
- # Response message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#write_tensorboard_experiment_data TensorboardService.WriteTensorboardExperimentData}.
698
+ # Response message for
699
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#write_tensorboard_experiment_data TensorboardService.WriteTensorboardExperimentData}.
610
700
  class WriteTensorboardExperimentDataResponse
611
701
  include ::Google::Protobuf::MessageExts
612
702
  extend ::Google::Protobuf::MessageExts::ClassMethods
613
703
  end
614
704
 
615
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#write_tensorboard_run_data TensorboardService.WriteTensorboardRunData}.
705
+ # Request message for
706
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#write_tensorboard_run_data TensorboardService.WriteTensorboardRunData}.
616
707
  # @!attribute [rw] tensorboard_run
617
708
  # @return [::String]
618
709
  # Required. The resource name of the TensorboardRun to write data to.
@@ -630,17 +721,19 @@ module Google
630
721
  extend ::Google::Protobuf::MessageExts::ClassMethods
631
722
  end
632
723
 
633
- # Response message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#write_tensorboard_run_data TensorboardService.WriteTensorboardRunData}.
724
+ # Response message for
725
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#write_tensorboard_run_data TensorboardService.WriteTensorboardRunData}.
634
726
  class WriteTensorboardRunDataResponse
635
727
  include ::Google::Protobuf::MessageExts
636
728
  extend ::Google::Protobuf::MessageExts::ClassMethods
637
729
  end
638
730
 
639
- # Request message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#export_tensorboard_time_series_data TensorboardService.ExportTensorboardTimeSeriesData}.
731
+ # Request message for
732
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#export_tensorboard_time_series_data TensorboardService.ExportTensorboardTimeSeriesData}.
640
733
  # @!attribute [rw] tensorboard_time_series
641
734
  # @return [::String]
642
- # Required. The resource name of the TensorboardTimeSeries to export data from.
643
- # Format:
735
+ # Required. The resource name of the TensorboardTimeSeries to export data
736
+ # from. Format:
644
737
  # `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
645
738
  # @!attribute [rw] filter
646
739
  # @return [::String]
@@ -648,8 +741,8 @@ module Google
648
741
  # @!attribute [rw] page_size
649
742
  # @return [::Integer]
650
743
  # The maximum number of data points to return per page.
651
- # The default page_size will be 1000. Values must be between 1 and 10000.
652
- # Values above 10000 will be coerced to 10000.
744
+ # The default page_size is 1000. Values must be between 1 and 10000.
745
+ # Values above 10000 are coerced to 10000.
653
746
  # @!attribute [rw] page_token
654
747
  # @return [::String]
655
748
  # A page token, received from a previous
@@ -662,14 +755,15 @@ module Google
662
755
  # @!attribute [rw] order_by
663
756
  # @return [::String]
664
757
  # Field to use to sort the TensorboardTimeSeries' data.
665
- # By default, TensorboardTimeSeries' data will be returned in a pseudo random
758
+ # By default, TensorboardTimeSeries' data is returned in a pseudo random
666
759
  # order.
667
760
  class ExportTensorboardTimeSeriesDataRequest
668
761
  include ::Google::Protobuf::MessageExts
669
762
  extend ::Google::Protobuf::MessageExts::ClassMethods
670
763
  end
671
764
 
672
- # Response message for {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#export_tensorboard_time_series_data TensorboardService.ExportTensorboardTimeSeriesData}.
765
+ # Response message for
766
+ # {::Google::Cloud::AIPlatform::V1::TensorboardService::Client#export_tensorboard_time_series_data TensorboardService.ExportTensorboardTimeSeriesData}.
673
767
  # @!attribute [rw] time_series_data_points
674
768
  # @return [::Array<::Google::Cloud::AIPlatform::V1::TimeSeriesDataPoint>]
675
769
  # The returned time series data points.