acls

Creates, updates, deletes, gets or lists an acls resource.

Overview

Name	acls
Type	Resource
Id	google.managedkafka.acls

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	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 (represents consumerGroup/*) allTransactionalIds (represents transactionalId/*)
aclEntries	array	Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.
etag	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.
patternType	string	Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.
resourceName	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 "*".
resourceType	string	Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID.

list

Successful response

Name	Datatype	Description
name	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 (represents consumerGroup/*) allTransactionalIds (represents transactionalId/*)
aclEntries	array	Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.
etag	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.
patternType	string	Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.
resourceName	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 "*".
resourceType	string	Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, clustersId, aclsId		Returns the properties of a single acl.
list	select	projectsId, locationsId, clustersId	pageSize, pageToken	Lists the acls in a given cluster.
create	insert	projectsId, locationsId, clustersId	aclId	Creates a new acl in the given project, location, and cluster.
patch	update	projectsId, locationsId, clustersId, aclsId	updateMask	Updates the properties of a single acl.
delete	delete	projectsId, locationsId, clustersId, aclsId		Deletes an acl.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
aclsId	string
clustersId	string
locationsId	string
projectsId	string
aclId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Returns the properties of a single acl.

SELECT
name,
aclEntries,
etag,
patternType,
resourceName,
resourceType
FROM google.managedkafka.acls
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND clustersId = '{{ clustersId }}' -- required
AND aclsId = '{{ aclsId }}' -- required;

list

Lists the acls in a given cluster.

SELECT
name,
aclEntries,
etag,
patternType,
resourceName,
resourceType
FROM google.managedkafka.acls
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND clustersId = '{{ clustersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates a new acl in the given project, location, and cluster.

INSERT INTO google.managedkafka.acls (
data__name,
data__aclEntries,
data__etag,
projectsId,
locationsId,
clustersId,
aclId
)
SELECT 
'{{ name }}',
'{{ aclEntries }}',
'{{ etag }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ clustersId }}',
'{{ aclId }}'
RETURNING
name,
aclEntries,
etag,
patternType,
resourceName,
resourceType
;

Manifest

# Description fields are for documentation purposes
- name: acls
  props:
    - name: projectsId
      value: string
      description: Required parameter for the acls resource.
    - name: locationsId
      value: string
      description: Required parameter for the acls resource.
    - name: clustersId
      value: string
      description: Required parameter for the acls resource.
    - name: name
      value: string
      description: >
        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/*`)
        
    - name: aclEntries
      value: array
      description: >
        Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.
        
    - name: etag
      value: string
      description: >
        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: aclId
      value: string

UPDATE examples

patch

Updates the properties of a single acl.

UPDATE google.managedkafka.acls
SET 
data__name = '{{ name }}',
data__aclEntries = '{{ aclEntries }}',
data__etag = '{{ etag }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND aclsId = '{{ aclsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
aclEntries,
etag,
patternType,
resourceName,
resourceType;

DELETE examples

delete

Deletes an acl.

DELETE FROM google.managedkafka.acls
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND aclsId = '{{ aclsId }}' --required;