code.byted.cdp.openapi

Class SegmentationApi

java.lang.Object

code.byted.cdp.openapi.SegmentationApi

public class SegmentationApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SegmentationApi()
SegmentationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
File	downloadSegFile(Integer tenantId, Integer segId, String formatType, Boolean needEncrypt) 分群ID文件下载
com.squareup.okhttp.Call	downloadSegFileAsync(Integer tenantId, Integer segId, String formatType, Boolean needEncrypt, ApiCallback<File> callback) 分群ID文件下载 (asynchronously)
com.squareup.okhttp.Call	downloadSegFileCall(Integer tenantId, Integer segId, String formatType, Boolean needEncrypt, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for downloadSegFile
ApiResponse<File>	downloadSegFileWithHttpInfo(Integer tenantId, Integer segId, String formatType, Boolean needEncrypt) 分群ID文件下载
ApiClient	getApiClient()
ByteDanceResponseRecordSegShardInfoResp	legacyCreateUploadSegment(LegacyUploadedSegCreateRequest body, Integer tenantId) 创建上传分群
com.squareup.okhttp.Call	legacyCreateUploadSegmentAsync(LegacyUploadedSegCreateRequest body, Integer tenantId, ApiCallback<ByteDanceResponseRecordSegShardInfoResp> callback) 创建上传分群 (asynchronously)
com.squareup.okhttp.Call	legacyCreateUploadSegmentCall(LegacyUploadedSegCreateRequest body, Integer tenantId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for legacyCreateUploadSegment
ApiResponse<ByteDanceResponseRecordSegShardInfoResp>	legacyCreateUploadSegmentWithHttpInfo(LegacyUploadedSegCreateRequest body, Integer tenantId) 创建上传分群
ByteDanceResponseSegmentationResp	legacyGetSegment(Integer tenantId, Integer segId) 分群详情
com.squareup.okhttp.Call	legacyGetSegmentAsync(Integer tenantId, Integer segId, ApiCallback<ByteDanceResponseSegmentationResp> callback) 分群详情 (asynchronously)
com.squareup.okhttp.Call	legacyGetSegmentCall(Integer tenantId, Integer segId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for legacyGetSegment
ByteDanceResponseSegmentationListResp	legacyGetSegmentList(Integer tenantId, Integer current, Integer pageSize, String keyword, Boolean isSelfSee, Boolean isOnlySourceReady, String idType, String segTypes, String sourcePlatform, Boolean isAbaseAvailable, Boolean isAbaseEnabled) 分群列表查看，分页
com.squareup.okhttp.Call	legacyGetSegmentListAsync(Integer tenantId, Integer current, Integer pageSize, String keyword, Boolean isSelfSee, Boolean isOnlySourceReady, String idType, String segTypes, String sourcePlatform, Boolean isAbaseAvailable, Boolean isAbaseEnabled, ApiCallback<ByteDanceResponseSegmentationListResp> callback) 分群列表查看，分页 (asynchronously)
com.squareup.okhttp.Call	legacyGetSegmentListCall(Integer tenantId, Integer current, Integer pageSize, String keyword, Boolean isSelfSee, Boolean isOnlySourceReady, String idType, String segTypes, String sourcePlatform, Boolean isAbaseAvailable, Boolean isAbaseEnabled, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for legacyGetSegmentList
ApiResponse<ByteDanceResponseSegmentationListResp>	legacyGetSegmentListWithHttpInfo(Integer tenantId, Integer current, Integer pageSize, String keyword, Boolean isSelfSee, Boolean isOnlySourceReady, String idType, String segTypes, String sourcePlatform, Boolean isAbaseAvailable, Boolean isAbaseEnabled) 分群列表查看，分页
ApiResponse<ByteDanceResponseSegmentationResp>	legacyGetSegmentWithHttpInfo(Integer tenantId, Integer segId) 分群详情
ByteDanceResponseSegmentationOnlineServiceEnableResp	segmentOnlineServiceEnable(ByteDanceResponseSegmentationOnlineServiceEnableReq body, Integer tenantId, Integer segId) 分群在线服务开启/关闭 开启/关闭单个分群的在线服务
com.squareup.okhttp.Call	segmentOnlineServiceEnableAsync(ByteDanceResponseSegmentationOnlineServiceEnableReq body, Integer tenantId, Integer segId, ApiCallback<ByteDanceResponseSegmentationOnlineServiceEnableResp> callback) 分群在线服务开启/关闭 (asynchronously) 开启/关闭单个分群的在线服务
com.squareup.okhttp.Call	segmentOnlineServiceEnableCall(ByteDanceResponseSegmentationOnlineServiceEnableReq body, Integer tenantId, Integer segId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for segmentOnlineServiceEnable
ApiResponse<ByteDanceResponseSegmentationOnlineServiceEnableResp>	segmentOnlineServiceEnableWithHttpInfo(ByteDanceResponseSegmentationOnlineServiceEnableReq body, Integer tenantId, Integer segId) 分群在线服务开启/关闭 开启/关闭单个分群的在线服务
void	setApiClient(ApiClient apiClient)
ByteDanceResponseSegmentationUploadResp	uploadSegFile(File file, Integer tenantId) 上传分群文件
com.squareup.okhttp.Call	uploadSegFileAsync(File file, Integer tenantId, ApiCallback<ByteDanceResponseSegmentationUploadResp> callback) 上传分群文件 (asynchronously)
com.squareup.okhttp.Call	uploadSegFileCall(File file, Integer tenantId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for uploadSegFile
ApiResponse<ByteDanceResponseSegmentationUploadResp>	uploadSegFileWithHttpInfo(File file, Integer tenantId) 上传分群文件

Methods inherited from class java.lang.Object

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

Constructor Detail

SegmentationApi

public SegmentationApi()

SegmentationApi

public SegmentationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

downloadSegFileCall

public com.squareup.okhttp.Call downloadSegFileCall(Integer tenantId,
                                                    Integer segId,
                                                    String formatType,
                                                    Boolean needEncrypt,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for downloadSegFile

Parameters:

tenantId - (required)

segId - (required)

formatType - 文件格式，GZ, TXT, CSV 可选 (required)

needEncrypt - (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

downloadSegFile

public File downloadSegFile(Integer tenantId,
                            Integer segId,
                            String formatType,
                            Boolean needEncrypt)
                     throws ApiException

分群ID文件下载

Parameters:

tenantId - (required)

segId - (required)

formatType - 文件格式，GZ, TXT, CSV 可选 (required)

needEncrypt - (optional)

Returns:

File

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

downloadSegFileWithHttpInfo

public ApiResponse<File> downloadSegFileWithHttpInfo(Integer tenantId,
                                                     Integer segId,
                                                     String formatType,
                                                     Boolean needEncrypt)
                                              throws ApiException

分群ID文件下载

Parameters:

tenantId - (required)

segId - (required)

formatType - 文件格式，GZ, TXT, CSV 可选 (required)

needEncrypt - (optional)

Returns:

ApiResponse<File>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

downloadSegFileAsync

public com.squareup.okhttp.Call downloadSegFileAsync(Integer tenantId,
                                                     Integer segId,
                                                     String formatType,
                                                     Boolean needEncrypt,
                                                     ApiCallback<File> callback)
                                              throws ApiException

分群ID文件下载 (asynchronously)

Parameters:

tenantId - (required)

segId - (required)

formatType - 文件格式，GZ, TXT, CSV 可选 (required)

needEncrypt - (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

legacyCreateUploadSegmentCall

public com.squareup.okhttp.Call legacyCreateUploadSegmentCall(LegacyUploadedSegCreateRequest body,
                                                              Integer tenantId,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException

Build call for legacyCreateUploadSegment

Parameters:

body - (required)

tenantId - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

legacyCreateUploadSegment

public ByteDanceResponseRecordSegShardInfoResp legacyCreateUploadSegment(LegacyUploadedSegCreateRequest body,
                                                                         Integer tenantId)
                                                                  throws ApiException

创建上传分群

Parameters:

body - (required)

tenantId - (required)

Returns:

ByteDanceResponseRecordSegShardInfoResp

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

legacyCreateUploadSegmentWithHttpInfo

public ApiResponse<ByteDanceResponseRecordSegShardInfoResp> legacyCreateUploadSegmentWithHttpInfo(LegacyUploadedSegCreateRequest body,
                                                                                                  Integer tenantId)
                                                                                           throws ApiException

创建上传分群

Parameters:

body - (required)

tenantId - (required)

Returns:

ApiResponse<ByteDanceResponseRecordSegShardInfoResp>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

legacyCreateUploadSegmentAsync

public com.squareup.okhttp.Call legacyCreateUploadSegmentAsync(LegacyUploadedSegCreateRequest body,
                                                               Integer tenantId,
                                                               ApiCallback<ByteDanceResponseRecordSegShardInfoResp> callback)
                                                        throws ApiException

创建上传分群 (asynchronously)

Parameters:

body - (required)

tenantId - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

legacyGetSegmentCall

public com.squareup.okhttp.Call legacyGetSegmentCall(Integer tenantId,
                                                     Integer segId,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for legacyGetSegment

Parameters:

tenantId - (required)

segId - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

legacyGetSegment

public ByteDanceResponseSegmentationResp legacyGetSegment(Integer tenantId,
                                                          Integer segId)
                                                   throws ApiException

分群详情

Parameters:

tenantId - (required)

segId - (required)

Returns:

ByteDanceResponseSegmentationResp

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

legacyGetSegmentWithHttpInfo

public ApiResponse<ByteDanceResponseSegmentationResp> legacyGetSegmentWithHttpInfo(Integer tenantId,
                                                                                   Integer segId)
                                                                            throws ApiException

分群详情

Parameters:

tenantId - (required)

segId - (required)

Returns:

ApiResponse<ByteDanceResponseSegmentationResp>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

legacyGetSegmentAsync

public com.squareup.okhttp.Call legacyGetSegmentAsync(Integer tenantId,
                                                      Integer segId,
                                                      ApiCallback<ByteDanceResponseSegmentationResp> callback)
                                               throws ApiException

分群详情 (asynchronously)

Parameters:

tenantId - (required)

segId - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

legacyGetSegmentListCall

public com.squareup.okhttp.Call legacyGetSegmentListCall(Integer tenantId,
                                                         Integer current,
                                                         Integer pageSize,
                                                         String keyword,
                                                         Boolean isSelfSee,
                                                         Boolean isOnlySourceReady,
                                                         String idType,
                                                         String segTypes,
                                                         String sourcePlatform,
                                                         Boolean isAbaseAvailable,
                                                         Boolean isAbaseEnabled,
                                                         ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException

Build call for legacyGetSegmentList

Parameters:

tenantId - (required)

current - 页码 (optional)

pageSize - 每页大小 (optional)

keyword - 关键词，模糊搜索分群名称和创建人 (optional)

isSelfSee - 是否只看自己创建的 (optional)

isOnlySourceReady - 是否分群就绪的（文件+洞察） (optional)

idType - 实体类型code (optional)

segTypes - 分群类型，逗号分隔，多选 (optional)

sourcePlatform - 来源平台 (optional)

isAbaseAvailable - 筛选在线服务是否可用 (optional)

isAbaseEnabled - 筛选在线服务配置开启 (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

legacyGetSegmentList

public ByteDanceResponseSegmentationListResp legacyGetSegmentList(Integer tenantId,
                                                                  Integer current,
                                                                  Integer pageSize,
                                                                  String keyword,
                                                                  Boolean isSelfSee,
                                                                  Boolean isOnlySourceReady,
                                                                  String idType,
                                                                  String segTypes,
                                                                  String sourcePlatform,
                                                                  Boolean isAbaseAvailable,
                                                                  Boolean isAbaseEnabled)
                                                           throws ApiException

分群列表查看，分页

Parameters:

tenantId - (required)

current - 页码 (optional)

pageSize - 每页大小 (optional)

keyword - 关键词，模糊搜索分群名称和创建人 (optional)

isSelfSee - 是否只看自己创建的 (optional)

isOnlySourceReady - 是否分群就绪的（文件+洞察） (optional)

idType - 实体类型code (optional)

segTypes - 分群类型，逗号分隔，多选 (optional)

sourcePlatform - 来源平台 (optional)

isAbaseAvailable - 筛选在线服务是否可用 (optional)

isAbaseEnabled - 筛选在线服务配置开启 (optional)

Returns:

ByteDanceResponseSegmentationListResp

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

legacyGetSegmentListWithHttpInfo

public ApiResponse<ByteDanceResponseSegmentationListResp> legacyGetSegmentListWithHttpInfo(Integer tenantId,
                                                                                           Integer current,
                                                                                           Integer pageSize,
                                                                                           String keyword,
                                                                                           Boolean isSelfSee,
                                                                                           Boolean isOnlySourceReady,
                                                                                           String idType,
                                                                                           String segTypes,
                                                                                           String sourcePlatform,
                                                                                           Boolean isAbaseAvailable,
                                                                                           Boolean isAbaseEnabled)
                                                                                    throws ApiException

分群列表查看，分页

Parameters:

tenantId - (required)

current - 页码 (optional)

pageSize - 每页大小 (optional)

keyword - 关键词，模糊搜索分群名称和创建人 (optional)

isSelfSee - 是否只看自己创建的 (optional)

isOnlySourceReady - 是否分群就绪的（文件+洞察） (optional)

idType - 实体类型code (optional)

segTypes - 分群类型，逗号分隔，多选 (optional)

sourcePlatform - 来源平台 (optional)

isAbaseAvailable - 筛选在线服务是否可用 (optional)

isAbaseEnabled - 筛选在线服务配置开启 (optional)

Returns:

ApiResponse<ByteDanceResponseSegmentationListResp>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

legacyGetSegmentListAsync

public com.squareup.okhttp.Call legacyGetSegmentListAsync(Integer tenantId,
                                                          Integer current,
                                                          Integer pageSize,
                                                          String keyword,
                                                          Boolean isSelfSee,
                                                          Boolean isOnlySourceReady,
                                                          String idType,
                                                          String segTypes,
                                                          String sourcePlatform,
                                                          Boolean isAbaseAvailable,
                                                          Boolean isAbaseEnabled,
                                                          ApiCallback<ByteDanceResponseSegmentationListResp> callback)
                                                   throws ApiException

分群列表查看，分页 (asynchronously)

Parameters:

tenantId - (required)

current - 页码 (optional)

pageSize - 每页大小 (optional)

keyword - 关键词，模糊搜索分群名称和创建人 (optional)

isSelfSee - 是否只看自己创建的 (optional)

isOnlySourceReady - 是否分群就绪的（文件+洞察） (optional)

idType - 实体类型code (optional)

segTypes - 分群类型，逗号分隔，多选 (optional)

sourcePlatform - 来源平台 (optional)

isAbaseAvailable - 筛选在线服务是否可用 (optional)

isAbaseEnabled - 筛选在线服务配置开启 (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

segmentOnlineServiceEnableCall

public com.squareup.okhttp.Call segmentOnlineServiceEnableCall(ByteDanceResponseSegmentationOnlineServiceEnableReq body,
                                                               Integer tenantId,
                                                               Integer segId,
                                                               ProgressResponseBody.ProgressListener progressListener,
                                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                        throws ApiException

Build call for segmentOnlineServiceEnable

Parameters:

body - (required)

tenantId - (required)

segId - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

segmentOnlineServiceEnable

public ByteDanceResponseSegmentationOnlineServiceEnableResp segmentOnlineServiceEnable(ByteDanceResponseSegmentationOnlineServiceEnableReq body,
                                                                                       Integer tenantId,
                                                                                       Integer segId)
                                                                                throws ApiException

分群在线服务开启/关闭 开启/关闭单个分群的在线服务

Parameters:

body - (required)

tenantId - (required)

segId - (required)

Returns:

ByteDanceResponseSegmentationOnlineServiceEnableResp

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

segmentOnlineServiceEnableWithHttpInfo

public ApiResponse<ByteDanceResponseSegmentationOnlineServiceEnableResp> segmentOnlineServiceEnableWithHttpInfo(ByteDanceResponseSegmentationOnlineServiceEnableReq body,
                                                                                                                Integer tenantId,
                                                                                                                Integer segId)
                                                                                                         throws ApiException

分群在线服务开启/关闭 开启/关闭单个分群的在线服务

Parameters:

body - (required)

tenantId - (required)

segId - (required)

Returns:

ApiResponse<ByteDanceResponseSegmentationOnlineServiceEnableResp>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

segmentOnlineServiceEnableAsync

public com.squareup.okhttp.Call segmentOnlineServiceEnableAsync(ByteDanceResponseSegmentationOnlineServiceEnableReq body,
                                                                Integer tenantId,
                                                                Integer segId,
                                                                ApiCallback<ByteDanceResponseSegmentationOnlineServiceEnableResp> callback)
                                                         throws ApiException

分群在线服务开启/关闭 (asynchronously) 开启/关闭单个分群的在线服务

Parameters:

body - (required)

tenantId - (required)

segId - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

uploadSegFileCall

public com.squareup.okhttp.Call uploadSegFileCall(File file,
                                                  Integer tenantId,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for uploadSegFile

Parameters:

file - (required)

tenantId - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

uploadSegFile

public ByteDanceResponseSegmentationUploadResp uploadSegFile(File file,
                                                             Integer tenantId)
                                                      throws ApiException

上传分群文件

Parameters:

file - (required)

tenantId - (required)

Returns:

ByteDanceResponseSegmentationUploadResp

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

uploadSegFileWithHttpInfo

public ApiResponse<ByteDanceResponseSegmentationUploadResp> uploadSegFileWithHttpInfo(File file,
                                                                                      Integer tenantId)
                                                                               throws ApiException

上传分群文件

Parameters:

file - (required)

tenantId - (required)

Returns:

ApiResponse<ByteDanceResponseSegmentationUploadResp>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

uploadSegFileAsync

public com.squareup.okhttp.Call uploadSegFileAsync(File file,
                                                   Integer tenantId,
                                                   ApiCallback<ByteDanceResponseSegmentationUploadResp> callback)
                                            throws ApiException

上传分群文件 (asynchronously)

Parameters:

file - (required)

tenantId - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object