public interface AclOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAclEntries(int index)
public abstract AclEntry getAclEntries(int index)Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.
repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
AclEntry |
|
getAclEntriesCount()
public abstract int getAclEntriesCount()Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.
repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
|
getAclEntriesList()
public abstract List<AclEntry> getAclEntriesList()Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.
repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<AclEntry> |
|
getAclEntriesOrBuilder(int index)
public abstract AclEntryOrBuilder getAclEntriesOrBuilder(int index)Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.
repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
AclEntryOrBuilder |
|
getAclEntriesOrBuilderList()
public abstract List<? extends AclEntryOrBuilder> getAclEntriesOrBuilderList()Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.
repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.managedkafka.v1.AclEntryOrBuilder> |
|
getEtag()
public abstract String 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 etag = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The etag. |
getEtagBytes()
public abstract ByteString getEtagBytes() 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 etag = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for etag. |
getName()
public abstract String 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 name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes()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 name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getPatternType()
public abstract String getPatternType()Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.
string pattern_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The patternType. |
getPatternTypeBytes()
public abstract ByteString getPatternTypeBytes()Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.
string pattern_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for patternType. |
getResourceName()
public abstract String 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 resource_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The resourceName. |
getResourceNameBytes()
public abstract ByteString getResourceNameBytes()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 resource_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for resourceName. |
getResourceType()
public abstract String getResourceType()Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID.
string resource_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The resourceType. |
getResourceTypeBytes()
public abstract ByteString getResourceTypeBytes()Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID.
string resource_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for resourceType. |