ImageXServiceImpl (volc-sdk-java 1.0.28 API)

java.lang.Object
- com.volcengine.service.BaseServiceImpl
- - com.volcengine.service.imagex.impl.ImageXServiceImpl

所有已实现的接口:: IBaseService, IImageXService

public class ImageXServiceImpl
extends BaseServiceImpl
implements IImageXService

字段概要
- 从类继承的字段 com.volcengine.service.BaseServiceImpl
  apiInfoList, serviceInfo

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`ApplyImageUploadResponse`	`applyImageUpload(ApplyImageUploadRequest req)` Apply upload image.
`CommitImageUploadResponse`	`commitImageUpload(CommitImageUploadRequest req)` 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.
`static IImageXService`	`getInstance()`
`static IImageXService`	`getInstance(String region)`
`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.BaseServiceImpl
getAccessKey, getApiInfoList, getHttpClient, getISigner, getRegion, getSecretKey, getServiceInfo, getSignUrl, json, post, put, putData, putDataWithResponse, query, setAccessKey, setClientNoReuse, setConnectionTimeout, setHost, setHttpClient, setRegion, setScheme, setSecretKey, setServiceInfo, setSocketTimeout, signSts2

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

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

- 方法详细资料
  - getInstance
```
public static IImageXService getInstance()
```
  - getInstance
```
public static IImageXService getInstance(String region)
                                  throws Exception
```
    抛出:
    
    Exception
  - applyImageUpload
```
public ApplyImageUploadResponse applyImageUpload(ApplyImageUploadRequest req)
                                          throws Exception
```
    从接口复制的说明: IImageXService
    
    Apply upload image.
    
    指定者:
    
    applyImageUpload 在接口中 IImageXService
    
    参数:
    
    req - the apply upload request
    
    返回:
    
    the apply upload response
    
    抛出:
    
    Exception - the exception
  - commitImageUpload
```
public CommitImageUploadResponse commitImageUpload(CommitImageUploadRequest req)
                                            throws Exception
```
    从接口复制的说明: IImageXService
    
    Commit upload image.
    
    指定者:
    
    commitImageUpload 在接口中 IImageXService
    
    参数:
    
    req - the commit upload request
    
    返回:
    
    the commit upload response
    
    抛出:
    
    Exception - the exception
  - uploadImages
```
public CommitImageUploadResponse uploadImages(ApplyImageUploadRequest request,
                                              List<byte[]> imageDatas)
                                       throws Exception
```
    从接口复制的说明: IImageXService
    
    Upload image data.
    
    指定者:
    
    uploadImages 在接口中 IImageXService
    
    参数:
    
    request - the apply upload request
    
    imageDatas - image data array
    
    返回:
    
    the commit upload response
    
    抛出:
    
    Exception - the exception
  - getUploadToken
```
public String getUploadToken(Map<String,String> params)
                      throws Exception
```
    从接口复制的说明: IImageXService
    
    Get image upload token.
    
    指定者:
    
    getUploadToken 在接口中 IImageXService
    
    参数:
    
    params - the params
    
    返回:
    
    the upload token
    
    抛出:
    
    Exception - the exception
  - getUploadSts2
```
public SecurityToken2 getUploadSts2(List<String> serviceIds)
                             throws Exception
```
    从接口复制的说明: IImageXService
    
    Get image upload sts2 auth with default expire time (1 hour).
    
    指定者:
    
    getUploadSts2 在接口中 IImageXService
    
    参数:
    
    serviceIds - service id list allowed to upload image to
    
    返回:
    
    the upload sts2 auth
    
    抛出:
    
    Exception - the exception
  - getUploadSts2WithExpire
```
public SecurityToken2 getUploadSts2WithExpire(List<String> serviceIds,
                                              long expire)
                                       throws Exception
