2025-04-20
▼ ▲ managedkafka.projects.locations.clusters.acls.list
Path : v1/{+parent}/acls
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls
HTTP Method : GET
Parameters :
parent
Description : Required. The parent cluster whose acls are to be listed. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of acls to return. The service may return fewer than this value. If unset or zero, all acls for the parent is returned.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListAcls` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAcls` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the acls in a given cluster.
▼ ▲ managedkafka.projects.locations.clusters.acls.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls/{aclsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the acl to return. 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. See `Acl.name` for details.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/acls/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns the properties of a single acl.
▼ ▲ managedkafka.projects.locations.clusters.acls.create
Path : v1/{+parent}/acls
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls
HTTP Method : POST
Parameters :
parent
Description : Required. The parent cluster in which to create the acl. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location : path
Required : Yes
Type : string
aclId
Description : Required. The ID to use for the acl, which will become the final component of the acl's name. 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/*`)
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new acl in the given project, location, and cluster.
▼ ▲ managedkafka.projects.locations.clusters.acls.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls/{aclsId}
HTTP Method : PATCH
Parameters :
name
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/*`)
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/acls/.*$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Field mask is used to specify the fields to be overwritten in the Acl resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the properties of a single acl.
▼ ▲ managedkafka.projects.locations.clusters.acls.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls/{aclsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the acl to delete. 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. See `Acl.name` for details.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/acls/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an acl.
▼ ▲ managedkafka.projects.locations.clusters.acls.addAclEntry
Path : v1/{+acl}:addAclEntry
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls/{aclsId}:addAclEntry
HTTP Method : POST
Parameters :
acl
Description : Required. The name of the acl to add the acl entry to. 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. See `Acl.name` for details.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/acls/.*$
Location : path
Required : Yes
Type : string
Parameter Order : acl
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Incremental update: Adds an acl entry to an acl. Creates the acl if it does not exist yet.
▼ ▲ managedkafka.projects.locations.clusters.acls.removeAclEntry
Path : v1/{+acl}:removeAclEntry
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls/{aclsId}:removeAclEntry
HTTP Method : POST
Parameters :
acl
Description : Required. The name of the acl to remove the acl entry from. 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. See `Acl.name` for details.
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/acls/.*$
Location : path
Required : Yes
Type : string
Parameter Order : acl
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Incremental update: Removes an acl entry from an acl. Deletes the acl if its acl entries become empty (i.e. if the removed entry was the last one in the acl).