ImageXServiceImpl (volc-sdk-java 1.0.81 API)

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

All Implemented Interfaces:: IBaseService, IImageXService

public class ImageXServiceImpl
extends BaseServiceImpl
implements IImageXService

Field Summary
- Fields inherited from class com.volcengine.service.BaseServiceImpl
  apiInfoList, serviceInfo

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`FetchImageUrlResponse`	`fetchImageUrl(FetchImageUrlRequest request)` Fetch Image
`GetDeduplicateTaskStatusResponse`	`getDeduplicateTaskStatus(GetDeduplicateTaskStatusRequest req)` Retrieve duplicate detection task status
`GetDenoisingImageResponse`	`getDenoisingImage(GetDenoisingImageRequest req)` Noise reduction
`GetImageBgFillResultResponse`	`getImageBgFillResult(GetImageBgFillResultRequest req)` Extend image
`GetImageComicResultResponse`	`getImageComicResult(GetImageComicResultRequest req)` Comicize an image
`GetImageDuplicateDetectionAsyncResponse`	`getImageDuplicateDetectionAsync(GetImageDuplicateDetectionAsyncRequest req)` Detect duplicate image
`GetImageDuplicateDetectionSyncResponse`	`getImageDuplicateDetectionSync(GetImageDuplicateDetectionSyncRequest req)` Detect duplicate image
`GetImageEnhanceResultResponse`	`getImageEnhanceResult(GetImageEnhanceResultRequest req)` Enhance image
`GetImageEraseModelsResponse`	`getImageEraseModels(GetImageEraseModelsRequest req)` Request ImageX api with method GET.
`GetImageEraseResultResponse`	`getImageEraseResult(GetImageEraseResultRequest req)` Request ImageX api with method POST.
`GetImageOCRResponse<?>`	`getImageOCR(GetImageOCRRequest param)` Request ImageX api with method POST.
`GetImagePSDetectionResponse`	`getImagePSDetection(GetImagePSDetectionRequest req)` Image modified detection
`GetImageQualityResponse`	`getImageQuality(GetImageQualityRequest req)` Get image quality
`GetImageSegmentResponse`	`getImageSegment(GetImageSegmentRequest req)` Request ImageX api with method POST.
`GetImageSmartCropResultResponse`	`getImageSmartCropResult(GetImageSmartCropResultRequest req)` Smart crop
`GetImageStyleResultResponse`	`getImageStyleResult(GetImageStyleResultRequest req)` Image style
`GetImageSuperResolutionResultResponse`	`getImageSuperResolutionResult(GetImageSuperResolutionResultRequest req)` Super resolution
`GetImageUploadFileResponse`	`getImageUploadFile(GetImageUploadFileRequest req)` Resource a file
`GetImageUploadFilesResponse`	`getImageUploadFiles(GetImageUploadFilesRequest req)` List files
`CommonResponse`	`getImageX(String action, Map<String,String> param)` Request ImageX api with method GET.
`static IImageXService`	`getInstance()`
`static IImageXService`	`getInstance(String region)`
`GetLicensePlateDetectionResponse`	`getLicensePlateDetection(GetLicensePlateDetectionRequest req)` License plate detection
`GetPrivateImageTypeResponse`	`getPrivateImageType(GetPrivateImageTypeRequest req)` Private content detection
`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.
`CommitImageUploadResponse`	`uploadImages(ApplyImageUploadRequest request, List<InputStream> content, List<Long> size)` Upload image data.

Methods inherited from class com.volcengine.service.BaseServiceImpl
destroy, getAccessKey, getApiInfoList, getHttpClient, getISigner, getRegion, getSecretKey, getServiceInfo, getSessionToken, getSignUrl, json, post, proto, put, putData, putDataWithResponse, query, setAccessKey, setClientNoReuse, setConnectionTimeout, setHost, setHttpClient, setRegion, setScheme, setSecretKey, setServiceInfo, setSessionToken, setSocketTimeout, signSts2

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

Methods inherited from interface com.volcengine.service.IBaseService
destroy, getAccessKey, getRegion, getSecretKey, getSessionToken, getSignUrl, json, post, proto, put, putData, query, setAccessKey, setClientNoReuse, setConnectionTimeout, setHost, setHttpClient, setRegion, setScheme, setSecretKey, setServiceInfo, setSessionToken, setSocketTimeout, signSts2

- Method Detail
  - getInstance
```
public static IImageXService getInstance()
```
  - getInstance
```
public static IImageXService getInstance(String region)
                                  throws Exception
```
    Throws:
    
    Exception
  - applyImageUpload
```
public ApplyImageUploadResponse applyImageUpload(ApplyImageUploadRequest req)
                                          throws Exception
```
    Description copied from interface: IImageXService
    
    Apply upload image.
    
    Specified by:
    
    applyImageUpload in interface IImageXService
    
    Parameters:
    
    req - the apply upload request
    
    Returns:
    
    the apply upload response
    
    Throws:
    
    Exception - the exception
  - commitImageUpload
```
public CommitImageUploadResponse commitImageUpload(CommitImageUploadRequest req)
                                            throws Exception
```
    Description copied from interface: IImageXService
    
    Commit upload image.
    
    Specified by:
    
    commitImageUpload in interface IImageXService
    
    Parameters:
    
    req - the commit upload request
    
    Returns:
    
    the commit upload response
    
    Throws:
    
    Exception - the exception
  - uploadImages
```
public CommitImageUploadResponse uploadImages(ApplyImageUploadRequest request,
                                              List<byte[]> imageDatas)
                                       throws Exception
```
    Description copied from interface: IImageXService
    
    Upload image data.
    
    Specified by:
    
    uploadImages in interface IImageXService
    
    Parameters:
    
    request - the apply upload request
    
    imageDatas - image data array
    
    Returns:
    
    the commit upload response
    
    Throws:
    
    Exception - the exception
  - uploadImages
```
public CommitImageUploadResponse uploadImages(ApplyImageUploadRequest request,
                                              List<InputStream> content,
                                              List<Long> size)
                                       throws Exception
```
    Description copied from interface: IImageXService
    
    Upload image data.
    
    Specified by:
    
    uploadImages in interface IImageXService
    
    Parameters:
    
    request - upload request
    
    content - image data
    
    size - image size
    
    Returns:
    
    the commit upload response
    
    Throws:
    
    Exception - the exception
  - getUploadToken
```
public String getUploadToken(Map<String,String> params)
                      throws Exception
```
    Description copied from interface: IImageXService
    
    Get image upload token.
    
    Specified by:
    
    getUploadToken in interface IImageXService
    
    Parameters:
    
    params - the params
    
    Returns:
    
    the upload token
    
    Throws:
    
    Exception - the exception
  - getUploadSts2
```
public SecurityToken2 getUploadSts2(List<String> serviceIds)
                             throws Exception
```
    Description copied from interface: IImageXService
    
    Get image upload sts2 auth with default expire time (1 hour).
    
    Specified by:
    
    getUploadSts2 in interface IImageXService
    
    Parameters:
    
    serviceIds - service id list allowed to upload image to
    
    Returns:
    
    the upload sts2 auth
    
    Throws:
    
    Exception - the exception
  - getUploadSts2WithExpire
```
public SecurityToken2 getUploadSts2WithExpire(List<String> serviceIds,
                                              long expire)
                                       throws Exception
```
    Description copied from interface: IImageXService
    
    Get image upload sts2 auth.
    
    Specified by:
    
    getUploadSts2WithExpire in interface IImageXService
    
    Parameters:
    
    serviceIds - service id list allowed to upload image to
    
    expire - expire time in milliseconds
    
    Returns:
    
    the upload sts2 auth
    
    Throws:
    
    Exception - the exception
  - getUploadSts2WithKeyPtn
```
public SecurityToken2 getUploadSts2WithKeyPtn(List<String> serviceIds,
                                              long expire,
                                              String keyPtn)
                                       throws Exception
```
    Description copied from interface: IImageXService
    
    Get image upload sts2 auth.
    
    Specified by:
    
    getUploadSts2WithKeyPtn in interface IImageXService
    
    Parameters:
    
    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.
    
    Returns:
    
    the upload sts2 auth
    
    Throws:
    
    Exception - the exception
  - deleteImages
```
public DeleteImageResp deleteImages(DeleteImageReq req)
                             throws Exception
```
    Description copied from interface: IImageXService
    
    Delete images.
    
    Specified by:
    
    deleteImages in interface IImageXService
    
    Parameters:
    
    req - delete image req
    
    Returns:
    
    delete image resp
    
    Throws:
    
    Exception - the exception
  - getImageUploadFile
```
public GetImageUploadFileResponse getImageUploadFile(GetImageUploadFileRequest req)
                                              throws Exception
```
    Description copied from interface: IImageXService
    
    Resource a file
    
    Specified by:
    
    getImageUploadFile in interface IImageXService
    
    Parameters:
    
    req - args
    
    Returns:
    
    file info
    
    Throws:
    
    Exception - the exception
  - getImageUploadFiles
```
public GetImageUploadFilesResponse getImageUploadFiles(GetImageUploadFilesRequest req)
                                                throws Exception
```
    Description copied from interface: IImageXService
    
    List files
    
    Specified by:
    
    getImageUploadFiles in interface IImageXService
    
    Parameters:
    
    req - args
    
    Returns:
    
    files info
    
    Throws:
    
    Exception - the exception
  - updateImageUrls
```
public UpdateImageFilesResponse updateImageUrls(UpdateImageFilesRequest req)
                                         throws Exception
```
    Description copied from interface: IImageXService
    
    Update image urls.
    
    Specified by:
    
    updateImageUrls in interface IImageXService
    
    Parameters:
    
    req - update image urls req
    
    Returns:
    
    udpate image urls resp
    
    Throws:
    
    Exception - the exception
  - getImageX
```
public CommonResponse getImageX(String action,
                                Map<String,String> param)
                         throws Exception
```
    Description copied from interface: IImageXService
    
    Request ImageX api with method GET.
    
    Specified by:
    
    getImageX in interface IImageXService
    
    Parameters:
    
    action - api action name
    
    param - api query param
    
    Returns:
    
    api response
    
    Throws:
    
    Exception - the exception
  - postImageX
```
public CommonResponse postImageX(String action,
                                 Map<String,String> param,
                                 Object req)
                          throws Exception
```
    Description copied from interface: IImageXService
    
    Request ImageX api with method POST.
    
    Specified by:
    
    postImageX in interface IImageXService
    
    Parameters:
    
    action - api action name
    
    param - api query param
    
    req - api json param
    
    Returns:
    
    api response
    
    Throws:
    
    Exception - the exception
  - fetchImageUrl
```
public FetchImageUrlResponse fetchImageUrl(FetchImageUrlRequest request)
                                    throws Exception
```
    Description copied from interface: IImageXService
    
    Fetch Image
    
    Specified by:
    
    fetchImageUrl in interface IImageXService
    
    Parameters:
    
    request - url to fetch
    
    Returns:
    
    result
    
    Throws:
    
    Exception - the exception
  - getImageOCR
```
public GetImageOCRResponse<?> getImageOCR(GetImageOCRRequest param)
                                   throws Exception
```
    Description copied from interface: IImageXService
    
    Request ImageX api with method POST.
    
    Specified by:
    
    getImageOCR in interface IImageXService
    
    Parameters:
    
    param - api query param
    
    Returns:
    
    api response
    
    Throws:
    
    Exception - the exception
  - embedImageHm
```
public EmbedImageHmResponse embedImageHm(EmbedImageHmRequest req)
                                  throws Exception
```
    Description copied from interface: IImageXService
    
    Request ImageX api with method POST.
    
    Specified by:
    
    embedImageHm in interface IImageXService
    
    Parameters:
    
    req - embed image hm request
    
    Returns:
    
    image store uri
    
    Throws:
    
    Exception - the exception
  - extractImageHm
```
public ExtractImageHmResponse extractImageHm(ExtractImageHmRequest req)
                                      throws Exception
```
    Description copied from interface: IImageXService
    
    Request ImageX api with method POST.
    
    Specified by:
    
    extractImageHm in interface IImageXService
    
    Parameters:
    
    req - extract hidden mark from image
    
    Returns:
    
    embedded info
    
    Throws:
    
    Exception - the exception
  - getImageSegment
```
public GetImageSegmentResponse getImageSegment(GetImageSegmentRequest req)
                                        throws Exception
```
    Description copied from interface: IImageXService
    
    Request ImageX api with method POST.
    
    Specified by:
    
    getImageSegment in interface IImageXService
    
    Parameters:
    
    req - get image segment request
    
    Returns:
    
    image store uri
    
    Throws:
    
    Exception - the exception
  - getImageEraseModels
```
public GetImageEraseModelsResponse getImageEraseModels(GetImageEraseModelsRequest req)
                                                throws Exception
```
    Description copied from interface: IImageXService
    
    Request ImageX api with method GET.
    
    Specified by:
    
    getImageEraseModels in interface IImageXService
    
    Parameters:
    
    req - get image erase models request
    
    Returns:
    
    models array
    
    Throws:
    
    Exception - the exception
  - getImageEraseResult
```
public GetImageEraseResultResponse getImageEraseResult(GetImageEraseResultRequest req)
                                                throws Exception
```
    Description copied from interface: IImageXService
    
    Request ImageX api with method POST.
    
    Specified by:
    
    getImageEraseResult in interface IImageXService
    
    Parameters:
    
    req - get image erase result
    
    Returns:
    
    image store uri
    
    Throws:
    
    Exception - the exception
  - getImageQuality
```
public GetImageQualityResponse getImageQuality(GetImageQualityRequest req)
                                        throws Exception
```
    Description copied from interface: IImageXService
    
    Get image quality
    
    Specified by:
    
    getImageQuality in interface IImageXService
    
    Parameters:
    
    req - request args
    
    Returns:
    
    image quality metrics
    
    Throws:
    
    Exception - the exception
  - getImageBgFillResult
```
public GetImageBgFillResultResponse getImageBgFillResult(GetImageBgFillResultRequest req)
                                                  throws Exception
```
    Description copied from interface: IImageXService
    
    Extend image
    
    Specified by:
    
    getImageBgFillResult in interface IImageXService
    
    Parameters:
    
    req - request args
    
    Returns:
    
    extended image
    
    Throws:
    
    Exception - the exception
  - getImageDuplicateDetectionSync
```
public GetImageDuplicateDetectionSyncResponse getImageDuplicateDetectionSync(GetImageDuplicateDetectionSyncRequest req)
                                                                      throws Exception
```
    Description copied from interface: IImageXService
    
    Detect duplicate image
    
    Specified by:
    
    getImageDuplicateDetectionSync in interface IImageXService
    
    Parameters:
    
    req - request args
    
    Returns:
    
    detection result
    
    Throws:
    
    Exception - the exception
  - getImageDuplicateDetectionAsync
```
public GetImageDuplicateDetectionAsyncResponse getImageDuplicateDetectionAsync(GetImageDuplicateDetectionAsyncRequest req)
                                                                        throws Exception
```
    Description copied from interface: IImageXService
    
    Detect duplicate image
    
    Specified by:
    
    getImageDuplicateDetectionAsync in interface IImageXService
    
    Parameters:
    
    req - request args
    
    Returns:
    
    detection task id
    
    Throws:
    
    Exception - the exception
  - getDeduplicateTaskStatus
```
public GetDeduplicateTaskStatusResponse getDeduplicateTaskStatus(GetDeduplicateTaskStatusRequest req)
                                                          throws Exception
```
    Description copied from interface: IImageXService
    
    Retrieve duplicate detection task status
    
    Specified by:
    
    getDeduplicateTaskStatus in interface IImageXService
    
    Parameters:
    
    req - request args
    
    Returns:
    
    detection status and result
    
    Throws:
    
    Exception - the exception
  - getDenoisingImage
```
public GetDenoisingImageResponse getDenoisingImage(GetDenoisingImageRequest req)
                                            throws Exception
```
    Description copied from interface: IImageXService
    
    Noise reduction
    
    Specified by:
    
    getDenoisingImage in interface IImageXService
    
    Parameters:
    
    req - request args
    
    Returns:
    
    result
    
    Throws:
    
    Exception - the exception
  - getImageComicResult
```
public GetImageComicResultResponse getImageComicResult(GetImageComicResultRequest req)
                                                throws Exception
```
    Description copied from interface: IImageXService
    
    Comicize an image
    
    Specified by:
    
    getImageComicResult in interface IImageXService
    
    Parameters:
    
    req - request args
    
    Returns:
    
    result
    
    Throws:
    
    Exception - the exception
  - getImageSuperResolutionResult
```
public GetImageSuperResolutionResultResponse getImageSuperResolutionResult(GetImageSuperResolutionResultRequest req)
                                                                    throws Exception
```
    Description copied from interface: IImageXService
    
    Super resolution
    
    Specified by:
    
    getImageSuperResolutionResult in interface IImageXService
    
    Parameters:
    
    req - request args
    
    Returns:
    
    result
    
    Throws:
    
    Exception - the exception
  - getImageSmartCropResult
```
public GetImageSmartCropResultResponse getImageSmartCropResult(GetImageSmartCropResultRequest req)
                                                        throws Exception
```
    Description copied from interface: IImageXService
    
    Smart crop
    
    Specified by:
    
    getImageSmartCropResult in interface IImageXService
    
    Parameters:
    
    req - request args
    
    Returns:
    
    result
    
    Throws:
    
    Exception - the exception
  - getLicensePlateDetection
```
public GetLicensePlateDetectionResponse getLicensePlateDetection(GetLicensePlateDetectionRequest req)
                                                          throws Exception
```
    Description copied from interface: IImageXService
    
    License plate detection
    
    Specified by:
    
    getLicensePlateDetection in interface IImageXService
    
    Parameters:
    
    req - request args
    
    Returns:
    
    result
    
    Throws:
    
    Exception - the exception
  - getImagePSDetection
```
public GetImagePSDetectionResponse getImagePSDetection(GetImagePSDetectionRequest req)
                                                throws Exception
```
    Description copied from interface: IImageXService
    
    Image modified detection
    
    Specified by:
    
    getImagePSDetection in interface IImageXService
    
    Parameters:
    
    req - request args
    
    Returns:
    
    result
    
    Throws:
    
    Exception - the exception
  - getPrivateImageType
```
public GetPrivateImageTypeResponse getPrivateImageType(GetPrivateImageTypeRequest req)
                                                throws Exception
```
    Description copied from interface: IImageXService
    
    Private content detection
    
    Specified by:
    
    getPrivateImageType in interface IImageXService
    
    Parameters:
    
    req - request args
    
    Returns:
    
    result
    
    Throws:
    
    Exception - the exception
  - getImageEnhanceResult
```
public GetImageEnhanceResultResponse getImageEnhanceResult(GetImageEnhanceResultRequest req)
                                                    throws Exception
```
    Description copied from interface: IImageXService
    
    Enhance image
    
    Specified by:
    
    getImageEnhanceResult in interface IImageXService
    
    Parameters:
    
    req - request args
    
    Returns:
    
    result
    
    Throws:
    
    Exception - the exception
  - getImageStyleResult
```
public GetImageStyleResultResponse getImageStyleResult(GetImageStyleResultRequest req)
                                                throws Exception
```
    Description copied from interface: IImageXService
    
    Image style
    
    Specified by:
    
    getImageStyleResult in interface IImageXService
    
    Parameters:
    
    req - request args
    
    Returns:
    
    result
    
    Throws:
    
    Exception - the exception

Class ImageXServiceImpl

Field Summary

Fields inherited from class com.volcengine.service.BaseServiceImpl

Method Summary

Methods inherited from class com.volcengine.service.BaseServiceImpl

Methods inherited from class java.lang.Object

Methods inherited from interface com.volcengine.service.IBaseService

Method Detail

getInstance

getInstance

applyImageUpload

commitImageUpload

uploadImages

uploadImages

getUploadToken

getUploadSts2

getUploadSts2WithExpire

getUploadSts2WithKeyPtn

deleteImages

getImageUploadFile

getImageUploadFiles

updateImageUrls

getImageX

postImageX

fetchImageUrl

getImageOCR

embedImageHm

extractImageHm

getImageSegment

getImageEraseModels

getImageEraseResult

getImageQuality

getImageBgFillResult

getImageDuplicateDetectionSync

getImageDuplicateDetectionAsync

getDeduplicateTaskStatus

getDenoisingImage

getImageComicResult

getImageSuperResolutionResult

getImageSmartCropResult

getLicensePlateDetection

getImagePSDetection

getPrivateImageType

getImageEnhanceResult

getImageStyleResult