Interface FaceRecognitionEndpointBuilderFactory.FaceRecognitionEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
Enclosing interface:
FaceRecognitionEndpointBuilderFactory

public static interface FaceRecognitionEndpointBuilderFactory.FaceRecognitionEndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the Huawei Cloud Face Recognition Service (FRS) component.
  • Method Details

    • advanced

    • accessKey

      Access key for the cloud user. The option is a: <code>java.lang.String</code> type. Required: true Group: producer
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder
    • actions

      This param is mandatory when the operation is faceLiveDetection, indicating the action code sequence list. Actions are separated by commas (,). Currently, the following actions are supported: 1: Shake the head to the left. 2: Shake the head to the right. 3: Nod the head. 4: Mouth movement. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      actions - the value to set
      Returns:
      the dsl builder
    • actionTimes

      This param can be used when the operation is faceLiveDetection, indicating the action time array. The length of the array is the same as the number of actions. Each item contains the start time and end time of the action in the corresponding sequence. The unit is the milliseconds from the video start time. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      actionTimes - the value to set
      Returns:
      the dsl builder
    • anotherImageBase64

      default FaceRecognitionEndpointBuilderFactory.FaceRecognitionEndpointBuilder anotherImageBase64(String anotherImageBase64)
      This param can be used when operation is faceVerification, indicating the Base64 character string converted from the other image. It needs to be configured if imageBase64 is set. The image size cannot exceed 10 MB. The image resolution of the narrow sides must be greater than 15 pixels, and that of the wide sides cannot exceed 4096 pixels. The supported image formats include JPG, PNG, and BMP. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      anotherImageBase64 - the value to set
      Returns:
      the dsl builder
    • anotherImageFilePath

      default FaceRecognitionEndpointBuilderFactory.FaceRecognitionEndpointBuilder anotherImageFilePath(String anotherImageFilePath)
      This param can be used when operation is faceVerification, indicating the local file path of the other image. It needs to be configured if imageFilePath is set. Image size cannot exceed 8 MB, and it is recommended that the image size be less than 1 MB. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      anotherImageFilePath - the value to set
      Returns:
      the dsl builder
    • anotherImageUrl

      This param can be used when operation is faceVerification, indicating the URL of the other image. It needs to be configured if imageUrl is set. The options are as follows: 1.HTTP/HTTPS URLs on the public network 2.OBS URLs. To use OBS data, authorization is required, including service authorization, temporary authorization, and anonymous public authorization. For details, see Configuring the Access Permission of OBS. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      anotherImageUrl - the value to set
      Returns:
      the dsl builder
    • endpoint

      Fully qualified Face Recognition service url. Carries higher precedence than region based configuration. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      endpoint - the value to set
      Returns:
      the dsl builder
    • imageBase64

      This param can be used when operation is faceDetection or faceVerification, indicating the Base64 character string converted from an image. Any one of imageBase64, imageUrl and imageFilePath needs to be set, and the priority is imageBase64 imageUrl imageFilePath. The Image size cannot exceed 10 MB. The image resolution of the narrow sides must be greater than 15 pixels, and that of the wide sides cannot exceed 4096 pixels. The supported image formats include JPG, PNG, and BMP. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      imageBase64 - the value to set
      Returns:
      the dsl builder
    • imageFilePath

      This param can be used when operation is faceDetection or faceVerification, indicating the local image file path. Any one of imageBase64, imageUrl and imageFilePath needs to be set, and the priority is imageBase64 imageUrl imageFilePath. Image size cannot exceed 8 MB, and it is recommended that the image size be less than 1 MB. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      imageFilePath - the value to set
      Returns:
      the dsl builder
    • imageUrl

      This param can be used when operation is faceDetection or faceVerification, indicating the URL of an image. Any one of imageBase64, imageUrl and imageFilePath needs to be set, and the priority is imageBase64 imageUrl imageFilePath. The options are as follows: 1.HTTP/HTTPS URLs on the public network 2.OBS URLs. To use OBS data, authorization is required, including service authorization, temporary authorization, and anonymous public authorization. For details, see Configuring the Access Permission of OBS. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      imageUrl - the value to set
      Returns:
      the dsl builder
    • projectId

      Cloud project ID. The option is a: <code>java.lang.String</code> type. Required: true Group: producer
      Parameters:
      projectId - the value to set
      Returns:
      the dsl builder
    • proxyHost

      Proxy server ip/hostname. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder
    • proxyPassword

      Proxy authentication password. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      proxyPassword - the value to set
      Returns:
      the dsl builder
    • proxyPort

      Proxy server port. The option is a: <code>int</code> type. Group: producer
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder
    • proxyPort

      Proxy server port. The option will be converted to a <code>int</code> type. Group: producer
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder
    • proxyUser

      Proxy authentication user. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      proxyUser - the value to set
      Returns:
      the dsl builder
    • region

      Face Recognition service region. Currently only cn-north-1 and cn-north-4 are supported. This is lower precedence than endpoint based configuration. The option is a: <code>java.lang.String</code> type. Required: true Group: producer
      Parameters:
      region - the value to set
      Returns:
      the dsl builder
    • secretKey

      Secret key for the cloud user. The option is a: <code>java.lang.String</code> type. Required: true Group: producer
      Parameters:
      secretKey - the value to set
      Returns:
      the dsl builder
    • serviceKeys

      default FaceRecognitionEndpointBuilderFactory.FaceRecognitionEndpointBuilder serviceKeys(org.apache.camel.component.huaweicloud.common.models.ServiceKeys serviceKeys)
      Configuration object for cloud service authentication. The option is a: <code>org.apache.camel.component.huaweicloud.common.models.ServiceKeys</code> type. Group: producer
      Parameters:
      serviceKeys - the value to set
      Returns:
      the dsl builder
    • serviceKeys

      Configuration object for cloud service authentication. The option will be converted to a <code>org.apache.camel.component.huaweicloud.common.models.ServiceKeys</code> type. Group: producer
      Parameters:
      serviceKeys - the value to set
      Returns:
      the dsl builder
    • videoBase64

      This param can be used when operation is faceLiveDetection, indicating the Base64 character string converted from a video. Any one of videoBase64, videoUrl and videoFilePath needs to be set, and the priority is videoBase64 videoUrl videoFilePath. Requirements are as follows: 1.The video size after Base64 encoding cannot exceed 8 MB. It is recommended that the video file be compressed to 200 KB to 2 MB on the client. 2.The video duration must be 1 to 15 seconds. 3.The recommended frame rate is 10 fps to 30 fps. 4.The encapsulation format can be MP4, AVI, FLV, WEBM, ASF, or MOV. 5.The video encoding format can be H.261, H.263, H.264, HEVC, VC-1, VP8, VP9, or WMV3. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      videoBase64 - the value to set
      Returns:
      the dsl builder
    • videoFilePath

      This param can be used when operation is faceLiveDetection, indicating the local video file path. Any one of videoBase64, videoUrl and videoFilePath needs to be set, and the priority is videoBase64 videoUrl videoFilePath. The video requirements are as follows: 1.The size of a video file cannot exceed 8 MB. It is recommended that the video file be compressed to 200 KB to 2 MB on the client. 2.The video duration must be 1 to 15 seconds. 3.The recommended frame rate is 10 fps to 30 fps. 4.The encapsulation format can be MP4, AVI, FLV, WEBM, ASF, or MOV. 5.The video encoding format can be H.261, H.263, H.264, HEVC, VC-1, VP8, VP9, or WMV3. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      videoFilePath - the value to set
      Returns:
      the dsl builder
    • videoUrl

      This param can be used when operation is faceLiveDetection, indicating the URL of a video. Any one of videoBase64, videoUrl and videoFilePath needs to be set, and the priority is videoBase64 videoUrl videoFilePath. Currently, only the URL of an OBS bucket on HUAWEI CLOUD is supported and FRS must have the permission to read data in the OBS bucket. For details about how to enable the read permission, see Service Authorization. The video requirements are as follows: 1.The video size after Base64 encoding cannot exceed 8 MB. 2.The video duration must be 1 to 15 seconds. 3.The recommended frame rate is 10 fps to 30 fps. 4.The encapsulation format can be MP4, AVI, FLV, WEBM, ASF, or MOV. 5.The video encoding format can be H.261, H.263, H.264, HEVC, VC-1, VP8, VP9, or WMV3. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      videoUrl - the value to set
      Returns:
      the dsl builder
    • ignoreSslVerification

      default FaceRecognitionEndpointBuilderFactory.FaceRecognitionEndpointBuilder ignoreSslVerification(boolean ignoreSslVerification)
      Ignore SSL verification. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      ignoreSslVerification - the value to set
      Returns:
      the dsl builder
    • ignoreSslVerification

      default FaceRecognitionEndpointBuilderFactory.FaceRecognitionEndpointBuilder ignoreSslVerification(String ignoreSslVerification)
      Ignore SSL verification. The option will be converted to a <code>boolean</code> type. Default: false Group: security
      Parameters:
      ignoreSslVerification - the value to set
      Returns:
      the dsl builder