DescribeStreamProcessorResponse (AWS SDK for Java

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
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`int`	`hashCode()`
`StreamProcessorInput`	`input()` Kinesis video stream that provides the source streaming video.
`Instant`	`lastUpdateTimestamp()` The time, in Unix format, the stream processor was last updated.
`String`	`name()` Name of the stream processor.
`StreamProcessorOutput`	`output()` Kinesis data stream to which Amazon Rekognition Video puts the analysis results.
`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()` Face recognition input parameters that are being used by the 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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - name
```
public String name()
```
    Name of the stream processor.
    
    Returns:
    
    Name of the stream processor.
  - streamProcessorArn
```
public String streamProcessorArn()
```
    ARN of the stream processor.
    
    Returns:
    
    ARN of the stream processor.
  - status
```
public 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 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 String statusMessage()
```
    Detailed status message about the stream processor.
    
    Returns:
    
    Detailed status message about the stream processor.
  - creationTimestamp
```
public Instant creationTimestamp()
```
    Date and time the stream processor was created
    
    Returns:
    
    Date and time the stream processor was created
  - lastUpdateTimestamp
```
public 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 StreamProcessorInput input()
```
    Kinesis video stream that provides the source streaming video.
    
    Returns:
    
    Kinesis video stream that provides the source streaming video.
  - output
```
public 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 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 StreamProcessorSettings settings()
```
    Face recognition input parameters that are being used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.
    
    Returns:
    
    Face recognition input parameters that are being used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <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 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.

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

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields