Package com.google.cloud.managedkafka.v1

Class Acl

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.managedkafka.v1.Acl
All Implemented Interfaces:
AclOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Acl extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Acl.Builder
    Represents the set of ACLs for a given Kafka Resource Pattern, which consists of resource_type, resource_name and pattern_type.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ACL_ENTRIES_FIELD_NUMBER
     
    static final int
    ETAG_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    PATTERN_TYPE_FIELD_NUMBER
     
    static final int
    RESOURCE_NAME_FIELD_NUMBER
     
    static final int
    RESOURCE_TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    AclEntry
    getAclEntries(int index)
    Required.
    int
    getAclEntriesCount()
    Required.
    List<AclEntry>
    getAclEntriesList()
    Required.
    AclEntryOrBuilder
    getAclEntriesOrBuilder(int index)
    Required.
    List<? extends AclEntryOrBuilder>
    getAclEntriesOrBuilderList()
    Required.
    static Acl
    getDefaultInstance()
     
    Acl
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getEtag()
    Optional.
    com.google.protobuf.ByteString
    getEtagBytes()
    Optional.
    String
    getName()
    Identifier.
    com.google.protobuf.ByteString
    getNameBytes()
    Identifier.
    com.google.protobuf.Parser<Acl>
    getParserForType()
     
    String
    getPatternType()
    Output only.
    com.google.protobuf.ByteString
    getPatternTypeBytes()
    Output only.
    String
    getResourceName()
    Output only.
    com.google.protobuf.ByteString
    getResourceNameBytes()
    Output only.
    String
    getResourceType()
    Output only.
    com.google.protobuf.ByteString
    getResourceTypeBytes()
    Output only.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Acl.Builder
    newBuilder()
     
    static Acl.Builder
    newBuilder(Acl prototype)
     
    Acl.Builder
    newBuilderForType()
     
    protected Acl.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Acl
    parseDelimitedFrom(InputStream input)
     
    static Acl
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Acl
    parseFrom(byte[] data)
     
    static Acl
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Acl
    parseFrom(com.google.protobuf.ByteString data)
     
    static Acl
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Acl
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Acl
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Acl
    parseFrom(InputStream input)
     
    static Acl
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Acl
    parseFrom(ByteBuffer data)
     
    static Acl
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Acl>
    parser()
     
    Acl.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • ACL_ENTRIES_FIELD_NUMBER

      public static final int ACL_ENTRIES_FIELD_NUMBER
      See Also:

    • ETAG_FIELD_NUMBER

      public static final int ETAG_FIELD_NUMBER
      See Also:

    • RESOURCE_TYPE_FIELD_NUMBER

      public static final int RESOURCE_TYPE_FIELD_NUMBER
      See Also:

    • RESOURCE_NAME_FIELD_NUMBER

      public static final int RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • PATTERN_TYPE_FIELD_NUMBER

      public static final int PATTERN_TYPE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public 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];
      Specified by:
      getName in interface AclOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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];
      Specified by:
      getNameBytes in interface AclOrBuilder
      Returns:
      The bytes for name.

    • 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];
      Specified by:
      getAclEntriesList in interface AclOrBuilder

    • 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];
      Specified by:
      getAclEntriesOrBuilderList in interface AclOrBuilder

    • 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];
      Specified by:
      getAclEntriesCount in interface AclOrBuilder

    • getAclEntries

      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];
      Specified by:
      getAclEntries in interface AclOrBuilder

    • getAclEntriesOrBuilder

      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];
      Specified by:
      getAclEntriesOrBuilder in interface AclOrBuilder

    • getEtag

      public 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];
      Specified by:
      getEtag in interface AclOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.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];
      Specified by:
      getEtagBytes in interface AclOrBuilder
      Returns:
      The bytes for etag.

    • 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];
      Specified by:
      getResourceType in interface AclOrBuilder
      Returns:
      The resourceType.

    • getResourceTypeBytes

      public com.google.protobuf.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];
      Specified by:
      getResourceTypeBytes in interface AclOrBuilder
      Returns:
      The bytes for resourceType.

    • 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];
      Specified by:
      getResourceName in interface AclOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

      public com.google.protobuf.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];
      Specified by:
      getResourceNameBytes in interface AclOrBuilder
      Returns:
      The bytes for resourceName.

    • 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];
      Specified by:
      getPatternType in interface AclOrBuilder
      Returns:
      The patternType.

    • getPatternTypeBytes

      public com.google.protobuf.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];
      Specified by:
      getPatternTypeBytes in interface AclOrBuilder
      Returns:
      The bytes for patternType.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Acl parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Acl parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Acl parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Acl parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Acl parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Acl parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Acl parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Acl parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Acl parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Acl parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Acl parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Acl parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Acl.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Acl.Builder newBuilder()

    • newBuilder

      public static Acl.Builder newBuilder(Acl prototype)

    • toBuilder

      public Acl.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Acl.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Acl getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Acl> parser()

    • getParserForType

      public com.google.protobuf.Parser<Acl> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Acl getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder