Managed Service for Apache Kafka V1 API - Class Google::Cloud::ManagedKafka::V1::Acl (v1.6.0)

Reference documentation and code samples for the Managed Service for Apache Kafka V1 API class Google::Cloud::ManagedKafka::V1::Acl.

Represents the set of ACLs for a given Kafka Resource Pattern, which consists of resource_type, resource_name and pattern_type.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#acl_entries

def acl_entries() -> ::Array<::Google::Cloud::ManagedKafka::V1::AclEntry>
Returns

#acl_entries=

def acl_entries=(value) -> ::Array<::Google::Cloud::ManagedKafka::V1::AclEntry>
Parameter
Returns

#etag

def etag() -> ::String
Returns
  • (::String) — 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.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#name

def name() -> ::String
Returns
  • (::String) — 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(representsconsumerGroup/) allTransactionalIds(representstransactionalId/`)

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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(representsconsumerGroup/) allTransactionalIds(representstransactionalId/`)

Returns
  • (::String) — 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(representsconsumerGroup/) allTransactionalIds(representstransactionalId/`)

#pattern_type

def pattern_type() -> ::String
Returns
  • (::String) — Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.

#resource_name

def resource_name() -> ::String
Returns
  • (::String) — Output only. The ACL resource name derived from the name. For cluster resource_type, this is always "kafka-cluster". Can be the wildcard literal "*".

#resource_type

def resource_type() -> ::String
Returns
  • (::String) — Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID.