CkafkaClient (tencentcloud-sdk-java 3.0.123 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.ckafka.v20190819.CkafkaClient

public class CkafkaClient
extends AbstractClient

字段概要
- 从类继承的字段 com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

构造器概要

构造器
构造器和说明
`CkafkaClient(Credential credential, String region)`
`CkafkaClient(Credential credential, String region, ClientProfile profile)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`CreateAclResponse`	`CreateAcl(CreateAclRequest req)` 添加 ACL 策略
`CreatePartitionResponse`	`CreatePartition(CreatePartitionRequest req)` 本接口用于增加主题中的分区
`CreateTopicResponse`	`CreateTopic(CreateTopicRequest req)` 创建ckafka主题
`CreateTopicIpWhiteListResponse`	`CreateTopicIpWhiteList(CreateTopicIpWhiteListRequest req)` 创建主题ip白名单
`CreateUserResponse`	`CreateUser(CreateUserRequest req)` 添加用户
`DeleteAclResponse`	`DeleteAcl(DeleteAclRequest req)` 删除ACL
`DeleteTopicResponse`	`DeleteTopic(DeleteTopicRequest req)` 删除ckafka主题
`DeleteTopicIpWhiteListResponse`	`DeleteTopicIpWhiteList(DeleteTopicIpWhiteListRequest req)` 删除主题IP白名单
`DeleteUserResponse`	`DeleteUser(DeleteUserRequest req)` 删除用户
`DescribeACLResponse`	`DescribeACL(DescribeACLRequest req)` 枚举ACL
`DescribeAppInfoResponse`	`DescribeAppInfo(DescribeAppInfoRequest req)` 查询用户列表
`DescribeConsumerGroupResponse`	`DescribeConsumerGroup(DescribeConsumerGroupRequest req)` 查询消费分组信息
`DescribeGroupResponse`	`DescribeGroup(DescribeGroupRequest req)` 枚举消费分组(精简版)
`DescribeGroupInfoResponse`	`DescribeGroupInfo(DescribeGroupInfoRequest req)` 获取消费分组信息
`DescribeGroupOffsetsResponse`	`DescribeGroupOffsets(DescribeGroupOffsetsRequest req)` 获取消费分组offset
`DescribeInstanceAttributesResponse`	`DescribeInstanceAttributes(DescribeInstanceAttributesRequest req)` 获取实例属性
`DescribeInstancesResponse`	`DescribeInstances(DescribeInstancesRequest req)` 本接口（DescribeInstance）用于在用户账户下获取消息队列 CKafka 实例列表
`DescribeInstancesDetailResponse`	`DescribeInstancesDetail(DescribeInstancesDetailRequest req)` 用户账户下获取实例列表详情
`DescribeTopicResponse`	`DescribeTopic(DescribeTopicRequest req)` 接口请求域名：https://ckafka.tencentcloudapi.com 本接口（DescribeTopic）用于在用户获取消息队列 CKafka 实例的主题列表
`DescribeTopicAttributesResponse`	`DescribeTopicAttributes(DescribeTopicAttributesRequest req)` 获取主题属性
`DescribeTopicDetailResponse`	`DescribeTopicDetail(DescribeTopicDetailRequest req)` 获取主题列表详情（仅控制台调用）
`DescribeUserResponse`	`DescribeUser(DescribeUserRequest req)` 查询用户信息
`ModifyGroupOffsetsResponse`	`ModifyGroupOffsets(ModifyGroupOffsetsRequest req)` 设置Groups 消费分组offset
`ModifyInstanceAttributesResponse`	`ModifyInstanceAttributes(ModifyInstanceAttributesRequest req)` 设置实例属性
`ModifyPasswordResponse`	`ModifyPassword(ModifyPasswordRequest req)` 修改密码
`ModifyTopicAttributesResponse`	`ModifyTopicAttributes(ModifyTopicAttributesRequest req)` 本接口用于修改主题属性。

从类继承的方法 com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

CkafkaClient

public CkafkaClient(Credential credential,
                    String region)

CkafkaClient

public CkafkaClient(Credential credential,
                    String region,
                    ClientProfile profile)

方法详细资料

CreateAcl

public CreateAclResponse CreateAcl(CreateAclRequest req)
                            throws TencentCloudSDKException

添加 ACL 策略

参数:: req - CreateAclRequest
返回:: CreateAclResponse
抛出:: TencentCloudSDKException

CreatePartition

public CreatePartitionResponse CreatePartition(CreatePartitionRequest req)
                                        throws TencentCloudSDKException

本接口用于增加主题中的分区

参数:: req - CreatePartitionRequest
返回:: CreatePartitionResponse
抛出:: TencentCloudSDKException

CreateTopic

public CreateTopicResponse CreateTopic(CreateTopicRequest req)
                                throws TencentCloudSDKException

创建ckafka主题

参数:: req - CreateTopicRequest
返回:: CreateTopicResponse
抛出:: TencentCloudSDKException

CreateTopicIpWhiteList

public CreateTopicIpWhiteListResponse CreateTopicIpWhiteList(CreateTopicIpWhiteListRequest req)
                                                      throws TencentCloudSDKException

创建主题ip白名单

参数:: req - CreateTopicIpWhiteListRequest
返回:: CreateTopicIpWhiteListResponse
抛出:: TencentCloudSDKException

CreateUser

public CreateUserResponse CreateUser(CreateUserRequest req)
                              throws TencentCloudSDKException

添加用户

参数:: req - CreateUserRequest
返回:: CreateUserResponse
抛出:: TencentCloudSDKException

DeleteAcl

public DeleteAclResponse DeleteAcl(DeleteAclRequest req)
                            throws TencentCloudSDKException

删除ACL

参数:: req - DeleteAclRequest
返回:: DeleteAclResponse
抛出:: TencentCloudSDKException

DeleteTopic

public DeleteTopicResponse DeleteTopic(DeleteTopicRequest req)
                                throws TencentCloudSDKException

删除ckafka主题

参数:: req - DeleteTopicRequest
返回:: DeleteTopicResponse
抛出:: TencentCloudSDKException

DeleteTopicIpWhiteList

public DeleteTopicIpWhiteListResponse DeleteTopicIpWhiteList(DeleteTopicIpWhiteListRequest req)
                                                      throws TencentCloudSDKException

删除主题IP白名单

参数:: req - DeleteTopicIpWhiteListRequest
返回:: DeleteTopicIpWhiteListResponse
抛出:: TencentCloudSDKException

DeleteUser

public DeleteUserResponse DeleteUser(DeleteUserRequest req)
                              throws TencentCloudSDKException

删除用户

参数:: req - DeleteUserRequest
返回:: DeleteUserResponse
抛出:: TencentCloudSDKException

DescribeACL

public DescribeACLResponse DescribeACL(DescribeACLRequest req)
                                throws TencentCloudSDKException

枚举ACL

参数:: req - DescribeACLRequest
返回:: DescribeACLResponse
抛出:: TencentCloudSDKException

DescribeAppInfo

public DescribeAppInfoResponse DescribeAppInfo(DescribeAppInfoRequest req)
                                        throws TencentCloudSDKException

查询用户列表

参数:: req - DescribeAppInfoRequest
返回:: DescribeAppInfoResponse
抛出:: TencentCloudSDKException

DescribeConsumerGroup

public DescribeConsumerGroupResponse DescribeConsumerGroup(DescribeConsumerGroupRequest req)
                                                    throws TencentCloudSDKException

查询消费分组信息

参数:: req - DescribeConsumerGroupRequest
返回:: DescribeConsumerGroupResponse
抛出:: TencentCloudSDKException

DescribeGroup

public DescribeGroupResponse DescribeGroup(DescribeGroupRequest req)
                                    throws TencentCloudSDKException

枚举消费分组(精简版)

参数:: req - DescribeGroupRequest
返回:: DescribeGroupResponse
抛出:: TencentCloudSDKException

DescribeGroupInfo

public DescribeGroupInfoResponse DescribeGroupInfo(DescribeGroupInfoRequest req)
                                            throws TencentCloudSDKException

获取消费分组信息

参数:: req - DescribeGroupInfoRequest
返回:: DescribeGroupInfoResponse
抛出:: TencentCloudSDKException

DescribeGroupOffsets

public DescribeGroupOffsetsResponse DescribeGroupOffsets(DescribeGroupOffsetsRequest req)
                                                  throws TencentCloudSDKException

获取消费分组offset

参数:: req - DescribeGroupOffsetsRequest
返回:: DescribeGroupOffsetsResponse
抛出:: TencentCloudSDKException

DescribeInstanceAttributes

public DescribeInstanceAttributesResponse DescribeInstanceAttributes(DescribeInstanceAttributesRequest req)
                                                              throws TencentCloudSDKException

获取实例属性

参数:: req - DescribeInstanceAttributesRequest
返回:: DescribeInstanceAttributesResponse
抛出:: TencentCloudSDKException

DescribeInstances
```
public DescribeInstancesResponse DescribeInstances(DescribeInstancesRequest req)
                                            throws TencentCloudSDKException
```
本接口（DescribeInstance）用于在用户账户下获取消息队列 CKafka 实例列表

参数:

req - DescribeInstancesRequest

返回:

DescribeInstancesResponse

抛出:

TencentCloudSDKException

DescribeInstancesDetail

public DescribeInstancesDetailResponse DescribeInstancesDetail(DescribeInstancesDetailRequest req)
                                                        throws TencentCloudSDKException

用户账户下获取实例列表详情

参数:: req - DescribeInstancesDetailRequest
返回:: DescribeInstancesDetailResponse
抛出:: TencentCloudSDKException

DescribeTopic
```
public DescribeTopicResponse DescribeTopic(DescribeTopicRequest req)
                                    throws TencentCloudSDKException
```
接口请求域名：https://ckafka.tencentcloudapi.com 本接口（DescribeTopic）用于在用户获取消息队列 CKafka 实例的主题列表

参数:

req - DescribeTopicRequest

返回:

DescribeTopicResponse

抛出:

TencentCloudSDKException

DescribeTopicAttributes

public DescribeTopicAttributesResponse DescribeTopicAttributes(DescribeTopicAttributesRequest req)
                                                        throws TencentCloudSDKException

获取主题属性

参数:: req - DescribeTopicAttributesRequest
返回:: DescribeTopicAttributesResponse
抛出:: TencentCloudSDKException

DescribeTopicDetail

public DescribeTopicDetailResponse DescribeTopicDetail(DescribeTopicDetailRequest req)
                                                throws TencentCloudSDKException

获取主题列表详情（仅控制台调用）

参数:: req - DescribeTopicDetailRequest
返回:: DescribeTopicDetailResponse
抛出:: TencentCloudSDKException

DescribeUser

public DescribeUserResponse DescribeUser(DescribeUserRequest req)
                                  throws TencentCloudSDKException

查询用户信息

参数:: req - DescribeUserRequest
返回:: DescribeUserResponse
抛出:: TencentCloudSDKException

ModifyGroupOffsets

public ModifyGroupOffsetsResponse ModifyGroupOffsets(ModifyGroupOffsetsRequest req)
                                              throws TencentCloudSDKException

设置Groups 消费分组offset

参数:: req - ModifyGroupOffsetsRequest
返回:: ModifyGroupOffsetsResponse
抛出:: TencentCloudSDKException

ModifyInstanceAttributes

public ModifyInstanceAttributesResponse ModifyInstanceAttributes(ModifyInstanceAttributesRequest req)
                                                          throws TencentCloudSDKException

设置实例属性

参数:: req - ModifyInstanceAttributesRequest
返回:: ModifyInstanceAttributesResponse
抛出:: TencentCloudSDKException

ModifyPassword

public ModifyPasswordResponse ModifyPassword(ModifyPasswordRequest req)
                                      throws TencentCloudSDKException

修改密码

参数:: req - ModifyPasswordRequest
返回:: ModifyPasswordResponse
抛出:: TencentCloudSDKException

ModifyTopicAttributes

public ModifyTopicAttributesResponse ModifyTopicAttributes(ModifyTopicAttributesRequest req)
                                                    throws TencentCloudSDKException

本接口用于修改主题属性。

参数:: req - ModifyTopicAttributesRequest
返回:: ModifyTopicAttributesResponse
抛出:: TencentCloudSDKException

类 CkafkaClient

字段概要

从类继承的字段 com.tencentcloudapi.common.AbstractClient

构造器概要

方法概要

从类继承的方法 com.tencentcloudapi.common.AbstractClient

从类继承的方法 java.lang.Object

构造器详细资料

CkafkaClient

CkafkaClient

方法详细资料

CreateAcl

CreatePartition

CreateTopic

CreateTopicIpWhiteList

CreateUser

DeleteAcl

DeleteTopic

DeleteTopicIpWhiteList

DeleteUser

DescribeACL

DescribeAppInfo

DescribeConsumerGroup

DescribeGroup

DescribeGroupInfo

DescribeGroupOffsets

DescribeInstanceAttributes

DescribeInstances

DescribeInstancesDetail

DescribeTopic

DescribeTopicAttributes

DescribeTopicDetail

DescribeUser

ModifyGroupOffsets

ModifyInstanceAttributes

ModifyPassword

ModifyTopicAttributes