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

Class StartStreamProcessorRequest

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.StartStreamProcessorRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartStreamProcessorRequest.Builder,StartStreamProcessorRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartStreamProcessorRequest extends RekognitionRequest implements ToCopyableBuilder<StartStreamProcessorRequest.Builder,StartStreamProcessorRequest>

  • Method Details

    • name

      public final String name()

      The name of the stream processor to start processing.

      Returns:
      The name of the stream processor to start processing.

    • startSelector

      public final StreamProcessingStartSelector startSelector()

      Specifies the starting point in the Kinesis stream to start processing. You can use the producer timestamp or the fragment number. If you use the producer timestamp, you must put the time in milliseconds. For more information about fragment numbers, see Fragment.

      This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

      Returns:
      Specifies the starting point in the Kinesis stream to start processing. You can use the producer timestamp or the fragment number. If you use the producer timestamp, you must put the time in milliseconds. For more information about fragment numbers, see Fragment.

      This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

    • stopSelector

      public final StreamProcessingStopSelector stopSelector()

      Specifies when to stop processing the stream. You can specify a maximum amount of time to process the video.

      This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

      Returns:
      Specifies when to stop processing the stream. You can specify a maximum amount of time to process the video.

      This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

    • toBuilder

      public StartStreamProcessorRequest.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<StartStreamProcessorRequest.Builder,StartStreamProcessorRequest>
      Specified by:
      toBuilder in class RekognitionRequest
      Returns:
      a builder for type T

    • builder

      public static StartStreamProcessorRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartStreamProcessorRequest.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.