Package software.amazon.awssdk.services.rekognition.model

Class StartMediaAnalysisJobRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.rekognition.model.RekognitionRequest
software.amazon.awssdk.services.rekognition.model.StartMediaAnalysisJobRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartMediaAnalysisJobRequest.Builder,StartMediaAnalysisJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartMediaAnalysisJobRequest extends RekognitionRequest implements ToCopyableBuilder<StartMediaAnalysisJobRequest.Builder,StartMediaAnalysisJobRequest>

  • Method Details

    • clientRequestToken

      public final String clientRequestToken()

      Idempotency token used to prevent the accidental creation of duplicate versions. If you use the same token with multiple StartMediaAnalysisJobRequest requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

      Returns:
      Idempotency token used to prevent the accidental creation of duplicate versions. If you use the same token with multiple StartMediaAnalysisJobRequest requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

    • jobName

      public final String jobName()

      The name of the job. Does not have to be unique.

      Returns:
      The name of the job. Does not have to be unique.

    • operationsConfig

      public final MediaAnalysisOperationsConfig operationsConfig()

      Configuration options for the media analysis job to be created.

      Returns:
      Configuration options for the media analysis job to be created.

    • input

      public final MediaAnalysisInput input()

      Input data to be analyzed by the job.

      Returns:
      Input data to be analyzed by the job.

    • outputConfig

      public final MediaAnalysisOutputConfig outputConfig()

      The Amazon S3 bucket location to store the results.

      Returns:
      The Amazon S3 bucket location to store the results.

    • kmsKeyId

      public final String kmsKeyId()

      The identifier of customer managed AWS KMS key (name or ARN). The key is used to encrypt images copied into the service. The key is also used to encrypt results and manifest files written to the output Amazon S3 bucket.

      Returns:
      The identifier of customer managed AWS KMS key (name or ARN). The key is used to encrypt images copied into the service. The key is also used to encrypt results and manifest files written to the output Amazon S3 bucket.

    • toBuilder

      public StartMediaAnalysisJobRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartMediaAnalysisJobRequest.Builder,StartMediaAnalysisJobRequest>
      Specified by:
      toBuilder in class RekognitionRequest
      Returns:
      a builder for type T

    • builder

      public static StartMediaAnalysisJobRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartMediaAnalysisJobRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.