(::String) — Optional. etag is used for concurrency control. An etag is returned in
the response to GetAcl and CreateAcl. Callers are required to put that
etag in the request to UpdateAcl to ensure that their change will be
applied to the same version of the acl that exists in the Kafka Cluster.
A terminal 'T' character in the etag indicates that the AclEntries were
truncated; more entries for the Acl exist on the Kafka Cluster, but can't
be returned in the Acl due to repeated field limits.
#etag=
defetag=(value)->::String
Parameter
value (::String) — Optional. etag is used for concurrency control. An etag is returned in
the response to GetAcl and CreateAcl. Callers are required to put that
etag in the request to UpdateAcl to ensure that their change will be
applied to the same version of the acl that exists in the Kafka Cluster.
A terminal 'T' character in the etag indicates that the AclEntries were
truncated; more entries for the Acl exist on the Kafka Cluster, but can't
be returned in the Acl due to repeated field limits.
Returns
(::String) — Optional. etag is used for concurrency control. An etag is returned in
the response to GetAcl and CreateAcl. Callers are required to put that
etag in the request to UpdateAcl to ensure that their change will be
applied to the same version of the acl that exists in the Kafka Cluster.
A terminal 'T' character in the etag indicates that the AclEntries were
truncated; more entries for the Acl exist on the Kafka Cluster, but can't
be returned in the Acl due to repeated field limits.
#name
defname()->::String
Returns
(::String) — Identifier. The name for the acl. Represents a single Resource Pattern.
Structured like:
projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}
The structure of acl_id defines the Resource Pattern (resource_type,
resource_name, pattern_type) of the acl. acl_id is structured like one of
the following:
For acls on the cluster:
cluster
For acls on a single resource within the cluster:
topic/{resource_name}consumerGroup/{resource_name}transactionalId/{resource_name}
For acls on all resources that match a prefix:
topicPrefixed/{resource_name}consumerGroupPrefixed/{resource_name}transactionalIdPrefixed/{resource_name}
For acls on all resources of a given type (i.e. the wildcard literal ""):
allTopics (represents `topic/)
allConsumerGroups(representsconsumerGroup/)
allTransactionalIds(representstransactionalId/`)
#name=
defname=(value)->::String
Parameter
value (::String) — Identifier. The name for the acl. Represents a single Resource Pattern.
Structured like:
projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}
The structure of acl_id defines the Resource Pattern (resource_type,
resource_name, pattern_type) of the acl. acl_id is structured like one of
the following:
For acls on the cluster:
cluster
For acls on a single resource within the cluster:
topic/{resource_name}consumerGroup/{resource_name}transactionalId/{resource_name}
For acls on all resources that match a prefix:
topicPrefixed/{resource_name}consumerGroupPrefixed/{resource_name}transactionalIdPrefixed/{resource_name}
For acls on all resources of a given type (i.e. the wildcard literal ""):
allTopics (represents `topic/)
allConsumerGroups(representsconsumerGroup/)
allTransactionalIds(representstransactionalId/`)
Returns
(::String) — Identifier. The name for the acl. Represents a single Resource Pattern.
Structured like:
projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}
The structure of acl_id defines the Resource Pattern (resource_type,
resource_name, pattern_type) of the acl. acl_id is structured like one of
the following:
For acls on the cluster:
cluster
For acls on a single resource within the cluster:
topic/{resource_name}consumerGroup/{resource_name}transactionalId/{resource_name}
For acls on all resources that match a prefix:
topicPrefixed/{resource_name}consumerGroupPrefixed/{resource_name}transactionalIdPrefixed/{resource_name}
For acls on all resources of a given type (i.e. the wildcard literal ""):
allTopics (represents `topic/)
allConsumerGroups(representsconsumerGroup/)
allTransactionalIds(representstransactionalId/`)
#pattern_type
defpattern_type()->::String
Returns
(::String) — Output only. The ACL pattern type derived from the name. One of: LITERAL,
PREFIXED.
#resource_name
defresource_name()->::String
Returns
(::String) — Output only. The ACL resource name derived from the name. For cluster
resource_type, this is always "kafka-cluster". Can be the wildcard literal
"*".
#resource_type
defresource_type()->::String
Returns
(::String) — Output only. The ACL resource type derived from the name. One of: CLUSTER,
TOPIC, GROUP, TRANSACTIONAL_ID.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Managed Service for Apache Kafka V1 API - Class Google::Cloud::ManagedKafka::V1::Acl (v1.4.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.0 (latest)](/ruby/docs/reference/google-cloud-managed_kafka-v1/latest/Google-Cloud-ManagedKafka-V1-Acl)\n- [1.3.0](/ruby/docs/reference/google-cloud-managed_kafka-v1/1.3.0/Google-Cloud-ManagedKafka-V1-Acl)\n- [1.2.0](/ruby/docs/reference/google-cloud-managed_kafka-v1/1.2.0/Google-Cloud-ManagedKafka-V1-Acl)\n- [1.1.2](/ruby/docs/reference/google-cloud-managed_kafka-v1/1.1.2/Google-Cloud-ManagedKafka-V1-Acl)\n- [1.0.1](/ruby/docs/reference/google-cloud-managed_kafka-v1/1.0.1/Google-Cloud-ManagedKafka-V1-Acl)\n- [0.5.0](/ruby/docs/reference/google-cloud-managed_kafka-v1/0.5.0/Google-Cloud-ManagedKafka-V1-Acl)\n- [0.4.0](/ruby/docs/reference/google-cloud-managed_kafka-v1/0.4.0/Google-Cloud-ManagedKafka-V1-Acl)\n- [0.3.0](/ruby/docs/reference/google-cloud-managed_kafka-v1/0.3.0/Google-Cloud-ManagedKafka-V1-Acl)\n- [0.2.0](/ruby/docs/reference/google-cloud-managed_kafka-v1/0.2.0/Google-Cloud-ManagedKafka-V1-Acl)\n- [0.1.3](/ruby/docs/reference/google-cloud-managed_kafka-v1/0.1.3/Google-Cloud-ManagedKafka-V1-Acl) \nReference documentation and code samples for the Managed Service for Apache Kafka V1 API class Google::Cloud::ManagedKafka::V1::Acl.\n\nRepresents the set of ACLs for a given Kafka Resource Pattern, which consists\nof resource_type, resource_name and pattern_type. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #acl_entries\n\n def acl_entries() -\u003e ::Array\u003c::Google::Cloud::ManagedKafka::V1::AclEntry\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::ManagedKafka::V1::AclEntry](./Google-Cloud-ManagedKafka-V1-AclEntry)\\\u003e) --- Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.\n\n### #acl_entries=\n\n def acl_entries=(value) -\u003e ::Array\u003c::Google::Cloud::ManagedKafka::V1::AclEntry\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::ManagedKafka::V1::AclEntry](./Google-Cloud-ManagedKafka-V1-AclEntry)\\\u003e) --- Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::ManagedKafka::V1::AclEntry](./Google-Cloud-ManagedKafka-V1-AclEntry)\\\u003e) --- Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.\n\n### #etag\n\n def etag() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. `etag` is used for concurrency control. An `etag` is returned in the response to `GetAcl` and `CreateAcl`. Callers are required to put that etag in the request to `UpdateAcl` to ensure that their change will be applied to the same version of the acl that exists in the Kafka Cluster.\n\n\n A terminal 'T' character in the etag indicates that the AclEntries were\n truncated; more entries for the Acl exist on the Kafka Cluster, but can't\n be returned in the Acl due to repeated field limits.\n\n### #etag=\n\n def etag=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. `etag` is used for concurrency control. An `etag` is returned in the response to `GetAcl` and `CreateAcl`. Callers are required to put that etag in the request to `UpdateAcl` to ensure that their change will be applied to the same version of the acl that exists in the Kafka Cluster.\n\n\n A terminal 'T' character in the etag indicates that the AclEntries were\n truncated; more entries for the Acl exist on the Kafka Cluster, but can't\nbe returned in the Acl due to repeated field limits. \n**Returns**\n\n- (::String) --- Optional. `etag` is used for concurrency control. An `etag` is returned in the response to `GetAcl` and `CreateAcl`. Callers are required to put that etag in the request to `UpdateAcl` to ensure that their change will be applied to the same version of the acl that exists in the Kafka Cluster.\n\n\n A terminal 'T' character in the etag indicates that the AclEntries were\n truncated; more entries for the Acl exist on the Kafka Cluster, but can't\n be returned in the Acl due to repeated field limits.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Identifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}\n\n The structure of `acl_id` defines the Resource Pattern (resource_type,\n resource_name, pattern_type) of the acl. `acl_id` is structured like one of\n the following:\n\n For acls on the cluster:\n `cluster`\n\n For acls on a single resource within the cluster:\n `topic/{resource_name}`\n `consumerGroup/{resource_name}`\n `transactionalId/{resource_name}`\n\n For acls on all resources that match a prefix:\n `topicPrefixed/{resource_name}`\n `consumerGroupPrefixed/{resource_name}`\n `transactionalIdPrefixed/{resource_name}`\n\n For acls on all resources of a given type (i.e. the wildcard literal \"*\"):\n `allTopics` (represents \\`topic/* `)\n `allConsumerGroups`(represents`consumerGroup/*`)\n `allTransactionalIds`(represents`transactionalId/*\\`)\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Identifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}\n\n\n The structure of `acl_id` defines the Resource Pattern (resource_type,\n resource_name, pattern_type) of the acl. `acl_id` is structured like one of\n the following:\n\n For acls on the cluster:\n `cluster`\n\n For acls on a single resource within the cluster:\n `topic/{resource_name}`\n `consumerGroup/{resource_name}`\n `transactionalId/{resource_name}`\n\n For acls on all resources that match a prefix:\n `topicPrefixed/{resource_name}`\n `consumerGroupPrefixed/{resource_name}`\n `transactionalIdPrefixed/{resource_name}`\n\n For acls on all resources of a given type (i.e. the wildcard literal \"*\"):\n `allTopics` (represents \\`topic/* `)\n `allConsumerGroups`(represents`consumerGroup/*`)\n`allTransactionalIds`(represents`transactionalId/*\\`) \n**Returns**\n\n- (::String) --- Identifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}\n\n The structure of `acl_id` defines the Resource Pattern (resource_type,\n resource_name, pattern_type) of the acl. `acl_id` is structured like one of\n the following:\n\n For acls on the cluster:\n `cluster`\n\n For acls on a single resource within the cluster:\n `topic/{resource_name}`\n `consumerGroup/{resource_name}`\n `transactionalId/{resource_name}`\n\n For acls on all resources that match a prefix:\n `topicPrefixed/{resource_name}`\n `consumerGroupPrefixed/{resource_name}`\n `transactionalIdPrefixed/{resource_name}`\n\n For acls on all resources of a given type (i.e. the wildcard literal \"*\"):\n `allTopics` (represents \\`topic/* `)\n `allConsumerGroups`(represents`consumerGroup/*`)\n `allTransactionalIds`(represents`transactionalId/*\\`)\n\n### #pattern_type\n\n def pattern_type() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.\n\n### #resource_name\n\n def resource_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The ACL resource name derived from the name. For cluster resource_type, this is always \"kafka-cluster\". Can be the wildcard literal \"\\*\".\n\n### #resource_type\n\n def resource_type() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID."]]
