google-cloud-managed_kafka-v1 1.1.2 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -335,6 +335,193 @@ module Google
335
335
  include ::Google::Protobuf::MessageExts
336
336
  extend ::Google::Protobuf::MessageExts::ClassMethods
337
337
  end
338
+
339
+ # Request for ListAcls.
340
+ # @!attribute [rw] parent
341
+ # @return [::String]
342
+ # Required. The parent cluster whose acls are to be listed.
343
+ # Structured like
344
+ # `projects/{project}/locations/{location}/clusters/{cluster}`.
345
+ # @!attribute [rw] page_size
346
+ # @return [::Integer]
347
+ # Optional. The maximum number of acls to return. The service may return
348
+ # fewer than this value. If unset or zero, all acls for the parent is
349
+ # returned.
350
+ # @!attribute [rw] page_token
351
+ # @return [::String]
352
+ # Optional. A page token, received from a previous `ListAcls` call.
353
+ # Provide this to retrieve the subsequent page.
354
+ #
355
+ # When paginating, all other parameters provided to `ListAcls` must match
356
+ # the call that provided the page token.
357
+ class ListAclsRequest
358
+ include ::Google::Protobuf::MessageExts
359
+ extend ::Google::Protobuf::MessageExts::ClassMethods
360
+ end
361
+
362
+ # Response for ListAcls.
363
+ # @!attribute [rw] acls
364
+ # @return [::Array<::Google::Cloud::ManagedKafka::V1::Acl>]
365
+ # The list of acls in the requested parent. The order of the acls is
366
+ # unspecified.
367
+ # @!attribute [rw] next_page_token
368
+ # @return [::String]
369
+ # A token that can be sent as `page_token` to retrieve the next page of
370
+ # results. If this field is omitted, there are no more results.
371
+ class ListAclsResponse
372
+ include ::Google::Protobuf::MessageExts
373
+ extend ::Google::Protobuf::MessageExts::ClassMethods
374
+ end
375
+
376
+ # Request for GetAcl.
377
+ # @!attribute [rw] name
378
+ # @return [::String]
379
+ # Required. The name of the acl to return.
380
+ # Structured like:
381
+ # `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`.
382
+ #
383
+ # The structure of `acl_id` defines the Resource Pattern (resource_type,
384
+ # resource_name, pattern_type) of the acl. See `Acl.name` for
385
+ # details.
386
+ class GetAclRequest
387
+ include ::Google::Protobuf::MessageExts
388
+ extend ::Google::Protobuf::MessageExts::ClassMethods
389
+ end
390
+
391
+ # Request for CreateAcl.
392
+ # @!attribute [rw] parent
393
+ # @return [::String]
394
+ # Required. The parent cluster in which to create the acl.
395
+ # Structured like
396
+ # `projects/{project}/locations/{location}/clusters/{cluster}`.
397
+ # @!attribute [rw] acl_id
398
+ # @return [::String]
399
+ # Required. The ID to use for the acl, which will become the final component
400
+ # of the acl's name. The structure of `acl_id` defines the Resource Pattern
401
+ # (resource_type, resource_name, pattern_type) of the acl. `acl_id` is
402
+ # structured like one of the following:
403
+ #
404
+ # For acls on the cluster:
405
+ # `cluster`
406
+ #
407
+ # For acls on a single resource within the cluster:
408
+ # `topic/{resource_name}`
409
+ # `consumerGroup/{resource_name}`
410
+ # `transactionalId/{resource_name}`
411
+ #
412
+ # For acls on all resources that match a prefix:
413
+ # `topicPrefixed/{resource_name}`
414
+ # `consumerGroupPrefixed/{resource_name}`
415
+ # `transactionalIdPrefixed/{resource_name}`
416
+ #
417
+ # For acls on all resources of a given type (i.e. the wildcard literal "*"):
418
+ # `allTopics` (represents `topic/*`)
419
+ # `allConsumerGroups` (represents `consumerGroup/*`)
420
+ # `allTransactionalIds` (represents `transactionalId/*`)
421
+ # @!attribute [rw] acl
422
+ # @return [::Google::Cloud::ManagedKafka::V1::Acl]
423
+ # Required. Configuration of the acl to create. Its `name` field is ignored.
424
+ class CreateAclRequest
425
+ include ::Google::Protobuf::MessageExts
426
+ extend ::Google::Protobuf::MessageExts::ClassMethods
427
+ end
428
+
429
+ # Request for UpdateAcl.
430
+ # @!attribute [rw] acl
431
+ # @return [::Google::Cloud::ManagedKafka::V1::Acl]
432
+ # Required. The updated acl. Its `name` and `etag` fields must be populated.
433
+ # `acl_entries` must not be empty in the updated acl; to remove all acl
434
+ # entries for an acl, use DeleteAcl.
435
+ # @!attribute [rw] update_mask
436
+ # @return [::Google::Protobuf::FieldMask]
437
+ # Optional. Field mask is used to specify the fields to be overwritten in the
438
+ # Acl resource by the update. The fields specified in the update_mask are
439
+ # relative to the resource, not the full request. A field will be overwritten
440
+ # if it is in the mask.
441
+ class UpdateAclRequest
442
+ include ::Google::Protobuf::MessageExts
443
+ extend ::Google::Protobuf::MessageExts::ClassMethods
444
+ end
445
+
446
+ # Request for DeleteAcl.
447
+ # @!attribute [rw] name
448
+ # @return [::String]
449
+ # Required. The name of the acl to delete.
450
+ # Structured like:
451
+ # `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`.
452
+ #
453
+ # The structure of `acl_id` defines the Resource Pattern (resource_type,
454
+ # resource_name, pattern_type) of the acl. See `Acl.name` for details.
455
+ class DeleteAclRequest
456
+ include ::Google::Protobuf::MessageExts
457
+ extend ::Google::Protobuf::MessageExts::ClassMethods
458
+ end
459
+
460
+ # Request for AddAclEntry.
461
+ # @!attribute [rw] acl
462
+ # @return [::String]
463
+ # Required. The name of the acl to add the acl entry to.
464
+ # Structured like:
465
+ # `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`.
466
+ #
467
+ # The structure of `acl_id` defines the Resource Pattern (resource_type,
468
+ # resource_name, pattern_type) of the acl. See `Acl.name` for
469
+ # details.
470
+ # @!attribute [rw] acl_entry
471
+ # @return [::Google::Cloud::ManagedKafka::V1::AclEntry]
472
+ # Required. The acl entry to add.
473
+ class AddAclEntryRequest
474
+ include ::Google::Protobuf::MessageExts
475
+ extend ::Google::Protobuf::MessageExts::ClassMethods
476
+ end
477
+
478
+ # Response for AddAclEntry.
479
+ # @!attribute [rw] acl
480
+ # @return [::Google::Cloud::ManagedKafka::V1::Acl]
481
+ # The updated acl.
482
+ # @!attribute [rw] acl_created
483
+ # @return [::Boolean]
484
+ # Whether the acl was created as a result of adding the acl entry.
485
+ class AddAclEntryResponse
486
+ include ::Google::Protobuf::MessageExts
487
+ extend ::Google::Protobuf::MessageExts::ClassMethods
488
+ end
489
+
490
+ # Request for RemoveAclEntry.
491
+ # @!attribute [rw] acl
492
+ # @return [::String]
493
+ # Required. The name of the acl to remove the acl entry from.
494
+ # Structured like:
495
+ # `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`.
496
+ #
497
+ # The structure of `acl_id` defines the Resource Pattern (resource_type,
498
+ # resource_name, pattern_type) of the acl. See `Acl.name` for
499
+ # details.
500
+ # @!attribute [rw] acl_entry
501
+ # @return [::Google::Cloud::ManagedKafka::V1::AclEntry]
502
+ # Required. The acl entry to remove.
503
+ class RemoveAclEntryRequest
504
+ include ::Google::Protobuf::MessageExts
505
+ extend ::Google::Protobuf::MessageExts::ClassMethods
506
+ end
507
+
508
+ # Response for RemoveAclEntry.
509
+ # @!attribute [rw] acl
510
+ # @return [::Google::Cloud::ManagedKafka::V1::Acl]
511
+ # The updated acl. Returned if the removed acl entry was not the last entry
512
+ # in the acl.
513
+ #
514
+ # Note: The following fields are mutually exclusive: `acl`, `acl_deleted`. If a field in that set is populated, all other fields in the set will automatically be cleared.
515
+ # @!attribute [rw] acl_deleted
516
+ # @return [::Boolean]
517
+ # Returned with value true if the removed acl entry was the last entry in
518
+ # the acl, resulting in acl deletion.
519
+ #
520
+ # Note: The following fields are mutually exclusive: `acl_deleted`, `acl`. If a field in that set is populated, all other fields in the set will automatically be cleared.
521
+ class RemoveAclEntryResponse
522
+ include ::Google::Protobuf::MessageExts
523
+ extend ::Google::Protobuf::MessageExts::ClassMethods
524
+ end
338
525
  end
339
526
  end
340
527
  end
@@ -496,6 +496,95 @@ module Google
496
496
  include ::Google::Protobuf::MessageExts
497
497
  extend ::Google::Protobuf::MessageExts::ClassMethods
498
498
  end
499
+
500
+ # Represents the set of ACLs for a given Kafka Resource Pattern, which consists
501
+ # of resource_type, resource_name and pattern_type.
502
+ # @!attribute [rw] name
503
+ # @return [::String]
504
+ # Identifier. The name for the acl. Represents a single Resource Pattern.
505
+ # Structured like:
506
+ # projects/\\{project}/locations/\\{location}/clusters/\\{cluster}/acls/\\{acl_id}
507
+ #
508
+ # The structure of `acl_id` defines the Resource Pattern (resource_type,
509
+ # resource_name, pattern_type) of the acl. `acl_id` is structured like one of
510
+ # the following:
511
+ #
512
+ # For acls on the cluster:
513
+ # `cluster`
514
+ #
515
+ # For acls on a single resource within the cluster:
516
+ # `topic/{resource_name}`
517
+ # `consumerGroup/{resource_name}`
518
+ # `transactionalId/{resource_name}`
519
+ #
520
+ # For acls on all resources that match a prefix:
521
+ # `topicPrefixed/{resource_name}`
522
+ # `consumerGroupPrefixed/{resource_name}`
523
+ # `transactionalIdPrefixed/{resource_name}`
524
+ #
525
+ # For acls on all resources of a given type (i.e. the wildcard literal "*"):
526
+ # `allTopics` (represents `topic/*`)
527
+ # `allConsumerGroups` (represents `consumerGroup/*`)
528
+ # `allTransactionalIds` (represents `transactionalId/*`)
529
+ # @!attribute [rw] acl_entries
530
+ # @return [::Array<::Google::Cloud::ManagedKafka::V1::AclEntry>]
531
+ # Required. The ACL entries that apply to the resource pattern. The maximum
532
+ # number of allowed entries 100.
533
+ # @!attribute [rw] etag
534
+ # @return [::String]
535
+ # Optional. `etag` is used for concurrency control. An `etag` is returned in
536
+ # the response to `GetAcl` and `CreateAcl`. Callers are required to put that
537
+ # etag in the request to `UpdateAcl` to ensure that their change will be
538
+ # applied to the same version of the acl that exists in the Kafka Cluster.
539
+ #
540
+ # A terminal 'T' character in the etag indicates that the AclEntries were
541
+ # truncated; more entries for the Acl exist on the Kafka Cluster, but can't
542
+ # be returned in the Acl due to repeated field limits.
543
+ # @!attribute [r] resource_type
544
+ # @return [::String]
545
+ # Output only. The ACL resource type derived from the name. One of: CLUSTER,
546
+ # TOPIC, GROUP, TRANSACTIONAL_ID.
547
+ # @!attribute [r] resource_name
548
+ # @return [::String]
549
+ # Output only. The ACL resource name derived from the name. For cluster
550
+ # resource_type, this is always "kafka-cluster". Can be the wildcard literal
551
+ # "*".
552
+ # @!attribute [r] pattern_type
553
+ # @return [::String]
554
+ # Output only. The ACL pattern type derived from the name. One of: LITERAL,
555
+ # PREFIXED.
556
+ class Acl
557
+ include ::Google::Protobuf::MessageExts
558
+ extend ::Google::Protobuf::MessageExts::ClassMethods
559
+ end
560
+
561
+ # Represents the access granted for a given Resource Pattern in an ACL.
562
+ # @!attribute [rw] principal
563
+ # @return [::String]
564
+ # Required. The principal. Specified as Google Cloud account, with the Kafka
565
+ # StandardAuthorizer prefix "User:". For example:
566
+ # "User:test-kafka-client@test-project.iam.gserviceaccount.com".
567
+ # Can be the wildcard "User:*" to refer to all users.
568
+ # @!attribute [rw] permission_type
569
+ # @return [::String]
570
+ # Required. The permission type. Accepted values are (case insensitive):
571
+ # ALLOW, DENY.
572
+ # @!attribute [rw] operation
573
+ # @return [::String]
574
+ # Required. The operation type. Allowed values are (case insensitive): ALL,
575
+ # READ, WRITE, CREATE, DELETE, ALTER, DESCRIBE, CLUSTER_ACTION,
576
+ # DESCRIBE_CONFIGS, ALTER_CONFIGS, and IDEMPOTENT_WRITE. See
577
+ # https://kafka.apache.org/documentation/#operations_resources_and_protocols
578
+ # for valid combinations of resource_type and operation for different Kafka
579
+ # API requests.
580
+ # @!attribute [rw] host
581
+ # @return [::String]
582
+ # Required. The host. Must be set to "*" for Managed Service for Apache
583
+ # Kafka.
584
+ class AclEntry
585
+ include ::Google::Protobuf::MessageExts
586
+ extend ::Google::Protobuf::MessageExts::ClassMethods
587
+ end
499
588
  end
