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
@@ -76,7 +76,8 @@ module Google
76
76
  # Output only. URIs for accessing [interactive
77
77
  # shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
78
78
  # (one URI for each training node). Only available if
79
- # {::Google::Cloud::AIPlatform::V1::CustomJobSpec#enable_web_access job_spec.enable_web_access} is `true`.
79
+ # {::Google::Cloud::AIPlatform::V1::CustomJobSpec#enable_web_access job_spec.enable_web_access}
80
+ # is `true`.
80
81
  #
81
82
  # The keys are names of each node in the training job; for example,
82
83
  # `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
@@ -110,9 +111,9 @@ module Google
110
111
  # Represents the spec of a CustomJob.
111
112
  # @!attribute [rw] worker_pool_specs
112
113
  # @return [::Array<::Google::Cloud::AIPlatform::V1::WorkerPoolSpec>]
113
- # Required. The spec of the worker pools including machine type and Docker image.
114
- # All worker pools except the first one are optional and can be skipped by
115
- # providing an empty value.
114
+ # Required. The spec of the worker pools including machine type and Docker
115
+ # image. All worker pools except the first one are optional and can be
116
+ # skipped by providing an empty value.
116
117
  # @!attribute [rw] scheduling
117
118
  # @return [::Google::Cloud::AIPlatform::V1::Scheduling]
118
119
  # Scheduling options for a CustomJob.
@@ -154,8 +155,8 @@ module Google
154
155
  # HyperparameterTuningJob. For HyperparameterTuningJob,
155
156
  # the baseOutputDirectory of
156
157
  # each child CustomJob backing a Trial is set to a subdirectory of name
157
- # {::Google::Cloud::AIPlatform::V1::Trial#id id} under its parent HyperparameterTuningJob's
158
- # baseOutputDirectory.
158
+ # {::Google::Cloud::AIPlatform::V1::Trial#id id} under its parent
159
+ # HyperparameterTuningJob's baseOutputDirectory.
159
160
  #
160
161
  # The following Vertex AI environment variables will be passed to
161
162
  # containers or python modules when this field is set:
@@ -173,9 +174,9 @@ module Google
173
174
  # * AIP_TENSORBOARD_LOG_DIR = `<base_output_directory>/<trial_id>/logs/`
174
175
  # @!attribute [rw] tensorboard
175
176
  # @return [::String]
176
- # Optional. The name of a Vertex AI {::Google::Cloud::AIPlatform::V1::Tensorboard Tensorboard} resource to which this CustomJob
177
- # will upload Tensorboard logs.
178
- # Format:
177
+ # Optional. The name of a Vertex AI
178
+ # {::Google::Cloud::AIPlatform::V1::Tensorboard Tensorboard} resource to which
179
+ # this CustomJob will upload Tensorboard logs. Format:
179
180
  # `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
180
181
  # @!attribute [rw] enable_web_access
181
182
  # @return [::Boolean]
@@ -184,7 +185,23 @@ module Google
184
185
  # to training containers.
185
186
  #
186
187
  # If set to `true`, you can access interactive shells at the URIs given
187
- # by {::Google::Cloud::AIPlatform::V1::CustomJob#web_access_uris CustomJob.web_access_uris} or {::Google::Cloud::AIPlatform::V1::Trial#web_access_uris Trial.web_access_uris} (within
188
+ # by
189
+ # {::Google::Cloud::AIPlatform::V1::CustomJob#web_access_uris CustomJob.web_access_uris}
190
+ # or
191
+ # {::Google::Cloud::AIPlatform::V1::Trial#web_access_uris Trial.web_access_uris}
192
+ # (within
193
+ # {::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob#trials HyperparameterTuningJob.trials}).
194
+ # @!attribute [rw] enable_dashboard_access
195
+ # @return [::Boolean]
196
+ # Optional. Whether you want Vertex AI to enable access to the customized
197
+ # dashboard in training chief container.
198
+ #
199
+ # If set to `true`, you can access the dashboard at the URIs given
200
+ # by
201
+ # {::Google::Cloud::AIPlatform::V1::CustomJob#web_access_uris CustomJob.web_access_uris}
202
+ # or
203
+ # {::Google::Cloud::AIPlatform::V1::Trial#web_access_uris Trial.web_access_uris}
204
+ # (within
188
205
  # {::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob#trials HyperparameterTuningJob.trials}).
189
206
  class CustomJobSpec
190
207
  include ::Google::Protobuf::MessageExts
@@ -218,8 +235,8 @@ module Google
218
235
  # The spec of a Container.
219
236
  # @!attribute [rw] image_uri
220
237
  # @return [::String]
221
- # Required. The URI of a container image in the Container Registry that is to be run on
222
- # each worker replica.
238
+ # Required. The URI of a container image in the Container Registry that is to
239
+ # be run on each worker replica.
223
240
  # @!attribute [rw] command
224
241
  # @return [::Array<::String>]
225
242
  # The command to be invoked when the container is started.
@@ -239,17 +256,17 @@ module Google
239
256
  # The spec of a Python packaged code.
240
257
  # @!attribute [rw] executor_image_uri
241
258
  # @return [::String]
242
- # Required. The URI of a container image in Artifact Registry that will run the
243
- # provided Python package. Vertex AI provides a wide range of executor
259
+ # Required. The URI of a container image in Artifact Registry that will run
260
+ # the provided Python package. Vertex AI provides a wide range of executor
244
261
  # images with pre-installed packages to meet users' various use cases. See
245
262
  # the list of [pre-built containers for
246
263
  # training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
247
264
  # You must use an image from this list.
248
265
  # @!attribute [rw] package_uris
249
266
  # @return [::Array<::String>]
250
- # Required. The Google Cloud Storage location of the Python package files which are
251
- # the training program and its dependent packages.
252
- # The maximum number of package URIs is 100.
267
+ # Required. The Google Cloud Storage location of the Python package files
268
+ # which are the training program and its dependent packages. The maximum
269
+ # number of package URIs is 100.
253
270
  # @!attribute [rw] python_module
254
271
  # @return [::String]
255
272
  # Required. The Python module name to run after installing the packages.
@@ -47,13 +47,14 @@ module Google
47
47
  # and are immutable.
48
48
  # @!attribute [rw] payload
49
49
  # @return [::Google::Protobuf::Value]
50
- # Required. The data that the DataItem represents (for example, an image or a text
51
- # snippet). The schema of the payload is stored in the parent Dataset's
52
- # [metadata schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] dataItemSchemaUri field.
50
+ # Required. The data that the DataItem represents (for example, an image or a
51
+ # text snippet). The schema of the payload is stored in the parent Dataset's
52
+ # [metadata schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
53
+ # dataItemSchemaUri field.
53
54
  # @!attribute [rw] etag
54
55
  # @return [::String]
55
- # Optional. Used to perform consistent read-modify-write updates. If not set, a blind
56
- # "overwrite" update happens.
56
+ # Optional. Used to perform consistent read-modify-write updates. If not set,
57
+ # a blind "overwrite" update happens.
57
58
  class DataItem
58
59
  include ::Google::Protobuf::MessageExts
59
60
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -34,9 +34,8 @@ module Google
34
34
  # Display name of a DataLabelingJob.
35
35
  # @!attribute [rw] datasets
36
36
  # @return [::Array<::String>]
37
- # Required. Dataset resource names. Right now we only support labeling from a single
38
- # Dataset.
39
- # Format:
37
+ # Required. Dataset resource names. Right now we only support labeling from a
38
+ # single Dataset. Format:
40
39
  # `projects/{project}/locations/{location}/datasets/{dataset}`
41
40
  # @!attribute [rw] annotation_labels
42
41
  # @return [::Google::Protobuf::Map{::String => ::String}]
@@ -53,14 +52,14 @@ module Google
53
52
  # Required. Number of labelers to work on each DataItem.
54
53
  # @!attribute [rw] instruction_uri
55
54
  # @return [::String]
56
- # Required. The Google Cloud Storage location of the instruction pdf. This pdf is
57
- # shared with labelers, and provides detailed description on how to label
58
- # DataItems in Datasets.
55
+ # Required. The Google Cloud Storage location of the instruction pdf. This
56
+ # pdf is shared with labelers, and provides detailed description on how to
57
+ # label DataItems in Datasets.
59
58
  # @!attribute [rw] inputs_schema_uri
60
59
  # @return [::String]
