Package com.google.cloud.managedkafka.v1

Interface AclOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Acl, Acl.Builder
@Generated public interface AclOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getAclEntriesList

      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];

    • getAclEntries

      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];

    • getAclEntriesCount

      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];

    • getAclEntriesOrBuilderList

      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];

    • getAclEntriesOrBuilder

      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];

    • getEtag

      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:
      The etag.

    • getEtagBytes

      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];
      Returns:
      The bytes for etag.

    • getResourceType

      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:
      The resourceType.

    • getResourceTypeBytes

      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];
      Returns:
      The bytes for resourceType.

    • getResourceName

      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:
      The resourceName.

    • getResourceNameBytes

      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];
      Returns:
      The bytes for resourceName.

    • getPatternType

      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:
      The patternType.

    • getPatternTypeBytes

      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];
      Returns:
      The bytes for patternType.