google-cloud-managed_kafka-v1 0.a → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +144 -8
  5. data/lib/google/cloud/managed_kafka/v1/bindings_override.rb +102 -0
  6. data/lib/google/cloud/managed_kafka/v1/managed_kafka/client.rb +1876 -0
  7. data/lib/google/cloud/managed_kafka/v1/managed_kafka/credentials.rb +47 -0
  8. data/lib/google/cloud/managed_kafka/v1/managed_kafka/operations.rb +809 -0
  9. data/lib/google/cloud/managed_kafka/v1/managed_kafka/paths.rb +132 -0
  10. data/lib/google/cloud/managed_kafka/v1/managed_kafka/rest/client.rb +1759 -0
  11. data/lib/google/cloud/managed_kafka/v1/managed_kafka/rest/operations.rb +902 -0
  12. data/lib/google/cloud/managed_kafka/v1/managed_kafka/rest/service_stub.rb +900 -0
  13. data/lib/google/cloud/managed_kafka/v1/managed_kafka/rest.rb +55 -0
  14. data/lib/google/cloud/managed_kafka/v1/managed_kafka.rb +57 -0
  15. data/lib/google/cloud/managed_kafka/v1/rest.rb +38 -0
  16. data/lib/google/cloud/managed_kafka/v1/version.rb +7 -2
  17. data/lib/google/cloud/managed_kafka/v1.rb +45 -0
  18. data/lib/google/cloud/managedkafka/v1/managed_kafka_pb.rb +70 -0
  19. data/lib/google/cloud/managedkafka/v1/managed_kafka_services_pb.rb +72 -0
  20. data/lib/google/cloud/managedkafka/v1/resources_pb.rb +59 -0
  21. data/lib/google-cloud-managed_kafka-v1.rb +21 -0
  22. data/proto_docs/README.md +4 -0
  23. data/proto_docs/google/api/client.rb +403 -0
  24. data/proto_docs/google/api/field_behavior.rb +85 -0
  25. data/proto_docs/google/api/field_info.rb +88 -0
  26. data/proto_docs/google/api/launch_stage.rb +71 -0
  27. data/proto_docs/google/api/resource.rb +227 -0
  28. data/proto_docs/google/cloud/managedkafka/v1/managed_kafka.rb +341 -0
  29. data/proto_docs/google/cloud/managedkafka/v1/resources.rb +289 -0
  30. data/proto_docs/google/longrunning/operations.rb +164 -0
  31. data/proto_docs/google/protobuf/any.rb +145 -0
  32. data/proto_docs/google/protobuf/duration.rb +98 -0
  33. data/proto_docs/google/protobuf/empty.rb +34 -0
  34. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  35. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  36. data/proto_docs/google/rpc/status.rb +48 -0
  37. metadata +96 -10
@@ -0,0 +1,227 @@
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
+
20
+ module Google
21
+ module Api
22
+ # A simple descriptor of a resource type.
23
+ #
24
+ # ResourceDescriptor annotates a resource message (either by means of a
25
+ # protobuf annotation or use in the service config), and associates the
26
+ # resource's schema, the resource type, and the pattern of the resource name.
27
+ #
28
+ # Example:
29
+ #
30
+ # message Topic {
31
+ # // Indicates this message defines a resource schema.
32
+ # // Declares the resource type in the format of {service}/{kind}.
33
+ # // For Kubernetes resources, the format is {api group}/{kind}.
34
+ # option (google.api.resource) = {
35
+ # type: "pubsub.googleapis.com/Topic"
36
+ # pattern: "projects/{project}/topics/{topic}"
37
+ # };
38
+ # }
39
+ #
40
+ # The ResourceDescriptor Yaml config will look like:
41
+ #
42
+ # resources:
43
+ # - type: "pubsub.googleapis.com/Topic"
44
+ # pattern: "projects/{project}/topics/{topic}"
45
+ #
46
+ # Sometimes, resources have multiple patterns, typically because they can
47
+ # live under multiple parents.
48
+ #
49
+ # Example:
50
+ #
51
+ # message LogEntry {
52
+ # option (google.api.resource) = {
53
+ # type: "logging.googleapis.com/LogEntry"
54
+ # pattern: "projects/{project}/logs/{log}"
55
+ # pattern: "folders/{folder}/logs/{log}"
56
+ # pattern: "organizations/{organization}/logs/{log}"
57
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
58
+ # };
59
+ # }
60
+ #
61
+ # The ResourceDescriptor Yaml config will look like:
62
+ #
63
+ # resources:
64
+ # - type: 'logging.googleapis.com/LogEntry'
65
+ # pattern: "projects/{project}/logs/{log}"
66
+ # pattern: "folders/{folder}/logs/{log}"
67
+ # pattern: "organizations/{organization}/logs/{log}"
68
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
69
+ # @!attribute [rw] type
70
+ # @return [::String]
71
+ # The resource type. It must be in the format of
72
+ # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
73
+ # singular and must not include version numbers.
74
+ #
75
+ # Example: `storage.googleapis.com/Bucket`
76
+ #
77
+ # The value of the resource_type_kind must follow the regular expression
78
+ # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
79
+ # should use PascalCase (UpperCamelCase). The maximum number of
80
+ # characters allowed for the `resource_type_kind` is 100.
81
+ # @!attribute [rw] pattern
82
+ # @return [::Array<::String>]
83
+ # Optional. The relative resource name pattern associated with this resource
84
+ # type. The DNS prefix of the full resource name shouldn't be specified here.
85
+ #
86
+ # The path pattern must follow the syntax, which aligns with HTTP binding
87
+ # syntax:
88
+ #
89
+ # Template = Segment { "/" Segment } ;
90
+ # Segment = LITERAL | Variable ;
91
+ # Variable = "{" LITERAL "}" ;
92
+ #
93
+ # Examples:
94
+ #
95
+ # - "projects/\\{project}/topics/\\{topic}"
96
+ # - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
97
+ #
98
+ # The components in braces correspond to the IDs for each resource in the
99
+ # hierarchy. It is expected that, if multiple patterns are provided,
100
+ # the same component name (e.g. "project") refers to IDs of the same
101
+ # type of resource.
102
+ # @!attribute [rw] name_field
103
+ # @return [::String]
104
+ # Optional. The field on the resource that designates the resource name
105
+ # field. If omitted, this is assumed to be "name".
106
+ # @!attribute [rw] history
107
+ # @return [::Google::Api::ResourceDescriptor::History]
108
+ # Optional. The historical or future-looking state of the resource pattern.
109
+ #
110
+ # Example:
111
+ #
112
+ # // The InspectTemplate message originally only supported resource
113
+ # // names with organization, and project was added later.
114
+ # message InspectTemplate {
115
+ # option (google.api.resource) = {
116
+ # type: "dlp.googleapis.com/InspectTemplate"
117
+ # pattern:
118
+ # "organizations/{organization}/inspectTemplates/{inspect_template}"
119
+ # pattern: "projects/{project}/inspectTemplates/{inspect_template}"
120
+ # history: ORIGINALLY_SINGLE_PATTERN
121
+ # };
122
+ # }
123
+ # @!attribute [rw] plural
124
+ # @return [::String]
125
+ # The plural name used in the resource name and permission names, such as
126
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
127
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
128
+ # to this is for Nested Collections that have stuttering names, as defined
129
+ # in [AIP-122](https://google.aip.dev/122#nested-collections), where the
130
+ # collection ID in the resource name pattern does not necessarily directly
131
+ # match the `plural` value.
132
+ #
133
+ # It is the same concept of the `plural` field in k8s CRD spec
134
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
135
+ #
136
+ # Note: The plural form is required even for singleton resources. See
137
+ # https://aip.dev/156
138
+ # @!attribute [rw] singular
139
+ # @return [::String]
140
+ # The same concept of the `singular` field in k8s CRD spec
141
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
142
+ # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
143
+ # @!attribute [rw] style
144
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
145
+ # Style flag(s) for this resource.
146
+ # These indicate that a resource is expected to conform to a given
147
+ # style. See the specific style flags for additional information.
148
+ class ResourceDescriptor
149
+ include ::Google::Protobuf::MessageExts
150
+ extend ::Google::Protobuf::MessageExts::ClassMethods
151
+
152
+ # A description of the historical or future-looking state of the
153
+ # resource pattern.
154
+ module History
155
+ # The "unset" value.
156
+ HISTORY_UNSPECIFIED = 0
157
+
158
+ # The resource originally had one pattern and launched as such, and
159
+ # additional patterns were added later.
160
+ ORIGINALLY_SINGLE_PATTERN = 1
161
+
162
+ # The resource has one pattern, but the API owner expects to add more
163
+ # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
164
+ # that from being necessary once there are multiple patterns.)
165
+ FUTURE_MULTI_PATTERN = 2
166
+ end
167
+
168
+ # A flag representing a specific style that a resource claims to conform to.
169
+ module Style
170
+ # The unspecified value. Do not use.
171
+ STYLE_UNSPECIFIED = 0
172
+
173
+ # This resource is intended to be "declarative-friendly".
174
+ #
175
+ # Declarative-friendly resources must be more strictly consistent, and
176
+ # setting this to true communicates to tools that this resource should
177
+ # adhere to declarative-friendly expectations.
178
+ #
179
+ # Note: This is used by the API linter (linter.aip.dev) to enable
180
+ # additional checks.
181
+ DECLARATIVE_FRIENDLY = 1
182
+ end
183
+ end
184
+
185
+ # Defines a proto annotation that describes a string field that refers to
186
+ # an API resource.
187
+ # @!attribute [rw] type
188
+ # @return [::String]
189
+ # The resource type that the annotated field references.
190
+ #
191
+ # Example:
192
+ #
193
+ # message Subscription {
194
+ # string topic = 2 [(google.api.resource_reference) = {
195
+ # type: "pubsub.googleapis.com/Topic"
196
+ # }];
197
+ # }
198
+ #
199
+ # Occasionally, a field may reference an arbitrary resource. In this case,
200
+ # APIs use the special value * in their resource reference.
201
+ #
202
+ # Example:
203
+ #
204
+ # message GetIamPolicyRequest {
205
+ # string resource = 2 [(google.api.resource_reference) = {
206
+ # type: "*"
207
+ # }];
208
+ # }
209
+ # @!attribute [rw] child_type
210
+ # @return [::String]
211
+ # The resource type of a child collection that the annotated field
212
+ # references. This is useful for annotating the `parent` field that
213
+ # doesn't have a fixed resource type.
214
+ #
215
+ # Example:
216
+ #
217
+ # message ListLogEntriesRequest {
218
+ # string parent = 1 [(google.api.resource_reference) = {
219
+ # child_type: "logging.googleapis.com/LogEntry"
220
+ # };
221
+ # }
222
+ class ResourceReference
223
+ include ::Google::Protobuf::MessageExts
224
+ extend ::Google::Protobuf::MessageExts::ClassMethods
225
+ end
226
+ end
227
+ end
@@ -0,0 +1,341 @@
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
+
20
+ module Google
21
+ module Cloud
22
+ module ManagedKafka
23
+ module V1
24
+ # Request for ListClusters.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. The parent location whose clusters are to be listed. Structured
28
+ # like `projects/{project}/locations/{location}`.
29
+ # @!attribute [rw] page_size
30
+ # @return [::Integer]
31
+ # Optional. The maximum number of clusters to return. The service may return
32
+ # fewer than this value. If unspecified, server will pick an appropriate
33
+ # default.
34
+ # @!attribute [rw] page_token
35
+ # @return [::String]
36
+ # Optional. A page token, received from a previous `ListClusters` call.
37
+ # Provide this to retrieve the subsequent page.
38
+ #
39
+ # When paginating, all other parameters provided to `ListClusters` must match
40
+ # the call that provided the page token.
41
+ # @!attribute [rw] filter
42
+ # @return [::String]
43
+ # Optional. Filter expression for the result.
44
+ # @!attribute [rw] order_by
45
+ # @return [::String]
46
+ # Optional. Order by fields for the result.
47
+ class ListClustersRequest
48
+ include ::Google::Protobuf::MessageExts
49
+ extend ::Google::Protobuf::MessageExts::ClassMethods
50
+ end
51
+
52
+ # Response for ListClusters.
53
+ # @!attribute [rw] clusters
54
+ # @return [::Array<::Google::Cloud::ManagedKafka::V1::Cluster>]
55
+ # The list of Clusters in the requested parent.
56
+ # @!attribute [rw] next_page_token
57
+ # @return [::String]
58
+ # A token that can be sent as `page_token` to retrieve the next page of
59
+ # results. If this field is omitted, there are no more results.
60
+ # @!attribute [rw] unreachable
61
+ # @return [::Array<::String>]
62
+ # Locations that could not be reached.
63
+ class ListClustersResponse
64
+ include ::Google::Protobuf::MessageExts
65
+ extend ::Google::Protobuf::MessageExts::ClassMethods
66
+ end
67
+
68
+ # Request for GetCluster.
69
+ # @!attribute [rw] name
70
+ # @return [::String]
71
+ # Required. The name of the cluster whose configuration to return.
72
+ class GetClusterRequest
73
+ include ::Google::Protobuf::MessageExts
74
+ extend ::Google::Protobuf::MessageExts::ClassMethods
75
+ end
76
+
77
+ # Request for CreateCluster.
78
+ # @!attribute [rw] parent
79
+ # @return [::String]
80
+ # Required. The parent region in which to create the cluster. Structured like
81
+ # `projects/{project}/locations/{location}`.
82
+ # @!attribute [rw] cluster_id
83
+ # @return [::String]
84
+ # Required. The ID to use for the cluster, which will become the final
85
+ # component of the cluster's name. The ID must be 1-63 characters long, and
86
+ # match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with
87
+ # RFC 1035.
88
+ #
89
+ # This value is structured like: `my-cluster-id`.
90
+ # @!attribute [rw] cluster
91
+ # @return [::Google::Cloud::ManagedKafka::V1::Cluster]
92
+ # Required. Configuration of the cluster to create. Its `name` field is
93
+ # ignored.
94
+ # @!attribute [rw] request_id
95
+ # @return [::String]
96
+ # Optional. An optional request ID to identify requests. Specify a unique
97
+ # request ID to avoid duplication of requests. If a request times out or
98
+ # fails, retrying with the same ID allows the server to recognize the
99
+ # previous attempt. For at least 60 minutes, the server ignores duplicate
100
+ # requests bearing the same ID.
101
+ #
102
+ # For example, consider a situation where you make an initial request and the
103
+ # request times out. If you make the request again with the same request ID
104
+ # within 60 minutes of the last request, the server checks if an original
105
+ # operation with the same request ID was received. If so, the server ignores
106
+ # the second request.
107
+ #
108
+ # The request ID must be a valid UUID. A zero UUID is not supported
109
+ # (00000000-0000-0000-0000-000000000000).
110
+ class CreateClusterRequest
111
+ include ::Google::Protobuf::MessageExts
112
+ extend ::Google::Protobuf::MessageExts::ClassMethods
113
+ end
114
+
115
+ # Request for UpdateCluster.
116
+ # @!attribute [rw] update_mask
117
+ # @return [::Google::Protobuf::FieldMask]
118
+ # Required. Field mask is used to specify the fields to be overwritten in the
119
+ # cluster resource by the update. The fields specified in the update_mask are
120
+ # relative to the resource, not the full request. A field will be overwritten
121
+ # if it is in the mask. The mask is required and a value of * will update all
122
+ # fields.
123
+ # @!attribute [rw] cluster
124
+ # @return [::Google::Cloud::ManagedKafka::V1::Cluster]
125
+ # Required. The cluster to update. Its `name` field must be populated.
126
+ # @!attribute [rw] request_id
127
+ # @return [::String]
128
+ # Optional. An optional request ID to identify requests. Specify a unique
129
+ # request ID to avoid duplication of requests. If a request times out or
130
+ # fails, retrying with the same ID allows the server to recognize the
131
+ # previous attempt. For at least 60 minutes, the server ignores duplicate
132
+ # requests bearing the same ID.
133
+ #
134
+ # For example, consider a situation where you make an initial request and the
135
+ # request times out. If you make the request again with the same request ID
136
+ # within 60 minutes of the last request, the server checks if an original
137
+ # operation with the same request ID was received. If so, the server ignores
138
+ # the second request.
139
+ #
140
+ # The request ID must be a valid UUID. A zero UUID is not supported
141
+ # (00000000-0000-0000-0000-000000000000).
142
+ class UpdateClusterRequest
143
+ include ::Google::Protobuf::MessageExts
144
+ extend ::Google::Protobuf::MessageExts::ClassMethods
145
+ end
146
+
147
+ # Request for DeleteCluster.
148
+ # @!attribute [rw] name
149
+ # @return [::String]
150
+ # Required. The name of the cluster to delete.
151
+ # @!attribute [rw] request_id
152
+ # @return [::String]
153
+ # Optional. An optional request ID to identify requests. Specify a unique
154
+ # request ID to avoid duplication of requests. If a request times out or
155
+ # fails, retrying with the same ID allows the server to recognize the
156
+ # previous attempt. For at least 60 minutes, the server ignores duplicate
157
+ # requests bearing the same ID.
158
+ #
159
+ # For example, consider a situation where you make an initial request and the
160
+ # request times out. If you make the request again with the same request ID
161
+ # within 60 minutes of the last request, the server checks if an original
162
+ # operation with the same request ID was received. If so, the server ignores
163
+ # the second request.
164
+ #
165
+ # The request ID must be a valid UUID. A zero UUID is not supported
166
+ # (00000000-0000-0000-0000-000000000000).
167
+ class DeleteClusterRequest
168
+ include ::Google::Protobuf::MessageExts
169
+ extend ::Google::Protobuf::MessageExts::ClassMethods
170
+ end
171
+
172
+ # Request for ListTopics.
173
+ # @!attribute [rw] parent
174
+ # @return [::String]
175
+ # Required. The parent cluster whose topics are to be listed. Structured like
176
+ # `projects/{project}/locations/{location}/clusters/{cluster}`.
177
+ # @!attribute [rw] page_size
178
+ # @return [::Integer]
179
+ # Optional. The maximum number of topics to return. The service may return
180
+ # fewer than this value. If unset or zero, all topics for the parent is
181
+ # returned.
182
+ # @!attribute [rw] page_token
183
+ # @return [::String]
184
+ # Optional. A page token, received from a previous `ListTopics` call.
185
+ # Provide this to retrieve the subsequent page.
186
+ #
187
+ # When paginating, all other parameters provided to `ListTopics` must match
188
+ # the call that provided the page token.
189
+ class ListTopicsRequest
190
+ include ::Google::Protobuf::MessageExts
191
+ extend ::Google::Protobuf::MessageExts::ClassMethods
192
+ end
193
+
194
+ # Response for ListTopics.
195
+ # @!attribute [rw] topics
196
+ # @return [::Array<::Google::Cloud::ManagedKafka::V1::Topic>]
197
+ # The list of topics in the requested parent. The order of the topics is
198
+ # unspecified.
199
+ # @!attribute [rw] next_page_token
200
+ # @return [::String]
201
+ # A token that can be sent as `page_token` to retrieve the next page of
202
+ # results. If this field is omitted, there are no more results.
203
+ class ListTopicsResponse
204
+ include ::Google::Protobuf::MessageExts
205
+ extend ::Google::Protobuf::MessageExts::ClassMethods
206
+ end
207
+
208
+ # Request for GetTopic.
209
+ # @!attribute [rw] name
210
+ # @return [::String]
211
+ # Required. The name of the topic whose configuration to return. Structured
212
+ # like:
213
+ # projects/\\{project}/locations/\\{location}/clusters/\\{cluster}/topics/\\{topic}.
214
+ class GetTopicRequest
215
+ include ::Google::Protobuf::MessageExts
216
+ extend ::Google::Protobuf::MessageExts::ClassMethods
217
+ end
218
+
219
+ # Request for CreateTopic.
220
+ # @!attribute [rw] parent
221
+ # @return [::String]
222
+ # Required. The parent cluster in which to create the topic.
223
+ # Structured like
224
+ # `projects/{project}/locations/{location}/clusters/{cluster}`.
225
+ # @!attribute [rw] topic_id
226
+ # @return [::String]
227
+ # Required. The ID to use for the topic, which will become the final
228
+ # component of the topic's name.
229
+ #
230
+ # This value is structured like: `my-topic-name`.
231
+ # @!attribute [rw] topic
232
+ # @return [::Google::Cloud::ManagedKafka::V1::Topic]
233
+ # Required. Configuration of the topic to create. Its `name` field is
234
+ # ignored.
235
+ class CreateTopicRequest
236
+ include ::Google::Protobuf::MessageExts
237
+ extend ::Google::Protobuf::MessageExts::ClassMethods
238
+ end
239
+
240
+ # Request for UpdateTopic.
241
+ # @!attribute [rw] update_mask
242
+ # @return [::Google::Protobuf::FieldMask]
243
+ # Required. Field mask is used to specify the fields to be overwritten in the
244
+ # Topic resource by the update. The fields specified in the update_mask are
245
+ # relative to the resource, not the full request. A field will be overwritten
246
+ # if it is in the mask. The mask is required and a value of * will update all
247
+ # fields.
248
+ # @!attribute [rw] topic
249
+ # @return [::Google::Cloud::ManagedKafka::V1::Topic]
250
+ # Required. The topic to update. Its `name` field must be populated.
251
+ class UpdateTopicRequest
252
+ include ::Google::Protobuf::MessageExts
253
+ extend ::Google::Protobuf::MessageExts::ClassMethods
254
+ end
255
+
256
+ # Request for DeleteTopic.
257
+ # @!attribute [rw] name
258
+ # @return [::String]
259
+ # Required. The name of the topic to delete.
260
+ # `projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}`.
261
+ class DeleteTopicRequest
262
+ include ::Google::Protobuf::MessageExts
263
+ extend ::Google::Protobuf::MessageExts::ClassMethods
264
+ end
265
+
266
+ # Request for ListConsumerGroups.
267
+ # @!attribute [rw] parent
268
+ # @return [::String]
269
+ # Required. The parent cluster whose consumer groups are to be listed.
270
+ # Structured like
271
+ # `projects/{project}/locations/{location}/clusters/{cluster}`.
272
+ # @!attribute [rw] page_size
273
+ # @return [::Integer]
274
+ # Optional. The maximum number of consumer groups to return. The service may
275
+ # return fewer than this value. If unset or zero, all consumer groups for the
276
+ # parent is returned.
277
+ # @!attribute [rw] page_token
278
+ # @return [::String]
279
+ # Optional. A page token, received from a previous `ListConsumerGroups` call.
280
+ # Provide this to retrieve the subsequent page.
281
+ #
282
+ # When paginating, all other parameters provided to `ListConsumerGroups` must
283
+ # match the call that provided the page token.
284
+ class ListConsumerGroupsRequest
285
+ include ::Google::Protobuf::MessageExts
286
+ extend ::Google::Protobuf::MessageExts::ClassMethods
287
+ end
288
+
289
+ # Response for ListConsumerGroups.
290
+ # @!attribute [rw] consumer_groups
291
+ # @return [::Array<::Google::Cloud::ManagedKafka::V1::ConsumerGroup>]
292
+ # The list of consumer group in the requested parent. The order of the
293
+ # consumer groups is unspecified.
294
+ # @!attribute [rw] next_page_token
295
+ # @return [::String]
296
+ # A token that can be sent as `page_token` to retrieve the next page of
297
+ # results. If this field is omitted, there are no more results.
298
+ class ListConsumerGroupsResponse
299
+ include ::Google::Protobuf::MessageExts
300
+ extend ::Google::Protobuf::MessageExts::ClassMethods
301
+ end
302
+
303
+ # Request for GetConsumerGroup.
304
+ # @!attribute [rw] name
305
+ # @return [::String]
306
+ # Required. The name of the consumer group whose configuration to return.
307
+ # `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`.
308
+ class GetConsumerGroupRequest
309
+ include ::Google::Protobuf::MessageExts
310
+ extend ::Google::Protobuf::MessageExts::ClassMethods
311
+ end
312
+
313
+ # Request for UpdateConsumerGroup.
314
+ # @!attribute [rw] update_mask
315
+ # @return [::Google::Protobuf::FieldMask]
316
+ # Required. Field mask is used to specify the fields to be overwritten in the
317
+ # ConsumerGroup resource by the update.
318
+ # The fields specified in the update_mask are relative to the resource, not
319
+ # the full request. A field will be overwritten if it is in the mask. The
320
+ # mask is required and a value of * will update all fields.
321
+ # @!attribute [rw] consumer_group
322
+ # @return [::Google::Cloud::ManagedKafka::V1::ConsumerGroup]
323
+ # Required. The consumer group to update. Its `name` field must be populated.
324
+ class UpdateConsumerGroupRequest
325
+ include ::Google::Protobuf::MessageExts
326
+ extend ::Google::Protobuf::MessageExts::ClassMethods
327
+ end
328
+
329
+ # Request for DeleteConsumerGroup.
330
+ # @!attribute [rw] name
331
+ # @return [::String]
332
+ # Required. The name of the consumer group to delete.
333
+ # `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`.
334
+ class DeleteConsumerGroupRequest
335
+ include ::Google::Protobuf::MessageExts
336
+ extend ::Google::Protobuf::MessageExts::ClassMethods
337
+ end
338
+ end
339
+ end
340
+ end
341
+ end