61
- # Required. Points to a YAML file stored on Google Cloud Storage describing the
62
- # config for a specific type of DataLabelingJob.
63
- # The schema files that can be used here are found in the
60
+ # Required. Points to a YAML file stored on Google Cloud Storage describing
61
+ # the config for a specific type of DataLabelingJob. The schema files that
62
+ # can be used here are found in the
64
63
  # https://storage.googleapis.com/google-cloud-aiplatform bucket in the
65
64
  # /schema/datalabelingjob/inputs/ folder.
66
65
  # @!attribute [rw] inputs
@@ -71,12 +70,12 @@ module Google
71
70
  # Output only. The detailed state of the job.
72
71
  # @!attribute [r] labeling_progress
73
72
  # @return [::Integer]
74
- # Output only. Current labeling job progress percentage scaled in interval [0, 100],
75
- # indicating the percentage of DataItems that has been finished.
73
+ # Output only. Current labeling job progress percentage scaled in interval
74
+ # [0, 100], indicating the percentage of DataItems that has been finished.
76
75
  # @!attribute [r] current_spend
77
76
  # @return [::Google::Type::Money]
78
- # Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to
79
- # date.
77
+ # Output only. Estimated cost(in US dollars) that the DataLabelingJob has
78
+ # incurred to date.
80
79
  # @!attribute [r] create_time
81
80
  # @return [::Google::Protobuf::Timestamp]
82
81
  # Output only. Timestamp when this DataLabelingJob was created.
@@ -85,8 +84,8 @@ module Google
85
84
  # Output only. Timestamp when this DataLabelingJob was updated most recently.
86
85
  # @!attribute [r] error
87
86
  # @return [::Google::Rpc::Status]
88
- # Output only. DataLabelingJob errors. It is only populated when job's state is
89
- # `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
87
+ # Output only. DataLabelingJob errors. It is only populated when job's state
88
+ # is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
90
89
  # @!attribute [rw] labels
91
90
  # @return [::Google::Protobuf::Map{::String => ::String}]
92
91
  # The labels with user-defined metadata to organize your DataLabelingJobs.
@@ -100,7 +99,8 @@ module Google
100
99
  # and are immutable. Following system labels exist for each DataLabelingJob:
101
100
  #
102
101
  # * "aiplatform.googleapis.com/schema": output only, its value is the
103
- # {::Google::Cloud::AIPlatform::V1::DataLabelingJob#inputs_schema_uri inputs_schema}'s title.
102
+ # {::Google::Cloud::AIPlatform::V1::DataLabelingJob#inputs_schema_uri inputs_schema}'s
103
+ # title.
104
104
  # @!attribute [rw] specialist_pools
105
105
  # @return [::Array<::String>]
106
106
  # The SpecialistPools' resource names associated with this job.
@@ -35,11 +35,10 @@ module Google
35
35
  # The description of the Dataset.
36
36
  # @!attribute [rw] metadata_schema_uri
37
37
  # @return [::String]
38
- # Required. Points to a YAML file stored on Google Cloud Storage describing additional
39
- # information about the Dataset.
40
- # The schema is defined as an OpenAPI 3.0.2 Schema Object.
41
- # The schema files that can be used here are found in
42
- # gs://google-cloud-aiplatform/schema/dataset/metadata/.
38
+ # Required. Points to a YAML file stored on Google Cloud Storage describing
39
+ # additional information about the Dataset. The schema is defined as an
40
+ # OpenAPI 3.0.2 Schema Object. The schema files that can be used here are
41
+ # found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
43
42
  # @!attribute [rw] metadata
44
43
  # @return [::Google::Protobuf::Value]
45
44
  # Required. Additional information about the Dataset.
@@ -68,15 +67,27 @@ module Google
68
67
  # and are immutable. Following system labels exist for each Dataset:
69
68
  #
70
69
  # * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its
71
- # value is the [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] title.
70
+ # value is the
71
+ # [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
72
+ # title.
73
+ # @!attribute [rw] saved_queries
74
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::SavedQuery>]
75
+ # All SavedQueries belong to the Dataset will be returned in List/Get
76
+ # Dataset response. The [annotation_specs][SavedQuery.annotation_specs] field
77
+ # will not be populated except for UI cases which will only use
78
+ # {::Google::Cloud::AIPlatform::V1::SavedQuery#annotation_spec_count annotation_spec_count}.
79
+ # In CreateDataset request, a SavedQuery is created together if
80
+ # this field is set, up to one SavedQuery can be set in CreateDatasetRequest.
81
+ # The SavedQuery should not contain any AnnotationSpec.
72
82
  # @!attribute [rw] encryption_spec
73
83
  # @return [::Google::Cloud::AIPlatform::V1::EncryptionSpec]
74
84
  # Customer-managed encryption key spec for a Dataset. If set, this Dataset
75
85
  # and all sub-resources of this Dataset will be secured by this key.
76
86
  # @!attribute [r] metadata_artifact
77
87
  # @return [::String]
78
- # Output only. The resource name of the Artifact that was created in MetadataStore when
79
- # creating the Dataset. The Artifact resource name pattern is
88
+ # Output only. The resource name of the Artifact that was created in
89
+ # MetadataStore when creating the Dataset. The Artifact resource name pattern
90
+ # is
80
91
  # `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
81
92
  class Dataset
82
93
  include ::Google::Protobuf::MessageExts
@@ -109,21 +120,26 @@ module Google
109
120
  # considered identical if their content bytes are identical (e.g. image bytes
110
121
  # or pdf bytes).
111
122
  # These labels will be overridden by Annotation labels specified inside index
112
- # file referenced by {::Google::Cloud::AIPlatform::V1::ImportDataConfig#import_schema_uri import_schema_uri}, e.g. jsonl file.
123
+ # file referenced by
124
+ # {::Google::Cloud::AIPlatform::V1::ImportDataConfig#import_schema_uri import_schema_uri},
125
+ # e.g. jsonl file.
113
126
  # @!attribute [rw] annotation_labels
114
127
  # @return [::Google::Protobuf::Map{::String => ::String}]
115
128
  # Labels that will be applied to newly imported Annotations. If two
116
129
  # Annotations are identical, one of them will be deduped. Two Annotations are
117
- # considered identical if their {::Google::Cloud::AIPlatform::V1::Annotation#payload payload},
118
- # {::Google::Cloud::AIPlatform::V1::Annotation#payload_schema_uri payload_schema_uri} and all of their
119
- # {::Google::Cloud::AIPlatform::V1::Annotation#labels labels} are the same.
120
- # These labels will be overridden by Annotation labels specified inside index
121
- # file referenced by {::Google::Cloud::AIPlatform::V1::ImportDataConfig#import_schema_uri import_schema_uri}, e.g. jsonl file.
130
+ # considered identical if their
131
+ # {::Google::Cloud::AIPlatform::V1::Annotation#payload payload},
132
+ # {::Google::Cloud::AIPlatform::V1::Annotation#payload_schema_uri payload_schema_uri}
133
+ # and all of their {::Google::Cloud::AIPlatform::V1::Annotation#labels labels} are
134
+ # the same. These labels will be overridden by Annotation labels specified
135
+ # inside index file referenced by
136
+ # {::Google::Cloud::AIPlatform::V1::ImportDataConfig#import_schema_uri import_schema_uri},
137
+ # e.g. jsonl file.
122
138
  # @!attribute [rw] import_schema_uri
123
139
  # @return [::String]
124
- # Required. Points to a YAML file stored on Google Cloud Storage describing the import
125
- # format. Validation will be done against the schema. The schema is defined
126
- # as an [OpenAPI 3.0.2 Schema
140
+ # Required. Points to a YAML file stored on Google Cloud Storage describing
141
+ # the import format. Validation will be done against the schema. The schema
142
+ # is defined as an [OpenAPI 3.0.2 Schema
127
143
  # Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
128
144
  class ImportDataConfig
129
145
  include ::Google::Protobuf::MessageExts
@@ -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::DatasetService::Client#create_dataset DatasetService.CreateDataset}.
24
+ # Request message for
25
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#create_dataset DatasetService.CreateDataset}.
25
26
  # @!attribute [rw] parent
26
27
  # @return [::String]
27
28
  # Required. The resource name of the Location to create the Dataset in.
@@ -34,7 +35,8 @@ module Google
34
35
  extend ::Google::Protobuf::MessageExts::ClassMethods
35
36
  end
36
37
 
37
- # Runtime operation information for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#create_dataset DatasetService.CreateDataset}.
38
+ # Runtime operation information for
39
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#create_dataset DatasetService.CreateDataset}.
38
40
  # @!attribute [rw] generic_metadata
39
41
  # @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
40
42
  # The operation generic information.
@@ -43,7 +45,8 @@ module Google
43
45
  extend ::Google::Protobuf::MessageExts::ClassMethods
