Class DescribeStreamProcessorResponse

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

  • Method Details

    • name

      public final String name()

      Name of the stream processor.

      Returns:
      Name of the stream processor.

    • streamProcessorArn

      public final String streamProcessorArn()

      ARN of the stream processor.

      Returns:
      ARN of the stream processor.

    • status

      public final StreamProcessorStatus status()

      Current status of the stream processor.

      If the service returns an enum value that is not available in the current SDK version, status will return StreamProcessorStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Current status of the stream processor.
      See Also:

    • statusAsString

      public final String statusAsString()

      Current status of the stream processor.

      If the service returns an enum value that is not available in the current SDK version, status will return StreamProcessorStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Current status of the stream processor.
      See Also:

    • statusMessage

      public final String statusMessage()

      Detailed status message about the stream processor.

      Returns:
      Detailed status message about the stream processor.

    • creationTimestamp

      public final Instant creationTimestamp()

      Date and time the stream processor was created

      Returns:
      Date and time the stream processor was created

    • lastUpdateTimestamp

      public final Instant lastUpdateTimestamp()

      The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor.

      Returns:
      The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor.

    • input

      public final StreamProcessorInput input()

      Kinesis video stream that provides the source streaming video.

      Returns:
      Kinesis video stream that provides the source streaming video.

    • output

      public final StreamProcessorOutput output()

      Kinesis data stream to which Amazon Rekognition Video puts the analysis results.

      Returns:
      Kinesis data stream to which Amazon Rekognition Video puts the analysis results.

    • roleArn

      public final String roleArn()

      ARN of the IAM role that allows access to the stream processor.

      Returns:
      ARN of the IAM role that allows access to the stream processor.

    • settings

      public final StreamProcessorSettings settings()

      Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

      Returns:
      Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

    • notificationChannel

      public final StreamProcessorNotificationChannel notificationChannel()
      Returns the value of the NotificationChannel property for this object.
      Returns:
      The value of the NotificationChannel property for this object.

    • kmsKeyId

      public final String kmsKeyId()

      The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors.

      Returns:
      The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors.

    • hasRegionsOfInterest

      public final boolean hasRegionsOfInterest()
      For responses, this returns true if the service returned a value for the RegionsOfInterest property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • regionsOfInterest

      public final List<RegionOfInterest> regionsOfInterest()

      Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRegionsOfInterest() method.

      Returns:
      Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.

    • dataSharingPreference

      public final StreamProcessorDataSharingPreference dataSharingPreference()

      Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.

      Returns:
      Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.

    • toBuilder

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

    • builder

      public static DescribeStreamProcessorResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.