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

Reference documentation and code samples for the Google Cloud Managed Kafka V1 Client class AclEntry.

Represents the access granted for a given Resource Pattern in an ACL.

Generated from protobuf message google.cloud.managedkafka.v1.AclEntry

Namespace

Google \ Cloud \ ManagedKafka \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ principal string

Required. The principal. Specified as Google Cloud account, with the Kafka StandardAuthorizer prefix "User:". For example: "User:test-kafka-client@test-project.iam.gserviceaccount.com". Can be the wildcard "User:*" to refer to all users.

↳ permission_type string

Required. The permission type. Accepted values are (case insensitive): ALLOW, DENY.

↳ operation string

Required. The operation type. Allowed values are (case insensitive): ALL, READ, WRITE, CREATE, DELETE, ALTER, DESCRIBE, CLUSTER_ACTION, DESCRIBE_CONFIGS, ALTER_CONFIGS, and IDEMPOTENT_WRITE. See https://kafka.apache.org/documentation/#operations_resources_and_protocols for valid combinations of resource_type and operation for different Kafka API requests.

↳ host string

Required. The host. Must be set to "*" for Managed Service for Apache Kafka.

getPrincipal

Required. The principal. Specified as Google Cloud account, with the Kafka StandardAuthorizer prefix "User:". For example: "User:test-kafka-client@test-project.iam.gserviceaccount.com".

Can be the wildcard "User:*" to refer to all users.

Returns
Type Description
string

setPrincipal

Required. The principal. Specified as Google Cloud account, with the Kafka StandardAuthorizer prefix "User:". For example: "User:test-kafka-client@test-project.iam.gserviceaccount.com".

Can be the wildcard "User:*" to refer to all users.

Parameter
Name Description
var string
Returns
Type Description
$this

getPermissionType

Required. The permission type. Accepted values are (case insensitive): ALLOW, DENY.

Returns
Type Description
string

setPermissionType

Required. The permission type. Accepted values are (case insensitive): ALLOW, DENY.

Parameter
Name Description
var string
Returns
Type Description
$this

getOperation

Required. The operation type. Allowed values are (case insensitive): ALL, READ, WRITE, CREATE, DELETE, ALTER, DESCRIBE, CLUSTER_ACTION, DESCRIBE_CONFIGS, ALTER_CONFIGS, and IDEMPOTENT_WRITE. See https://kafka.apache.org/documentation/#operations_resources_and_protocols for valid combinations of resource_type and operation for different Kafka API requests.

Returns
Type Description
string

setOperation

Required. The operation type. Allowed values are (case insensitive): ALL, READ, WRITE, CREATE, DELETE, ALTER, DESCRIBE, CLUSTER_ACTION, DESCRIBE_CONFIGS, ALTER_CONFIGS, and IDEMPOTENT_WRITE. See https://kafka.apache.org/documentation/#operations_resources_and_protocols for valid combinations of resource_type and operation for different Kafka API requests.

Parameter
Name Description
var string
Returns
Type Description
$this

getHost

Required. The host. Must be set to "*" for Managed Service for Apache Kafka.

Returns
Type Description
string

setHost

Required. The host. Must be set to "*" for Managed Service for Apache Kafka.

Parameter
Name Description
var string
Returns
Type Description
$this