500
589
  end
501
590
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-managed_kafka-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.2
4
+ version: 1.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -13,22 +13,16 @@ dependencies:
13
13
  name: gapic-common
14
14
  requirement: !ruby/object:Gem::Requirement
15
15
  requirements:
16
- - - ">="
17
- - !ruby/object:Gem::Version
18
- version: 0.25.0
19
- - - "<"
16
+ - - "~>"
20
17
  - !ruby/object:Gem::Version
21
- version: 2.a
18
+ version: '1.0'
22
19
  type: :runtime
23
20
  prerelease: false
24
21
  version_requirements: !ruby/object:Gem::Requirement
25
22
  requirements:
26
- - - ">="
27
- - !ruby/object:Gem::Version
28
- version: 0.25.0
29
- - - "<"
23
+ - - "~>"
30
24
  - !ruby/object:Gem::Version
31
- version: 2.a
25
+ version: '1.0'
32
26
  - !ruby/object:Gem::Dependency
33
27
  name: google-cloud-errors
34
28
  requirement: !ruby/object:Gem::Requirement
@@ -47,22 +41,16 @@ dependencies:
47
41
  name: google-cloud-location
48
42
  requirement: !ruby/object:Gem::Requirement
49
43
  requirements:
50
- - - ">="
51
- - !ruby/object:Gem::Version
52
- version: '0.7'
53
- - - "<"
44
+ - - "~>"
54
45
  - !ruby/object:Gem::Version
55
- version: 2.a
46
+ version: '1.0'
56
47
  type: :runtime
57
48
  prerelease: false
58
49
  version_requirements: !ruby/object:Gem::Requirement
59
50
  requirements:
60
- - - ">="
61
- - !ruby/object:Gem::Version
62
- version: '0.7'
63
- - - "<"
51
+ - - "~>"
64
52
  - !ruby/object:Gem::Version
65
- version: 2.a
53
+ version: '1.0'
66
54
  description: Manage Apache Kafka clusters and resources. Note that google-cloud-managed_kafka-v1
67
55
  is a version-specific client library. For most uses, we recommend installing the
68
56
  main client library google-cloud-managed_kafka instead. See the readme for more
@@ -131,14 +119,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
131
119
  requirements:
132
120
  - - ">="
133
121
  - !ruby/object:Gem::Version
134
- version: '3.0'
122
+ version: '3.1'
135
123
  required_rubygems_version: !ruby/object:Gem::Requirement
136
124
  requirements:
137
125
  - - ">="
138
126
  - !ruby/object:Gem::Version
139
127
  version: '0'
140
128
  requirements: []
141
- rubygems_version: 3.6.8
129
+ rubygems_version: 3.6.9
142
130
  specification_version: 4
143
131
  summary: Manage Apache Kafka clusters and resources.
144
132
  test_files: []