com.tencentcloudapi.ckafka.v20190819.models

Class CreateAclRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ckafka.v20190819.models.CreateAclRequest

public class CreateAclRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateAclRequest()
CreateAclRequest(CreateAclRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String	getHost() Get The default value is `*`, which means that any host can access.
String	getInstanceId() Get Instance ID information
Long	getOperation() Get ACL operation type (`2`: ALL, `3`: READ, `4`: WRITE, `5`: CREATE, `6`: DELETE, `7`: ALTER, `8`: DESCRIBE, `9`: CLUSTER_ACTION, `10`: DESCRIBE_CONFIGS, `11`: ALTER_CONFIGS, `12`: IDEMPOTENT_WRITE).
Long	getPermissionType() Get Permission type (`2`: DENY, `3`: ALLOW).
String	getPrincipal() Get The list of users allowed to access the topic.
String	getResourceName() Get Resource name, which is related to `resourceType`.
String	getResourceNameList() Get The resource name list, which is in JSON string format.
Long	getResourceType() Get ACL resource type (`2`: TOPIC, `3`: GROUP, `4`: CLUSTER).
void	setHost(String Host) Set The default value is `*`, which means that any host can access.
void	setInstanceId(String InstanceId) Set Instance ID information
void	setOperation(Long Operation) Set ACL operation type (`2`: ALL, `3`: READ, `4`: WRITE, `5`: CREATE, `6`: DELETE, `7`: ALTER, `8`: DESCRIBE, `9`: CLUSTER_ACTION, `10`: DESCRIBE_CONFIGS, `11`: ALTER_CONFIGS, `12`: IDEMPOTENT_WRITE).
void	setPermissionType(Long PermissionType) Set Permission type (`2`: DENY, `3`: ALLOW).
void	setPrincipal(String Principal) Set The list of users allowed to access the topic.
void	setResourceName(String ResourceName) Set Resource name, which is related to `resourceType`.
void	setResourceNameList(String ResourceNameList) Set The resource name list, which is in JSON string format.
void	setResourceType(Long ResourceType) Set ACL resource type (`2`: TOPIC, `3`: GROUP, `4`: CLUSTER).
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateAclRequest

public CreateAclRequest()

CreateAclRequest

public CreateAclRequest(CreateAclRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getInstanceId

public String getInstanceId()

Get Instance ID information

Returns:

InstanceId Instance ID information

setInstanceId

public void setInstanceId(String InstanceId)

Set Instance ID information

Parameters:

InstanceId - Instance ID information

getResourceType

public Long getResourceType()

Get ACL resource type (`2`: TOPIC, `3`: GROUP, `4`: CLUSTER).

Returns:

ResourceType ACL resource type (`2`: TOPIC, `3`: GROUP, `4`: CLUSTER).

setResourceType

public void setResourceType(Long ResourceType)

Set ACL resource type (`2`: TOPIC, `3`: GROUP, `4`: CLUSTER).

Parameters:

ResourceType - ACL resource type (`2`: TOPIC, `3`: GROUP, `4`: CLUSTER).

getOperation

public Long getOperation()

Get ACL operation type (`2`: ALL, `3`: READ, `4`: WRITE, `5`: CREATE, `6`: DELETE, `7`: ALTER, `8`: DESCRIBE, `9`: CLUSTER_ACTION, `10`: DESCRIBE_CONFIGS, `11`: ALTER_CONFIGS, `12`: IDEMPOTENT_WRITE).

Returns:

Operation ACL operation type (`2`: ALL, `3`: READ, `4`: WRITE, `5`: CREATE, `6`: DELETE, `7`: ALTER, `8`: DESCRIBE, `9`: CLUSTER_ACTION, `10`: DESCRIBE_CONFIGS, `11`: ALTER_CONFIGS, `12`: IDEMPOTENT_WRITE).

setOperation

public void setOperation(Long Operation)

Set ACL operation type (`2`: ALL, `3`: READ, `4`: WRITE, `5`: CREATE, `6`: DELETE, `7`: ALTER, `8`: DESCRIBE, `9`: CLUSTER_ACTION, `10`: DESCRIBE_CONFIGS, `11`: ALTER_CONFIGS, `12`: IDEMPOTENT_WRITE).

Parameters:

Operation - ACL operation type (`2`: ALL, `3`: READ, `4`: WRITE, `5`: CREATE, `6`: DELETE, `7`: ALTER, `8`: DESCRIBE, `9`: CLUSTER_ACTION, `10`: DESCRIBE_CONFIGS, `11`: ALTER_CONFIGS, `12`: IDEMPOTENT_WRITE).

getPermissionType

public Long getPermissionType()

Get Permission type (`2`: DENY, `3`: ALLOW). CKafka currently supports `ALLOW`, which is equivalent to allowlist. `DENY` will be supported for ACLs compatible with open-source Kafka.

Returns:

PermissionType Permission type (`2`: DENY, `3`: ALLOW). CKafka currently supports `ALLOW`, which is equivalent to allowlist. `DENY` will be supported for ACLs compatible with open-source Kafka.

setPermissionType

public void setPermissionType(Long PermissionType)

Set Permission type (`2`: DENY, `3`: ALLOW). CKafka currently supports `ALLOW`, which is equivalent to allowlist. `DENY` will be supported for ACLs compatible with open-source Kafka.

Parameters:

PermissionType - Permission type (`2`: DENY, `3`: ALLOW). CKafka currently supports `ALLOW`, which is equivalent to allowlist. `DENY` will be supported for ACLs compatible with open-source Kafka.

getResourceName

public String getResourceName()

Get Resource name, which is related to `resourceType`. For example, if `resourceType` is `TOPIC`, this field indicates the topic name; if `resourceType` is `GROUP`, this field indicates the group name; if `resourceType` is `CLUSTER`, this field can be left empty.

Returns:

ResourceName Resource name, which is related to `resourceType`. For example, if `resourceType` is `TOPIC`, this field indicates the topic name; if `resourceType` is `GROUP`, this field indicates the group name; if `resourceType` is `CLUSTER`, this field can be left empty.

setResourceName

public void setResourceName(String ResourceName)

Set Resource name, which is related to `resourceType`. For example, if `resourceType` is `TOPIC`, this field indicates the topic name; if `resourceType` is `GROUP`, this field indicates the group name; if `resourceType` is `CLUSTER`, this field can be left empty.

Parameters:

ResourceName - Resource name, which is related to `resourceType`. For example, if `resourceType` is `TOPIC`, this field indicates the topic name; if `resourceType` is `GROUP`, this field indicates the group name; if `resourceType` is `CLUSTER`, this field can be left empty.

getHost

public String getHost()

Get The default value is `*`, which means that any host can access. Currently, CKafka does not support the host as `*`, but the future product based on the open-source Kafka will directly support this

Returns:

Host The default value is `*`, which means that any host can access. Currently, CKafka does not support the host as `*`, but the future product based on the open-source Kafka will directly support this

setHost

public void setHost(String Host)

Set The default value is `*`, which means that any host can access. Currently, CKafka does not support the host as `*`, but the future product based on the open-source Kafka will directly support this

Parameters:

Host - The default value is `*`, which means that any host can access. Currently, CKafka does not support the host as `*`, but the future product based on the open-source Kafka will directly support this

getPrincipal

public String getPrincipal()

Get The list of users allowed to access the topic. Default: User:*, meaning all users. The current user must be in the user list. Add `User:` before the user name (`User:A` for example).

Returns:

Principal The list of users allowed to access the topic. Default: User:*, meaning all users. The current user must be in the user list. Add `User:` before the user name (`User:A` for example).

setPrincipal

public void setPrincipal(String Principal)

Set The list of users allowed to access the topic. Default: User:*, meaning all users. The current user must be in the user list. Add `User:` before the user name (`User:A` for example).

Parameters:

Principal - The list of users allowed to access the topic. Default: User:*, meaning all users. The current user must be in the user list. Add `User:` before the user name (`User:A` for example).

getResourceNameList

public String getResourceNameList()

Get The resource name list, which is in JSON string format. Either `ResourceName` or `resourceNameList` can be specified.

Returns:

ResourceNameList The resource name list, which is in JSON string format. Either `ResourceName` or `resourceNameList` can be specified.

setResourceNameList

public void setResourceNameList(String ResourceNameList)

Set The resource name list, which is in JSON string format. Either `ResourceName` or `resourceNameList` can be specified.

Parameters:

ResourceNameList - The resource name list, which is in JSON string format. Either `ResourceName` or `resourceNameList` can be specified.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel