Flow (AWS Java SDK :: Services :: MediaConnect 2.17.88 API)

java.lang.Object
- software.amazon.awssdk.services.mediaconnect.model.Flow

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Flow.Builder,Flow>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Flow
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Flow.Builder,Flow>
```
The settings for a flow, including its source, outputs, and entitlements.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Flow.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`availabilityZone()` The Availability Zone that you want to create the flow in.
`static Flow.Builder`	`builder()`
`String`	`description()` A description of the flow.
`String`	`egressIp()` The IP address from which video will be sent to output destinations.
`List<Entitlement>`	`entitlements()` The entitlements in this flow.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`flowArn()` The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEntitlements()` For responses, this returns true if the service returned a value for the Entitlements property.
`int`	`hashCode()`
`boolean`	`hasMediaStreams()` For responses, this returns true if the service returned a value for the MediaStreams property.
`boolean`	`hasOutputs()` For responses, this returns true if the service returned a value for the Outputs property.
`boolean`	`hasSources()` For responses, this returns true if the service returned a value for the Sources property.
`boolean`	`hasVpcInterfaces()` For responses, this returns true if the service returned a value for the VpcInterfaces property.
`List<MediaStream>`	`mediaStreams()` The media streams that are associated with the flow.
`String`	`name()` The name of the flow.
`List<Output>`	`outputs()` The outputs in this flow.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Flow.Builder>`	`serializableBuilderClass()`
`Source`	`source()` Returns the value of the Source property for this object.
`FailoverConfig`	`sourceFailoverConfig()` Returns the value of the SourceFailoverConfig property for this object.
`List<Source>`	`sources()` Returns the value of the Sources property for this object.
`Status`	`status()` The current status of the flow.
`String`	`statusAsString()` The current status of the flow.
`Flow.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<VpcInterface>`	`vpcInterfaces()` The VPC Interfaces for this flow.

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
  - availabilityZone
```
public final String availabilityZone()
```
    The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
    
    Returns:
    
    The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
  - description
```
public final String description()
```
    A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
    
    Returns:
    
    A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
  - egressIp
```
public final String egressIp()
```
    The IP address from which video will be sent to output destinations.
    
    Returns:
    
    The IP address from which video will be sent to output destinations.
  - hasEntitlements
```
public final boolean hasEntitlements()
```
    For responses, this returns true if the service returned a value for the Entitlements 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.
  - entitlements
```
public final List<Entitlement> entitlements()
```
    The entitlements in this flow.
    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 hasEntitlements() method.
    
    Returns:
    
    The entitlements in this flow.
  - flowArn
```
public final String flowArn()
```
    The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
    
    Returns:
    
    The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
  - hasMediaStreams
```
public final boolean hasMediaStreams()
```
    For responses, this returns true if the service returned a value for the MediaStreams 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.
  - mediaStreams
```
public final List<MediaStream> mediaStreams()
```
    The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
    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 hasMediaStreams() method.
    
    Returns:
    
    The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
  - name
```
public final String name()
```
    The name of the flow.
    
    Returns:
    
    The name of the flow.
  - hasOutputs
```
public final boolean hasOutputs()
```
    For responses, this returns true if the service returned a value for the Outputs 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.
  - outputs
```
public final List<Output> outputs()
```
    The outputs in this flow.
    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 hasOutputs() method.
    
    Returns:
    
    The outputs in this flow.
  - source
```
public final Source source()
```
    Returns the value of the Source property for this object.
    
    Returns:
    
    The value of the Source property for this object.
  - sourceFailoverConfig
```
public final FailoverConfig sourceFailoverConfig()
```
    Returns the value of the SourceFailoverConfig property for this object.
    
    Returns:
    
    The value of the SourceFailoverConfig property for this object.
  - hasSources
```
public final boolean hasSources()
```
    For responses, this returns true if the service returned a value for the Sources 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.
  - sources
```
public final List<Source> sources()
```
    Returns the value of the Sources property for this object.
    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 hasSources() method.
    
    Returns:
    
    The value of the Sources property for this object.
  - status
```
public final Status status()
```
    The current status of the flow.
    If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the flow.
    
    See Also:
    
    Status
  - statusAsString
```
public final String statusAsString()
```
    The current status of the flow.
    If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the flow.
    
    See Also:
    
    Status
  - hasVpcInterfaces
```
public final boolean hasVpcInterfaces()
```
    For responses, this returns true if the service returned a value for the VpcInterfaces 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.
  - vpcInterfaces
```
public final List<VpcInterface> vpcInterfaces()
```
    The VPC Interfaces for this flow.
    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 hasVpcInterfaces() method.
    
    Returns:
    
    The VPC Interfaces for this flow.
  - toBuilder
```
public Flow.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Flow.Builder,Flow>
  - builder
```
public static Flow.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Flow.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Flow

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

availabilityZone

description

egressIp

hasEntitlements

entitlements

flowArn

hasMediaStreams

mediaStreams

name

hasOutputs

outputs

source

sourceFailoverConfig

hasSources

sources

status

statusAsString

hasVpcInterfaces

vpcInterfaces

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields