CkafkaClient (tencentcloud-sdk-java 3.1.68 API)

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

public class CkafkaClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`CkafkaClient(Credential credential, String region)`
`CkafkaClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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)` 本接口用于修改主题属性。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CkafkaClient

public CkafkaClient(Credential credential,
                    String region)

CkafkaClient

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

Method Detail

CreateAcl

public CreateAclResponse CreateAcl(CreateAclRequest req)
                            throws TencentCloudSDKException

添加 ACL 策略

Parameters:: req - CreateAclRequest
Returns:: CreateAclResponse
Throws:: TencentCloudSDKException

CreatePartition

public CreatePartitionResponse CreatePartition(CreatePartitionRequest req)
                                        throws TencentCloudSDKException

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

Parameters:: req - CreatePartitionRequest
Returns:: CreatePartitionResponse
Throws:: TencentCloudSDKException

CreateTopic

public CreateTopicResponse CreateTopic(CreateTopicRequest req)
                                throws TencentCloudSDKException

创建ckafka主题

Parameters:: req - CreateTopicRequest
Returns:: CreateTopicResponse
Throws:: TencentCloudSDKException

CreateTopicIpWhiteList

public CreateTopicIpWhiteListResponse CreateTopicIpWhiteList(CreateTopicIpWhiteListRequest req)
                                                      throws TencentCloudSDKException

创建主题ip白名单

Parameters:: req - CreateTopicIpWhiteListRequest
Returns:: CreateTopicIpWhiteListResponse
Throws:: TencentCloudSDKException

CreateUser

public CreateUserResponse CreateUser(CreateUserRequest req)
                              throws TencentCloudSDKException

添加用户

Parameters:: req - CreateUserRequest
Returns:: CreateUserResponse
Throws:: TencentCloudSDKException

DeleteAcl

public DeleteAclResponse DeleteAcl(DeleteAclRequest req)
                            throws TencentCloudSDKException

删除ACL

Parameters:: req - DeleteAclRequest
Returns:: DeleteAclResponse
Throws:: TencentCloudSDKException

DeleteTopic

public DeleteTopicResponse DeleteTopic(DeleteTopicRequest req)
                                throws TencentCloudSDKException

删除ckafka主题

Parameters:: req - DeleteTopicRequest
Returns:: DeleteTopicResponse
Throws:: TencentCloudSDKException

DeleteTopicIpWhiteList

public DeleteTopicIpWhiteListResponse DeleteTopicIpWhiteList(DeleteTopicIpWhiteListRequest req)
                                                      throws TencentCloudSDKException

删除主题IP白名单

Parameters:: req - DeleteTopicIpWhiteListRequest
Returns:: DeleteTopicIpWhiteListResponse
Throws:: TencentCloudSDKException

DeleteUser

public DeleteUserResponse DeleteUser(DeleteUserRequest req)
                              throws TencentCloudSDKException

删除用户

Parameters:: req - DeleteUserRequest
Returns:: DeleteUserResponse
Throws:: TencentCloudSDKException

DescribeACL

public DescribeACLResponse DescribeACL(DescribeACLRequest req)
                                throws TencentCloudSDKException

枚举ACL

Parameters:: req - DescribeACLRequest
Returns:: DescribeACLResponse
Throws:: TencentCloudSDKException

DescribeAppInfo

public DescribeAppInfoResponse DescribeAppInfo(DescribeAppInfoRequest req)
                                        throws TencentCloudSDKException

查询用户列表

Parameters:: req - DescribeAppInfoRequest
Returns:: DescribeAppInfoResponse
Throws:: TencentCloudSDKException

DescribeConsumerGroup

public DescribeConsumerGroupResponse DescribeConsumerGroup(DescribeConsumerGroupRequest req)
                                                    throws TencentCloudSDKException

查询消费分组信息

Parameters:: req - DescribeConsumerGroupRequest
Returns:: DescribeConsumerGroupResponse
Throws:: TencentCloudSDKException

DescribeGroup

public DescribeGroupResponse DescribeGroup(DescribeGroupRequest req)
                                    throws TencentCloudSDKException

枚举消费分组(精简版)

Parameters:: req - DescribeGroupRequest
Returns:: DescribeGroupResponse
Throws:: TencentCloudSDKException

DescribeGroupInfo

public DescribeGroupInfoResponse DescribeGroupInfo(DescribeGroupInfoRequest req)
                                            throws TencentCloudSDKException

获取消费分组信息

Parameters:: req - DescribeGroupInfoRequest
Returns:: DescribeGroupInfoResponse
Throws:: TencentCloudSDKException

DescribeGroupOffsets

public DescribeGroupOffsetsResponse DescribeGroupOffsets(DescribeGroupOffsetsRequest req)
                                                  throws TencentCloudSDKException

获取消费分组offset

Parameters:: req - DescribeGroupOffsetsRequest
Returns:: DescribeGroupOffsetsResponse
Throws:: TencentCloudSDKException

DescribeInstanceAttributes

public DescribeInstanceAttributesResponse DescribeInstanceAttributes(DescribeInstanceAttributesRequest req)
                                                              throws TencentCloudSDKException

获取实例属性

Parameters:: req - DescribeInstanceAttributesRequest
Returns:: DescribeInstanceAttributesResponse
Throws:: TencentCloudSDKException

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

Parameters:

req - DescribeInstancesRequest

Returns:

DescribeInstancesResponse

Throws:

TencentCloudSDKException

DescribeInstancesDetail

public DescribeInstancesDetailResponse DescribeInstancesDetail(DescribeInstancesDetailRequest req)
                                                        throws TencentCloudSDKException

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

Parameters:: req - DescribeInstancesDetailRequest
Returns:: DescribeInstancesDetailResponse
Throws:: TencentCloudSDKException

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

Parameters:

req - DescribeTopicRequest

Returns:

DescribeTopicResponse

Throws:

TencentCloudSDKException

DescribeTopicAttributes

public DescribeTopicAttributesResponse DescribeTopicAttributes(DescribeTopicAttributesRequest req)
                                                        throws TencentCloudSDKException

获取主题属性

Parameters:: req - DescribeTopicAttributesRequest
Returns:: DescribeTopicAttributesResponse
Throws:: TencentCloudSDKException

DescribeTopicDetail

public DescribeTopicDetailResponse DescribeTopicDetail(DescribeTopicDetailRequest req)
                                                throws TencentCloudSDKException

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

Parameters:: req - DescribeTopicDetailRequest
Returns:: DescribeTopicDetailResponse
Throws:: TencentCloudSDKException

DescribeUser

public DescribeUserResponse DescribeUser(DescribeUserRequest req)
                                  throws TencentCloudSDKException

查询用户信息

Parameters:: req - DescribeUserRequest
Returns:: DescribeUserResponse
Throws:: TencentCloudSDKException

ModifyGroupOffsets

public ModifyGroupOffsetsResponse ModifyGroupOffsets(ModifyGroupOffsetsRequest req)
                                              throws TencentCloudSDKException

设置Groups 消费分组offset

Parameters:: req - ModifyGroupOffsetsRequest
Returns:: ModifyGroupOffsetsResponse
Throws:: TencentCloudSDKException

ModifyInstanceAttributes

public ModifyInstanceAttributesResponse ModifyInstanceAttributes(ModifyInstanceAttributesRequest req)
                                                          throws TencentCloudSDKException

设置实例属性

Parameters:: req - ModifyInstanceAttributesRequest
Returns:: ModifyInstanceAttributesResponse
Throws:: TencentCloudSDKException

ModifyPassword

public ModifyPasswordResponse ModifyPassword(ModifyPasswordRequest req)
                                      throws TencentCloudSDKException

修改密码

Parameters:: req - ModifyPasswordRequest
Returns:: ModifyPasswordResponse
Throws:: TencentCloudSDKException

ModifyTopicAttributes

public ModifyTopicAttributesResponse ModifyTopicAttributes(ModifyTopicAttributesRequest req)
                                                    throws TencentCloudSDKException

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

Parameters:: req - ModifyTopicAttributesRequest
Returns:: ModifyTopicAttributesResponse
Throws:: TencentCloudSDKException

Class CkafkaClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

CkafkaClient

CkafkaClient

Method Detail

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