```
    从接口复制的说明: IImageXService
    
    Get image upload sts2 auth.
    
    指定者:
    
    getUploadSts2WithExpire 在接口中 IImageXService
    
    参数:
    
    serviceIds - service id list allowed to upload image to
    
    expire - expire time in milliseconds
    
    返回:
    
    the upload sts2 auth
    
    抛出:
    
    Exception - the exception
  - getUploadSts2WithKeyPtn
```
public SecurityToken2 getUploadSts2WithKeyPtn(List<String> serviceIds,
                                              long expire,
                                              String keyPtn)
                                       throws Exception
```
    从接口复制的说明: IImageXService
    
    Get image upload sts2 auth.
    
    指定者:
    
    getUploadSts2WithKeyPtn 在接口中 IImageXService
    
    参数:
    
    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
```
public DeleteImageResp deleteImages(DeleteImageReq req)
                             throws Exception
```
    从接口复制的说明: IImageXService
    
    Delete images.
    
    指定者:
    
    deleteImages 在接口中 IImageXService
    
    参数:
    
    req - delete image req
    
    返回:
    
    delete image resp
    
    抛出:
    
    Exception - the exception
  - updateImageUrls
```
public UpdateImageFilesResponse updateImageUrls(UpdateImageFilesRequest req)
                                         throws Exception
```
    从接口复制的说明: IImageXService
    
    Update image urls.
    
    指定者:
    
    updateImageUrls 在接口中 IImageXService
    
    参数:
    
    req - update image urls req
    
    返回:
    
    udpate image urls resp
    
    抛出:
    
    Exception - the exception
  - getImageX
```
public CommonResponse getImageX(String action,
                                Map<String,String> param)
                         throws Exception
```
    从接口复制的说明: IImageXService
    
    Request ImageX api with method GET.
    
    指定者:
    
    getImageX 在接口中 IImageXService
    
    参数:
    
    action - api action name
    
    param - api query param
    
    返回:
    
    api response
    
    抛出:
    
    Exception - the exception
  - postImageX
```
public CommonResponse postImageX(String action,
                                 Map<String,String> param,
                                 Object req)
                          throws Exception
```
    从接口复制的说明: IImageXService
    
    Request ImageX api with method POST.
    
    指定者:
    
    postImageX 在接口中 IImageXService
    
    参数:
    
    action - api action name
    
    param - api query param
    
    req - api json param
    
    返回:
    
    api response
    
    抛出:
    
    Exception - the exception
  - getImageOCR
```
public GetImageOCRResponse getImageOCR(Map<String,String> param)
                                throws Exception
```
    从接口复制的说明: IImageXService
    
    Request ImageX api with method POST.
    
    指定者:
    
    getImageOCR 在接口中 IImageXService
    
    参数:
    
    param - api query param
    
    返回:
    
    api response
    
    抛出:
    
    Exception - the exception
  - embedImageHm
```
public EmbedImageHmResponse embedImageHm(EmbedImageHmRequest req)
                                  throws Exception
```
    从接口复制的说明: IImageXService
    
    Request ImageX api with method POST.
    
    指定者:
    
    embedImageHm 在接口中 IImageXService
    
    参数:
    
    req - embed image hm request
    
    返回:
    
    image store uri
    
    抛出:
    
    Exception - the exception
  - extractImageHm
```
public ExtractImageHmResponse extractImageHm(ExtractImageHmRequest req)
                                      throws Exception
```
    从接口复制的说明: IImageXService
    
    Request ImageX api with method POST.
    
    指定者:
    
    extractImageHm 在接口中 IImageXService
    
    参数:
    
    req - extract hidden mark from image
    
    返回:
    
    embedded info
    
    抛出:
    
    Exception - the exception

类 ImageXServiceImpl

字段概要

从类继承的字段 com.volcengine.service.BaseServiceImpl

方法概要

从类继承的方法 com.volcengine.service.BaseServiceImpl

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

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

方法详细资料

getInstance

getInstance

applyImageUpload

commitImageUpload

uploadImages

getUploadToken

getUploadSts2

getUploadSts2WithExpire

getUploadSts2WithKeyPtn

deleteImages

updateImageUrls

getImageX

postImageX

getImageOCR

embedImageHm

extractImageHm