44
46
  end
45
47
 
46
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#get_dataset DatasetService.GetDataset}.
48
+ # Request message for
49
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#get_dataset DatasetService.GetDataset}.
47
50
  # @!attribute [rw] name
48
51
  # @return [::String]
49
52
  # Required. The name of the Dataset resource.
@@ -55,15 +58,16 @@ module Google
55
58
  extend ::Google::Protobuf::MessageExts::ClassMethods
56
59
  end
57
60
 
58
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#update_dataset DatasetService.UpdateDataset}.
61
+ # Request message for
62
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#update_dataset DatasetService.UpdateDataset}.
59
63
  # @!attribute [rw] dataset
60
64
  # @return [::Google::Cloud::AIPlatform::V1::Dataset]
61
65
  # Required. The Dataset which replaces the resource on the server.
62
66
  # @!attribute [rw] update_mask
63
67
  # @return [::Google::Protobuf::FieldMask]
64
68
  # Required. The update mask applies to the resource.
65
- # For the `FieldMask` definition, see {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
66
- # Updatable fields:
69
+ # For the `FieldMask` definition, see
70
+ # {::Google::Protobuf::FieldMask google.protobuf.FieldMask}. Updatable fields:
67
71
  #
68
72
  # * `display_name`
69
73
  # * `description`
@@ -73,7 +77,8 @@ module Google
73
77
  extend ::Google::Protobuf::MessageExts::ClassMethods
74
78
  end
75
79
 
76
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_datasets DatasetService.ListDatasets}.
80
+ # Request message for
81
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_datasets DatasetService.ListDatasets}.
77
82
  # @!attribute [rw] parent
78
83
  # @return [::String]
79
84
  # Required. The name of the Dataset's parent resource.
@@ -117,7 +122,8 @@ module Google
117
122
  extend ::Google::Protobuf::MessageExts::ClassMethods
118
123
  end
119
124
 
120
- # Response message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_datasets DatasetService.ListDatasets}.
125
+ # Response message for
126
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_datasets DatasetService.ListDatasets}.
121
127
  # @!attribute [rw] datasets
122
128
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Dataset>]
123
129
  # A list of Datasets that matches the specified filter in the request.
@@ -129,7 +135,8 @@ module Google
129
135
  extend ::Google::Protobuf::MessageExts::ClassMethods
130
136
  end
131
137
 
132
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#delete_dataset DatasetService.DeleteDataset}.
138
+ # Request message for
139
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#delete_dataset DatasetService.DeleteDataset}.
133
140
  # @!attribute [rw] name
134
141
  # @return [::String]
135
142
  # Required. The resource name of the Dataset to delete.
@@ -140,7 +147,8 @@ module Google
140
147
  extend ::Google::Protobuf::MessageExts::ClassMethods
141
148
  end
142
149
 
143
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#import_data DatasetService.ImportData}.
150
+ # Request message for
151
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#import_data DatasetService.ImportData}.
144
152
  # @!attribute [rw] name
145
153
  # @return [::String]
146
154
  # Required. The name of the Dataset resource.
@@ -148,20 +156,22 @@ module Google
148
156
  # `projects/{project}/locations/{location}/datasets/{dataset}`
149
157
  # @!attribute [rw] import_configs
150
158
  # @return [::Array<::Google::Cloud::AIPlatform::V1::ImportDataConfig>]
151
- # Required. The desired input locations. The contents of all input locations will be
152
- # imported in one batch.
159
+ # Required. The desired input locations. The contents of all input locations
160
+ # will be imported in one batch.
153
161
  class ImportDataRequest
154
162
  include ::Google::Protobuf::MessageExts
155
163
  extend ::Google::Protobuf::MessageExts::ClassMethods
156
164
  end
157
165
 
158
- # Response message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#import_data DatasetService.ImportData}.
166
+ # Response message for
167
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#import_data DatasetService.ImportData}.
159
168
  class ImportDataResponse
160
169
  include ::Google::Protobuf::MessageExts
161
170
  extend ::Google::Protobuf::MessageExts::ClassMethods
162
171
  end
163
172
 
164
- # Runtime operation information for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#import_data DatasetService.ImportData}.
173
+ # Runtime operation information for
174
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#import_data DatasetService.ImportData}.
165
175
  # @!attribute [rw] generic_metadata
166
176
  # @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
167
177
  # The common part of the operation metadata.
@@ -170,7 +180,8 @@ module Google
170
180
  extend ::Google::Protobuf::MessageExts::ClassMethods
171
181
  end
172
182
 
173
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#export_data DatasetService.ExportData}.
183
+ # Request message for
184
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#export_data DatasetService.ExportData}.
174
185
  # @!attribute [rw] name
175
186
  # @return [::String]
176
187
  # Required. The name of the Dataset resource.
@@ -184,7 +195,8 @@ module Google
184
195
  extend ::Google::Protobuf::MessageExts::ClassMethods
185
196
  end
186
197
 
187
- # Response message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#export_data DatasetService.ExportData}.
198
+ # Response message for
199
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#export_data DatasetService.ExportData}.
188
200
  # @!attribute [rw] exported_files
189
201
  # @return [::Array<::String>]
190
202
  # All of the files that are exported in this export operation.
@@ -193,7 +205,8 @@ module Google
193
205
  extend ::Google::Protobuf::MessageExts::ClassMethods
194
206
  end
195
207
 
196
- # Runtime operation information for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#export_data DatasetService.ExportData}.
208
+ # Runtime operation information for
209
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#export_data DatasetService.ExportData}.
197
210
  # @!attribute [rw] generic_metadata
198
211
  # @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
199
212
  # The common part of the operation metadata.
@@ -206,7 +219,8 @@ module Google
206
219
  extend ::Google::Protobuf::MessageExts::ClassMethods
207
220
  end
208
221
 
209
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_data_items DatasetService.ListDataItems}.
222
+ # Request message for
223
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_data_items DatasetService.ListDataItems}.
210
224
  # @!attribute [rw] parent
211
225
  # @return [::String]
212
226
  # Required. The resource name of the Dataset to list DataItems from.
@@ -233,7 +247,8 @@ module Google
233
247
  extend ::Google::Protobuf::MessageExts::ClassMethods
234
248
  end
235
249
 
236
- # Response message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_data_items DatasetService.ListDataItems}.
250
+ # Response message for
251
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_data_items DatasetService.ListDataItems}.
237
252
  # @!attribute [rw] data_items
238
253
  # @return [::Array<::Google::Cloud::AIPlatform::V1::DataItem>]
239
254
  # A list of DataItems that matches the specified filter in the request.
@@ -245,7 +260,8 @@ module Google
245
260
  extend ::Google::Protobuf::MessageExts::ClassMethods
246
261
  end
247
262
 
248
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#search_data_items DatasetService.SearchDataItems}.
263
+ # Request message for
264
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#search_data_items DatasetService.SearchDataItems}.
249
265
  # @!attribute [rw] order_by_data_item
250
266
  # @return [::String]
251
267
  # A comma-separated list of data item fields to order by, sorted in
@@ -299,7 +315,8 @@ module Google
299
315
  # belong to.
300
316
  # @!attribute [rw] field_mask
301
317
  # @return [::Google::Protobuf::FieldMask]
302
- # Mask specifying which fields of {::Google::Cloud::AIPlatform::V1::DataItemView DataItemView} to read.
318
+ # Mask specifying which fields of
319
+ # {::Google::Cloud::AIPlatform::V1::DataItemView DataItemView} to read.
303
320
  # @!attribute [rw] annotations_limit
304
321
  # @return [::Integer]
305
322
  # If set, only up to this many of Annotations will be returned per
@@ -317,8 +334,10 @@ module Google
317
334
  # @return [::String]
318
335
  # A token identifying a page of results for the server to return
319
336
  # Typically obtained via
320
- # {::Google::Cloud::AIPlatform::V1::SearchDataItemsResponse#next_page_token SearchDataItemsResponse.next_page_token} of the previous
321
- # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#search_data_items DatasetService.SearchDataItems} call.
337
+ # {::Google::Cloud::AIPlatform::V1::SearchDataItemsResponse#next_page_token SearchDataItemsResponse.next_page_token}
338
+ # of the previous
339
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#search_data_items DatasetService.SearchDataItems}
340
+ # call.
322
341
  class SearchDataItemsRequest
323
342
  include ::Google::Protobuf::MessageExts
324
343
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -326,8 +345,8 @@ module Google
326
345
  # Expression that allows ranking results based on annotation's property.
327
346
  # @!attribute [rw] saved_query
328
347
  # @return [::String]
329
- # Required. Saved query of the Annotation. Only Annotations belong to this saved
330
- # query will be considered for ordering.
348
+ # Required. Saved query of the Annotation. Only Annotations belong to this
349
+ # saved query will be considered for ordering.
331
350
  # @!attribute [rw] order_by
332
351
  # @return [::String]
333
352
  # A comma-separated list of annotation fields to order by, sorted in
@@ -339,14 +358,17 @@ module Google
339
358
  end
340
359
  end
341
360
 
342
- # Response message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#search_data_items DatasetService.SearchDataItems}.
361
+ # Response message for
362
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#search_data_items DatasetService.SearchDataItems}.
343
363
  # @!attribute [rw] data_item_views
344
364
  # @return [::Array<::Google::Cloud::AIPlatform::V1::DataItemView>]
345
365
  # The DataItemViews read.
346
366
  # @!attribute [rw] next_page_token
347
367
  # @return [::String]
348
368
  # A token to retrieve next page of results.
349
- # Pass to {::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest#page_token SearchDataItemsRequest.page_token} to obtain that page.
369
+ # Pass to
370
+ # {::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest#page_token SearchDataItemsRequest.page_token}
371
+ # to obtain that page.
350
372
  class SearchDataItemsResponse
351
373
  include ::Google::Protobuf::MessageExts
352
374
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -374,7 +396,8 @@ module Google
374
396
  extend ::Google::Protobuf::MessageExts::ClassMethods
375
397
  end
376
398
 
377
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_saved_queries DatasetService.ListSavedQueries}.
399
+ # Request message for
400
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_saved_queries DatasetService.ListSavedQueries}.
378
401
  # @!attribute [rw] parent
379
402
  # @return [::String]
380
403
  # Required. The resource name of the Dataset to list SavedQueries from.
@@ -401,7 +424,8 @@ module Google
401
424
  extend ::Google::Protobuf::MessageExts::ClassMethods
402
425
  end
403
426
 
404
- # Response message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_saved_queries DatasetService.ListSavedQueries}.
427
+ # Response message for
428
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_saved_queries DatasetService.ListSavedQueries}.
405
429
  # @!attribute [rw] saved_queries
406
430
  # @return [::Array<::Google::Cloud::AIPlatform::V1::SavedQuery>]
407
431
  # A list of SavedQueries that match the specified filter in the request.
@@ -413,7 +437,8 @@ module Google
413
437
  extend ::Google::Protobuf::MessageExts::ClassMethods
414
438
  end
415
439
 
416
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#get_annotation_spec DatasetService.GetAnnotationSpec}.
440
+ # Request message for
441
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#get_annotation_spec DatasetService.GetAnnotationSpec}.
417
442
  # @!attribute [rw] name
418
443
  # @return [::String]
419
444
  # Required. The name of the AnnotationSpec resource.
@@ -427,7 +452,8 @@ module Google
427
452
  extend ::Google::Protobuf::MessageExts::ClassMethods
428
453
  end
429
454
 
430
- # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_annotations DatasetService.ListAnnotations}.
455
+ # Request message for
456
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_annotations DatasetService.ListAnnotations}.
431
457
  # @!attribute [rw] parent
432
458
  # @return [::String]
433
459
  # Required. The resource name of the DataItem to list Annotations from.
@@ -454,7 +480,8 @@ module Google
454
480
  extend ::Google::Protobuf::MessageExts::ClassMethods
455
481
  end
456
482
 
457
- # Response message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_annotations DatasetService.ListAnnotations}.
483
+ # Response message for
484
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_annotations DatasetService.ListAnnotations}.
458
485
  # @!attribute [rw] annotations
459
486
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Annotation>]
460
487
  # A list of Annotations that matches the specified filter in the request.
@@ -25,8 +25,8 @@ module Google
25
25
  # a top-level resource.
26
26
  # @!attribute [rw] kms_key_name
27
27
  # @return [::String]
28
- # Required. The Cloud KMS resource identifier of the customer managed encryption key
29
- # used to protect a resource. Has the form:
28
+ # Required. The Cloud KMS resource identifier of the customer managed
29
+ # encryption key used to protect a resource. Has the form:
30
30
  # `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`.
31
31
  # The key needs to be in the same region as where the compute resource is
32
32
  # created.