public final class Acl extends GeneratedMessageV3 implements AclOrBuilder
Represents the set of ACLs for a given Kafka Resource Pattern, which consists
of resource_type, resource_name and pattern_type.
Protobuf type google.cloud.managedkafka.v1.Acl
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ACL_ENTRIES_FIELD_NUMBER
public static final int ACL_ENTRIES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PATTERN_TYPE_FIELD_NUMBER
public static final int PATTERN_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESOURCE_NAME_FIELD_NUMBER
public static final int RESOURCE_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESOURCE_TYPE_FIELD_NUMBER
public static final int RESOURCE_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Acl getDefaultInstance()
| Returns |
| Type |
Description |
Acl |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Acl.Builder newBuilder()
newBuilder(Acl prototype)
public static Acl.Builder newBuilder(Acl prototype)
| Parameter |
| Name |
Description |
prototype |
Acl
|
public static Acl parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Acl |
|
public static Acl parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Acl |
|
parseFrom(byte[] data)
public static Acl parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Acl |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Acl parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Acl |
|
parseFrom(ByteString data)
public static Acl parseFrom(ByteString data)
| Returns |
| Type |
Description |
Acl |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Acl parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Acl |
|
public static Acl parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Acl |
|
public static Acl parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Acl |
|
public static Acl parseFrom(InputStream input)
| Returns |
| Type |
Description |
Acl |
|
public static Acl parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Acl |
|
parseFrom(ByteBuffer data)
public static Acl parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Acl |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Acl parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Acl |
|
parser()
public static Parser<Acl> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAclEntries(int index)
public 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
|
getAclEntriesCount()
public 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 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];
getAclEntriesOrBuilder(int index)
public 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
|
getAclEntriesOrBuilderList()
public 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> |
|
getDefaultInstanceForType()
public Acl getDefaultInstanceForType()
| Returns |
| Type |
Description |
Acl |
|
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 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()
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 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.
|
getParserForType()
public Parser<Acl> getParserForType()
Overrides
getPatternType()
public 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 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 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 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 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 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Acl.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Acl.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Acl.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
