public sealed class Acl : IMessage<Acl>, IEquatable<Acl>, IDeepCloneable<Acl>, IBufferMessage, IMessage
Reference documentation and code samples for the Managed Service for Apache Kafka API v1 API class Acl.
Represents the set of ACLs for a given Kafka Resource Pattern, which consists of resource_type, resource_name and pattern_type.
Namespace
Google.Cloud.ManagedKafka.V1Assembly
Google.Cloud.ManagedKafka.V1.dll
Constructors
Acl()
public Acl()
Acl(Acl)
public Acl(Acl other)
Parameter | |
---|---|
Name | Description |
other |
Acl |
Properties
AclEntries
public RepeatedField<AclEntry> AclEntries { get; }
Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.
Property Value | |
---|---|
Type | Description |
RepeatedFieldAclEntry |
AclName
public AclName AclName { get; set; }
Property Value | |
---|---|
Type | Description |
AclName |
Etag
public string Etag { get; set; }
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.
Property Value | |
---|---|
Type | Description |
string |
Name
public string Name { get; set; }
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/`)
Property Value | |
---|---|
Type | Description |
string |
PatternType
public string PatternType { get; set; }
Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.
Property Value | |
---|---|
Type | Description |
string |
ResourceName
public string ResourceName { get; set; }
Output only. The ACL resource name derived from the name. For cluster resource_type, this is always "kafka-cluster". Can be the wildcard literal "*".
Property Value | |
---|---|
Type | Description |
string |
ResourceType
public string ResourceType { get; set; }
Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID.
Property Value | |
---|---|
Type | Description |
string |