IImageXService (volc-sdk-java 1.0.28 API)

所有超级接口:

IBaseService

所有已知实现类:

ImageXServiceImpl
```
public interface IImageXService
extends IBaseService
```
The interface ImageX service.

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`ApplyImageUploadResponse`	`applyImageUpload(ApplyImageUploadRequest applyUploadRequest)` Apply upload image.
`CommitImageUploadResponse`	`commitImageUpload(CommitImageUploadRequest commitUploadRequest)` Commit upload image.
`DeleteImageResp`	`deleteImages(DeleteImageReq req)` Delete images.
`EmbedImageHmResponse`	`embedImageHm(EmbedImageHmRequest req)` Request ImageX api with method POST.
`ExtractImageHmResponse`	`extractImageHm(ExtractImageHmRequest req)` Request ImageX api with method POST.
`GetImageOCRResponse`	`getImageOCR(Map<String,String> param)` Request ImageX api with method POST.
`CommonResponse`	`getImageX(String action, Map<String,String> param)` Request ImageX api with method GET.
`SecurityToken2`	`getUploadSts2(List<String> serviceIds)` Get image upload sts2 auth with default expire time (1 hour).
`SecurityToken2`	`getUploadSts2WithExpire(List<String> serviceIds, long expire)` Get image upload sts2 auth.
`SecurityToken2`	`getUploadSts2WithKeyPtn(List<String> serviceIds, long expire, String keyPtn)` Get image upload sts2 auth.
`String`	`getUploadToken(Map<String,String> params)` Get image upload token.
`CommonResponse`	`postImageX(String action, Map<String,String> param, Object req)` Request ImageX api with method POST.
`UpdateImageFilesResponse`	`updateImageUrls(UpdateImageFilesRequest req)` Update image urls.
`CommitImageUploadResponse`	`uploadImages(ApplyImageUploadRequest request, List<byte[]> imageDatas)` Upload image data.

从接口继承的方法 com.volcengine.service.IBaseService
getAccessKey, getRegion, getSecretKey, getSignUrl, json, post, put, putData, query, setAccessKey, setClientNoReuse, setConnectionTimeout, setHost, setHttpClient, setRegion, setScheme, setSecretKey, setServiceInfo, setSocketTimeout, signSts2

- 方法详细资料
  - applyImageUpload
```
ApplyImageUploadResponse applyImageUpload(ApplyImageUploadRequest applyUploadRequest)
                                   throws Exception
```
    Apply upload image.
    
    参数:
    
    applyUploadRequest - the apply upload request
    
    返回:
    
    the apply upload response
    
    抛出:
    
    Exception - the exception
  - commitImageUpload
```
CommitImageUploadResponse commitImageUpload(CommitImageUploadRequest commitUploadRequest)
                                     throws Exception
```
    Commit upload image.
    
    参数:
    
    commitUploadRequest - the commit upload request
    
    返回:
    
    the commit upload response
    
    抛出:
    
    Exception - the exception
  - uploadImages
```
CommitImageUploadResponse uploadImages(ApplyImageUploadRequest request,
                                       List<byte[]> imageDatas)
                                throws Exception
```
    Upload image data.
    
    参数:
    
    request - the apply upload request
    
    imageDatas - image data array
    
    返回:
    
    the commit upload response
    
    抛出:
    
    Exception - the exception
  - getUploadToken
```
String getUploadToken(Map<String,String> params)
               throws Exception
```
    Get image upload token.
    
    参数:
    
    params - the params
    
    返回:
    
    the upload token
    
    抛出:
    
    Exception - the exception
  - getUploadSts2
```
SecurityToken2 getUploadSts2(List<String> serviceIds)
                      throws Exception
```
    Get image upload sts2 auth with default expire time (1 hour).
    
    参数:
    
    serviceIds - service id list allowed to upload image to
    
    返回:
    
    the upload sts2 auth
    
    抛出:
    
    Exception - the exception
  - getUploadSts2WithExpire
```
SecurityToken2 getUploadSts2WithExpire(List<String> serviceIds,
                                       long expire)
                                throws Exception
```
    Get image upload sts2 auth.
    
    参数:
    
    serviceIds - service id list allowed to upload image to
    
    expire - expire time in milliseconds
    
    返回:
    
    the upload sts2 auth
    
    抛出:
    
    Exception - the exception
  - getUploadSts2WithKeyPtn
```
SecurityToken2 getUploadSts2WithKeyPtn(List<String> serviceIds,
                                       long expire,
                                       String keyPtn)
                                throws Exception
```
    Get image upload sts2 auth.
    
    参数:
    
    serviceIds - service id list allowed to upload image to
    
    expire - expire time in milliseconds
    
    keyPtn - upload store key pattern, * for no restriction. default to empty.
    
    返回:
    
    the upload sts2 auth
    
    抛出:
    
    Exception - the exception
  - deleteImages
```
DeleteImageResp deleteImages(DeleteImageReq req)
                      throws Exception
```
    Delete images.
    
    参数:
    
    req - delete image req
    
    返回:
    
    delete image resp
    
    抛出:
    
    Exception - the exception
  - updateImageUrls
```
UpdateImageFilesResponse updateImageUrls(UpdateImageFilesRequest req)
                                  throws Exception
```
    Update image urls.
    
    参数:
    
    req - update image urls req
    
    返回:
    
    udpate image urls resp
    
    抛出:
    
    Exception - the exception
  - getImageX
```
CommonResponse getImageX(String action,
                         Map<String,String> param)
                  throws Exception
```
    Request ImageX api with method GET.
    
    参数:
    
    action - api action name
    
    param - api query param
    
    返回:
    
    api response
    
    抛出:
    
    Exception - the exception
  - postImageX
```
CommonResponse postImageX(String action,
                          Map<String,String> param,
                          Object req)
                   throws Exception
```
    Request ImageX api with method POST.
    
    参数:
    
    action - api action name
    
    param - api query param
    
    req - api json param
    
    返回:
    
    api response
    
    抛出:
    
    Exception - the exception
  - getImageOCR
```
GetImageOCRResponse getImageOCR(Map<String,String> param)
                         throws Exception
```
    Request ImageX api with method POST.
    
    参数:
    
    param - api query param
    
    返回:
    
    api response
    
    抛出:
    
    Exception - the exception
  - embedImageHm
```
EmbedImageHmResponse embedImageHm(EmbedImageHmRequest req)
                           throws Exception
```
    Request ImageX api with method POST.
    
    参数:
    
    req - embed image hm request
    
    返回:
    
    image store uri
    
    抛出:
    
    Exception - the exception
  - extractImageHm
```
ExtractImageHmResponse extractImageHm(ExtractImageHmRequest req)
                               throws Exception
```
    Request ImageX api with method POST.
    
    参数:
    
    req - extract hidden mark from image
    
    返回:
    
    embedded info
    
    抛出:
    
    Exception - the exception

接口 IImageXService

方法概要

从接口继承的方法 com.volcengine.service.IBaseService

方法详细资料

applyImageUpload

commitImageUpload

uploadImages

getUploadToken

getUploadSts2

getUploadSts2WithExpire

getUploadSts2WithKeyPtn

deleteImages

updateImageUrls

getImageX

postImageX

getImageOCR

embedImageHm

extractImageHm