Reference documentation and code samples for the Google Cloud Managed Kafka V1 Client class CreateAclRequest.
Request for CreateAcl.
Generated from protobuf message google.cloud.managedkafka.v1.CreateAclRequest
Namespace
Google \ Cloud \ ManagedKafka \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent cluster in which to create the acl. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
↳ acl_id
string
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(representsconsumerGroup/)allTransactionalIds(representstransactionalId/`)
Required. Configuration of the acl to create. Its name field is ignored.
getParent
Required. The parent cluster in which to create the acl.
Structured like
projects/{project}/locations/{location}/clusters/{cluster}.
Returns
Type
Description
string
setParent
Required. The parent cluster in which to create the acl.
Structured like
projects/{project}/locations/{location}/clusters/{cluster}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAclId
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(representsconsumerGroup/)allTransactionalIds(representstransactionalId/`)
Returns
Type
Description
string
setAclId
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(representsconsumerGroup/)allTransactionalIds(representstransactionalId/`)
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAcl
Required. Configuration of the acl to create. Its name field is ignored.
Required. The parent cluster in which to create the acl.
Structured like
projects/{project}/locations/{location}/clusters/{cluster}. Please see
ManagedKafkaClient::clusterName() for help formatting this field.
Required. Configuration of the acl to create. Its name field is ignored.
aclId
string
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(representsconsumerGroup/)allTransactionalIds(representstransactionalId/`)
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Managed Kafka V1 Client - Class CreateAclRequest (0.6.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.6.1 (latest)](/php/docs/reference/cloud-managedkafka/latest/V1.CreateAclRequest)\n- [0.6.0](/php/docs/reference/cloud-managedkafka/0.6.0/V1.CreateAclRequest)\n- [0.5.0](/php/docs/reference/cloud-managedkafka/0.5.0/V1.CreateAclRequest)\n- [0.4.1](/php/docs/reference/cloud-managedkafka/0.4.1/V1.CreateAclRequest)\n- [0.3.1](/php/docs/reference/cloud-managedkafka/0.3.1/V1.CreateAclRequest)\n- [0.2.3](/php/docs/reference/cloud-managedkafka/0.2.3/V1.CreateAclRequest)\n- [0.1.3](/php/docs/reference/cloud-managedkafka/0.1.3/V1.CreateAclRequest) \nReference documentation and code samples for the Google Cloud Managed Kafka V1 Client class CreateAclRequest.\n\nRequest for CreateAcl.\n\nGenerated from protobuf message `google.cloud.managedkafka.v1.CreateAclRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ ManagedKafka \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent cluster in which to create the acl.\n\nStructured like\n`projects/{project}/locations/{location}/clusters/{cluster}`.\n\n### setParent\n\nRequired. The parent cluster in which to create the acl.\n\nStructured like\n`projects/{project}/locations/{location}/clusters/{cluster}`.\n\n### getAclId\n\nRequired. The ID to use for the acl, which will become the final component\nof the acl's name. The structure of `acl_id` defines the Resource Pattern\n(resource_type, resource_name, pattern_type) of the acl. `acl_id` is\nstructured like one of the following:\nFor acls on the cluster:\n`cluster`\nFor acls on a single resource within the cluster:\n`topic/{resource_name}`\n`consumerGroup/{resource_name}`\n`transactionalId/{resource_name}`\nFor acls on all resources that match a prefix:\n`topicPrefixed/{resource_name}`\n`consumerGroupPrefixed/{resource_name}`\n`transactionalIdPrefixed/{resource_name}`\nFor acls on all resources of a given type (i.e. the wildcard literal \"*\"):\n`allTopics` (represents \\`topic/* `)`allConsumerGroups`(represents`consumerGroup/*`)`allTransactionalIds`(represents`transactionalId/*\\`)\n\n### setAclId\n\nRequired. The ID to use for the acl, which will become the final component\nof the acl's name. The structure of `acl_id` defines the Resource Pattern\n(resource_type, resource_name, pattern_type) of the acl. `acl_id` is\nstructured like one of the following:\nFor acls on the cluster:\n`cluster`\nFor acls on a single resource within the cluster:\n`topic/{resource_name}`\n`consumerGroup/{resource_name}`\n`transactionalId/{resource_name}`\nFor acls on all resources that match a prefix:\n`topicPrefixed/{resource_name}`\n`consumerGroupPrefixed/{resource_name}`\n`transactionalIdPrefixed/{resource_name}`\nFor acls on all resources of a given type (i.e. the wildcard literal \"*\"):\n`allTopics` (represents \\`topic/* `)`allConsumerGroups`(represents`consumerGroup/*`)`allTransactionalIds`(represents`transactionalId/*\\`)\n\n### getAcl\n\nRequired. Configuration of the acl to create. Its `name` field is ignored.\n\n### hasAcl\n\n### clearAcl\n\n### setAcl\n\nRequired. Configuration of the acl to create. Its `name` field is ignored.\n\n### static::build"]]
