CkafkaClient (tencentcloud-sdk-java-intl-en 3.0.441 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
`BatchCreateAclResponse`	`BatchCreateAcl(BatchCreateAclRequest req)` This API is used to create ACL policies in batches.
`BatchModifyGroupOffsetsResponse`	`BatchModifyGroupOffsets(BatchModifyGroupOffsetsRequest req)` This API is used to batch modify consumer group offsets.
`BatchModifyTopicAttributesResponse`	`BatchModifyTopicAttributes(BatchModifyTopicAttributesRequest req)` This API is used to batch set topic attributes.
`CreateAclResponse`	`CreateAcl(CreateAclRequest req)` This API is used to add an ACL policy.
`CreateConsumerResponse`	`CreateConsumer(CreateConsumerRequest req)` This API is used to create a consumer group.
`CreatePartitionResponse`	`CreatePartition(CreatePartitionRequest req)` This API is used to add a partition in a topic.
`CreateTopicResponse`	`CreateTopic(CreateTopicRequest req)` This API is used to create a CKafka topic.
`CreateTopicIpWhiteListResponse`	`CreateTopicIpWhiteList(CreateTopicIpWhiteListRequest req)` This API is used to create a topic IP allowlist.
`CreateUserResponse`	`CreateUser(CreateUserRequest req)` This API is used to add a user.
`DeleteAclResponse`	`DeleteAcl(DeleteAclRequest req)` This API is used to delete an ACL.
`DeleteRouteResponse`	`DeleteRoute(DeleteRouteRequest req)` This API is used to delete a route.
`DeleteRouteTriggerTimeResponse`	`DeleteRouteTriggerTime(DeleteRouteTriggerTimeRequest req)` This API is used to modify the delayed trigger time of route deletion.
`DeleteTopicResponse`	`DeleteTopic(DeleteTopicRequest req)` This API is used to delete a CKafka topic.
`DeleteTopicIpWhiteListResponse`	`DeleteTopicIpWhiteList(DeleteTopicIpWhiteListRequest req)` This API is used to delete a topic IP allowlist.
`DeleteUserResponse`	`DeleteUser(DeleteUserRequest req)` This API is used to delete a user.
`DescribeACLResponse`	`DescribeACL(DescribeACLRequest req)` This API is used to enumerate ACLs.
`DescribeAppInfoResponse`	`DescribeAppInfo(DescribeAppInfoRequest req)` This API is used to query the user list.
`DescribeCkafkaZoneResponse`	`DescribeCkafkaZone(DescribeCkafkaZoneRequest req)` This API is used to view the AZ list of Ckafka.
`DescribeConsumerGroupResponse`	`DescribeConsumerGroup(DescribeConsumerGroupRequest req)` This API is used to query consumer group information.
`DescribeGroupResponse`	`DescribeGroup(DescribeGroupRequest req)` This API is used to enumerate consumer groups (simplified).
`DescribeGroupInfoResponse`	`DescribeGroupInfo(DescribeGroupInfoRequest req)` This API is used to get consumer group information.
`DescribeGroupOffsetsResponse`	`DescribeGroupOffsets(DescribeGroupOffsetsRequest req)` This API is used to get the consumer group offset.
`DescribeInstanceAttributesResponse`	`DescribeInstanceAttributes(DescribeInstanceAttributesRequest req)` This API is used to get instance attributes.
`DescribeInstancesResponse`	`DescribeInstances(DescribeInstancesRequest req)` This API is used to get the list of CKafka instances under a user account.
`DescribeInstancesDetailResponse`	`DescribeInstancesDetail(DescribeInstancesDetailRequest req)` This API is used to get instance list details under a user account.
`DescribeRegionResponse`	`DescribeRegion(DescribeRegionRequest req)` This API is used to enumerate regions, and can be called only in Guangzhou.
`DescribeRouteResponse`	`DescribeRoute(DescribeRouteRequest req)` This API is used to view route information.
`DescribeTopicResponse`	`DescribeTopic(DescribeTopicRequest req)` API domain name: https://ckafka.tencentcloudapi.com This API is used to get the list of topics in a CKafka instance of a user.
`DescribeTopicAttributesResponse`	`DescribeTopicAttributes(DescribeTopicAttributesRequest req)` This API is used to get topic attributes.
`DescribeTopicDetailResponse`	`DescribeTopicDetail(DescribeTopicDetailRequest req)` This API is used to get topic list details (only for call in the console).
`DescribeTopicSubscribeGroupResponse`	`DescribeTopicSubscribeGroup(DescribeTopicSubscribeGroupRequest req)` This API is used to search and subscribe the message group information of a topic.
`DescribeTopicSyncReplicaResponse`	`DescribeTopicSyncReplica(DescribeTopicSyncReplicaRequest req)` This API is used to get the details of a synced topic replica.
`DescribeUserResponse`	`DescribeUser(DescribeUserRequest req)` This API is used to query user information.
`FetchMessageByOffsetResponse`	`FetchMessageByOffset(FetchMessageByOffsetRequest req)` This API is used to query messages based on a specified offset position.
`ModifyGroupOffsetsResponse`	`ModifyGroupOffsets(ModifyGroupOffsetsRequest req)` This API is used to set the consumer group (Groups) offset.
`ModifyInstanceAttributesResponse`	`ModifyInstanceAttributes(ModifyInstanceAttributesRequest req)` This API is used to set instance attributes.
`ModifyPasswordResponse`	`ModifyPassword(ModifyPasswordRequest req)` This API is used to change the password.
`ModifyTopicAttributesResponse`	`ModifyTopicAttributes(ModifyTopicAttributesRequest req)` This API is used to modify topic attributes.
`SendMessageResponse`	`SendMessage(SendMessageRequest req)` This API is used to send messages through the HTTP access layer.

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
  - BatchCreateAcl
```
public BatchCreateAclResponse BatchCreateAcl(BatchCreateAclRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to create ACL policies in batches.
    
    Parameters:
    
    req - BatchCreateAclRequest
    
    Returns:
    
    BatchCreateAclResponse
    
    Throws:
    
    TencentCloudSDKException
  - BatchModifyGroupOffsets
```
public BatchModifyGroupOffsetsResponse BatchModifyGroupOffsets(BatchModifyGroupOffsetsRequest req)
                                                        throws TencentCloudSDKException
```
    This API is used to batch modify consumer group offsets.
    
    Parameters:
    
    req - BatchModifyGroupOffsetsRequest
    
    Returns:
    
    BatchModifyGroupOffsetsResponse
    
    Throws:
    
    TencentCloudSDKException
  - BatchModifyTopicAttributes
```
public BatchModifyTopicAttributesResponse BatchModifyTopicAttributes(BatchModifyTopicAttributesRequest req)
                                                              throws TencentCloudSDKException
```
    This API is used to batch set topic attributes.
    
    Parameters:
    
    req - BatchModifyTopicAttributesRequest
    
    Returns:
    
    BatchModifyTopicAttributesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateAcl
```
public CreateAclResponse CreateAcl(CreateAclRequest req)
                            throws TencentCloudSDKException
```
    This API is used to add an ACL policy.
    
    Parameters:
    
    req - CreateAclRequest
    
    Returns:
    
    CreateAclResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateConsumer
```
public CreateConsumerResponse CreateConsumer(CreateConsumerRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to create a consumer group.
    
    Parameters:
    
    req - CreateConsumerRequest
    
    Returns:
    
    CreateConsumerResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreatePartition
```
public CreatePartitionResponse CreatePartition(CreatePartitionRequest req)
                                        throws TencentCloudSDKException
```
    This API is used to add a partition in a topic.
    
    Parameters:
    
    req - CreatePartitionRequest
    
    Returns:
    
    CreatePartitionResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateTopic
```
public CreateTopicResponse CreateTopic(CreateTopicRequest req)
                                throws TencentCloudSDKException
```
    This API is used to create a CKafka topic.
    
    Parameters:
    
    req - CreateTopicRequest
    
    Returns:
    
    CreateTopicResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateTopicIpWhiteList
```
public CreateTopicIpWhiteListResponse CreateTopicIpWhiteList(CreateTopicIpWhiteListRequest req)
                                                      throws TencentCloudSDKException
```
    This API is used to create a topic IP allowlist.
    
    Parameters:
    
    req - CreateTopicIpWhiteListRequest
    
    Returns:
    
    CreateTopicIpWhiteListResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateUser
```
public CreateUserResponse CreateUser(CreateUserRequest req)
                              throws TencentCloudSDKException
```
    This API is used to add a user.
    
    Parameters:
    
    req - CreateUserRequest
    
    Returns:
    
    CreateUserResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteAcl
```
public DeleteAclResponse DeleteAcl(DeleteAclRequest req)
                            throws TencentCloudSDKException
```
    This API is used to delete an ACL.
    
    Parameters:
    
    req - DeleteAclRequest
    
    Returns:
    
    DeleteAclResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteRoute
```
public DeleteRouteResponse DeleteRoute(DeleteRouteRequest req)
                                throws TencentCloudSDKException
```
    This API is used to delete a route.
    
    Parameters:
    
    req - DeleteRouteRequest
    
    Returns:
    
    DeleteRouteResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteRouteTriggerTime
```
public DeleteRouteTriggerTimeResponse DeleteRouteTriggerTime(DeleteRouteTriggerTimeRequest req)
                                                      throws TencentCloudSDKException
```
    This API is used to modify the delayed trigger time of route deletion.
    
    Parameters:
    
    req - DeleteRouteTriggerTimeRequest
    
    Returns:
    
    DeleteRouteTriggerTimeResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteTopic
```
public DeleteTopicResponse DeleteTopic(DeleteTopicRequest req)
                                throws TencentCloudSDKException
```
    This API is used to delete a CKafka topic.
    
    Parameters:
    
    req - DeleteTopicRequest
    
    Returns:
    
    DeleteTopicResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteTopicIpWhiteList
```
public DeleteTopicIpWhiteListResponse DeleteTopicIpWhiteList(DeleteTopicIpWhiteListRequest req)
                                                      throws TencentCloudSDKException
```
    This API is used to delete a topic IP allowlist.
    
    Parameters:
    
    req - DeleteTopicIpWhiteListRequest
    
    Returns:
    
    DeleteTopicIpWhiteListResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteUser
```
public DeleteUserResponse DeleteUser(DeleteUserRequest req)
                              throws TencentCloudSDKException
```
    This API is used to delete a user.
    
    Parameters:
    
    req - DeleteUserRequest
    
    Returns:
    
    DeleteUserResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeACL
```
public DescribeACLResponse DescribeACL(DescribeACLRequest req)
                                throws TencentCloudSDKException
```
    This API is used to enumerate ACLs.
    
    Parameters:
    
    req - DescribeACLRequest
    
    Returns:
    
    DescribeACLResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeAppInfo
```
public DescribeAppInfoResponse DescribeAppInfo(DescribeAppInfoRequest req)
                                        throws TencentCloudSDKException
```
    This API is used to query the user list.
    
    Parameters:
    
    req - DescribeAppInfoRequest
    
    Returns:
    
    DescribeAppInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCkafkaZone
```
public DescribeCkafkaZoneResponse DescribeCkafkaZone(DescribeCkafkaZoneRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to view the AZ list of Ckafka.
    
    Parameters:
    
    req - DescribeCkafkaZoneRequest
    
    Returns:
    
    DescribeCkafkaZoneResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeConsumerGroup
```
public DescribeConsumerGroupResponse DescribeConsumerGroup(DescribeConsumerGroupRequest req)
                                                    throws TencentCloudSDKException
```
    This API is used to query consumer group information.
    
    Parameters:
    
    req - DescribeConsumerGroupRequest
    
    Returns:
    
    DescribeConsumerGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeGroup
```
public DescribeGroupResponse DescribeGroup(DescribeGroupRequest req)
                                    throws TencentCloudSDKException
```
    This API is used to enumerate consumer groups (simplified).
    
    Parameters:
    
    req - DescribeGroupRequest
    
    Returns:
    
    DescribeGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeGroupInfo
```
public DescribeGroupInfoResponse DescribeGroupInfo(DescribeGroupInfoRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to get consumer group information.
    
    Parameters:
    
    req - DescribeGroupInfoRequest
    
    Returns:
    
    DescribeGroupInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeGroupOffsets
```
public DescribeGroupOffsetsResponse DescribeGroupOffsets(DescribeGroupOffsetsRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to get the consumer group offset.
    
    Parameters:
    
    req - DescribeGroupOffsetsRequest
    
    Returns:
    
    DescribeGroupOffsetsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInstanceAttributes
```
public DescribeInstanceAttributesResponse DescribeInstanceAttributes(DescribeInstanceAttributesRequest req)
                                                              throws TencentCloudSDKException
```
    This API is used to get instance attributes.
    
    Parameters:
    
    req - DescribeInstanceAttributesRequest
    
    Returns:
    
    DescribeInstanceAttributesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInstances
```
public DescribeInstancesResponse DescribeInstances(DescribeInstancesRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to get the list of CKafka instances under a user account.
    
    Parameters:
    
    req - DescribeInstancesRequest
    
    Returns:
    
    DescribeInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInstancesDetail
```
public DescribeInstancesDetailResponse DescribeInstancesDetail(DescribeInstancesDetailRequest req)
                                                        throws TencentCloudSDKException
```
    This API is used to get instance list details under a user account.
    
    Parameters:
    
    req - DescribeInstancesDetailRequest
    
    Returns:
    
    DescribeInstancesDetailResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRegion
```
public DescribeRegionResponse DescribeRegion(DescribeRegionRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to enumerate regions, and can be called only in Guangzhou.
    
    Parameters:
    
    req - DescribeRegionRequest
    
    Returns:
    
    DescribeRegionResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRoute
```
public DescribeRouteResponse DescribeRoute(DescribeRouteRequest req)
                                    throws TencentCloudSDKException
```
    This API is used to view route information.
    
    Parameters:
    
    req - DescribeRouteRequest
    
    Returns:
    
    DescribeRouteResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTopic
```
public DescribeTopicResponse DescribeTopic(DescribeTopicRequest req)
                                    throws TencentCloudSDKException
```
    API domain name: https://ckafka.tencentcloudapi.com This API is used to get the list of topics in a CKafka instance of a user.
    
    Parameters:
    
    req - DescribeTopicRequest
    
    Returns:
    
    DescribeTopicResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTopicAttributes
```
public DescribeTopicAttributesResponse DescribeTopicAttributes(DescribeTopicAttributesRequest req)
                                                        throws TencentCloudSDKException
```
    This API is used to get topic attributes.
    
    Parameters:
    
    req - DescribeTopicAttributesRequest
    
    Returns:
    
    DescribeTopicAttributesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTopicDetail
```
public DescribeTopicDetailResponse DescribeTopicDetail(DescribeTopicDetailRequest req)
                                                throws TencentCloudSDKException
```
    This API is used to get topic list details (only for call in the console).
    
    Parameters:
    
    req - DescribeTopicDetailRequest
    
    Returns:
    
    DescribeTopicDetailResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTopicSubscribeGroup
```
public DescribeTopicSubscribeGroupResponse DescribeTopicSubscribeGroup(DescribeTopicSubscribeGroupRequest req)
                                                                throws TencentCloudSDKException
```
    This API is used to search and subscribe the message group information of a topic.
    
    Parameters:
    
    req - DescribeTopicSubscribeGroupRequest
    
    Returns:
    
    DescribeTopicSubscribeGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTopicSyncReplica
```
public DescribeTopicSyncReplicaResponse DescribeTopicSyncReplica(DescribeTopicSyncReplicaRequest req)
                                                          throws TencentCloudSDKException
```
    This API is used to get the details of a synced topic replica.
    
    Parameters:
    
    req - DescribeTopicSyncReplicaRequest
    
    Returns:
    
    DescribeTopicSyncReplicaResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUser
```
public DescribeUserResponse DescribeUser(DescribeUserRequest req)
                                  throws TencentCloudSDKException
```
    This API is used to query user information.
    
    Parameters:
    
    req - DescribeUserRequest
    
    Returns:
    
    DescribeUserResponse
    
    Throws:
    
    TencentCloudSDKException
  - FetchMessageByOffset
```
public FetchMessageByOffsetResponse FetchMessageByOffset(FetchMessageByOffsetRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to query messages based on a specified offset position.
    
    Parameters:
    
    req - FetchMessageByOffsetRequest
    
    Returns:
    
    FetchMessageByOffsetResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyGroupOffsets
```
public ModifyGroupOffsetsResponse ModifyGroupOffsets(ModifyGroupOffsetsRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to set the consumer group (Groups) offset.
    
    Parameters:
    
    req - ModifyGroupOffsetsRequest
    
    Returns:
    
    ModifyGroupOffsetsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyInstanceAttributes
```
public ModifyInstanceAttributesResponse ModifyInstanceAttributes(ModifyInstanceAttributesRequest req)
                                                          throws TencentCloudSDKException
```
    This API is used to set instance attributes.
    
    Parameters:
    
    req - ModifyInstanceAttributesRequest
    
    Returns:
    
    ModifyInstanceAttributesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyPassword
```
public ModifyPasswordResponse ModifyPassword(ModifyPasswordRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to change the password.
    
    Parameters:
    
    req - ModifyPasswordRequest
    
    Returns:
    
    ModifyPasswordResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyTopicAttributes
```
public ModifyTopicAttributesResponse ModifyTopicAttributes(ModifyTopicAttributesRequest req)
                                                    throws TencentCloudSDKException
```
    This API is used to modify topic attributes.
    
    Parameters:
    
    req - ModifyTopicAttributesRequest
    
    Returns:
    
    ModifyTopicAttributesResponse
    
    Throws:
    
    TencentCloudSDKException
  - SendMessage
```
public SendMessageResponse SendMessage(SendMessageRequest req)
                                throws TencentCloudSDKException
```
    This API is used to send messages through the HTTP access layer.
    
    Parameters:
    
    req - SendMessageRequest
    
    Returns:
    
    SendMessageResponse
    
    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

BatchCreateAcl

BatchModifyGroupOffsets

BatchModifyTopicAttributes

CreateAcl

CreateConsumer

CreatePartition

CreateTopic

CreateTopicIpWhiteList

CreateUser

DeleteAcl

DeleteRoute

DeleteRouteTriggerTime

DeleteTopic

DeleteTopicIpWhiteList

DeleteUser

DescribeACL

DescribeAppInfo

DescribeCkafkaZone

DescribeConsumerGroup

DescribeGroup

DescribeGroupInfo

DescribeGroupOffsets

DescribeInstanceAttributes

DescribeInstances

DescribeInstancesDetail

DescribeRegion

DescribeRoute

DescribeTopic

DescribeTopicAttributes

DescribeTopicDetail

DescribeTopicSubscribeGroup

DescribeTopicSyncReplica

DescribeUser

FetchMessageByOffset

ModifyGroupOffsets

ModifyInstanceAttributes

ModifyPassword

ModifyTopicAttributes

SendMessage