Reference documentation and code samples for the Google Cloud Managed Kafka V1 Client class Acl.
Represents the set of ACLs for a given Kafka Resource Pattern, which consists of resource_type, resource_name and pattern_type.
Generated from protobuf message google.cloud.managedkafka.v1.Acl
Namespace
Google \ Cloud \ ManagedKafka \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
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 (represents
consumerGroup/ )
allTransactionalIds (represents
transactionalId/
`)
↳ acl_entries
array< AclEntry
>
Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.
↳ etag
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.
↳ resource_type
string
Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID.
↳ resource_name
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 "*".
↳ pattern_type
string
Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.
getName
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 (represents
consumerGroup/ )
allTransactionalIds (represents
transactionalId/
`)
string
setName
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 (represents
consumerGroup/ )
allTransactionalIds (represents
transactionalId/
`)
var
string
$this
getAclEntries
Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.
setAclEntries
Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.
$this
getEtag
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.
string
setEtag
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.
var
string
$this
getResourceType
Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID.
string
setResourceType
Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID.
var
string
$this
getResourceName
Output only. The ACL resource name derived from the name. For cluster resource_type, this is always "kafka-cluster". Can be the wildcard literal "*".
string
setResourceName
Output only. The ACL resource name derived from the name. For cluster resource_type, this is always "kafka-cluster". Can be the wildcard literal "*".
var
string
$this
getPatternType
Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.
string
setPatternType
Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.
var
string
$this
