Google Cloud Managed Kafka V1 Client - Class CreateAclRequest (0.5.0)

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/`)
↳ acl Acl

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.

Returns
Type Description
Acl|null

hasAcl

clearAcl

setAcl

Required. Configuration of the acl to create. Its name field is ignored.

Parameter
Name Description
var Acl
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

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.
acl Acl

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/`)
Returns
Type Description
CreateAclRequest