DescribeStreamProcessorResponse (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class DescribeStreamProcessorResponse
extends RekognitionResponse
implements ToCopyableBuilder<DescribeStreamProcessorResponse.Builder,DescribeStreamProcessorResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeStreamProcessorResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeStreamProcessorResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeStreamProcessorResponse.Builder`	`builder()`
`Instant`	`creationTimestamp()` Date and time the stream processor was created
`StreamProcessorDataSharingPreference`	`dataSharingPreference()` Shows whether you are sharing data with Rekognition to improve model performance.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasRegionsOfInterest()` For responses, this returns true if the service returned a value for the RegionsOfInterest property.
`StreamProcessorInput`	`input()` Kinesis video stream that provides the source streaming video.
`String`	`kmsKeyId()` The identifier for your AWS Key Management Service key (AWS KMS key).
`Instant`	`lastUpdateTimestamp()` The time, in Unix format, the stream processor was last updated.
`String`	`name()` Name of the stream processor.
`StreamProcessorNotificationChannel`	`notificationChannel()` Returns the value of the NotificationChannel property for this object.
`StreamProcessorOutput`	`output()` Kinesis data stream to which Amazon Rekognition Video puts the analysis results.
`List<RegionOfInterest>`	`regionsOfInterest()` Specifies locations in the frames where Amazon Rekognition checks for objects or people.
`String`	`roleArn()` ARN of the IAM role that allows access to the stream processor.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeStreamProcessorResponse.Builder>`	`serializableBuilderClass()`
`StreamProcessorSettings`	`settings()` Input parameters used in a streaming video analyzed by a stream processor.
`StreamProcessorStatus`	`status()` Current status of the stream processor.
`String`	`statusAsString()` Current status of the stream processor.
`String`	`statusMessage()` Detailed status message about the stream processor.
`String`	`streamProcessorArn()` ARN of the stream processor.
`DescribeStreamProcessorResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.rekognition.model.RekognitionResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    StreamProcessorStatus
  - 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:
    
    StreamProcessorStatus
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeStreamProcessorResponse.Builder,DescribeStreamProcessorResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeStreamProcessorResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.rekognition.model.RekognitionResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

streamProcessorArn

status

statusAsString

statusMessage

creationTimestamp

lastUpdateTimestamp

input

output

roleArn

settings

notificationChannel

kmsKeyId

hasRegionsOfInterest

regionsOfInterest

dataSharingPreference

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields