software.amazon.awssdk.services.mediaconnect.model

Class Flow

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

Method Summary

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)
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)
int	hashCode()
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.
Status	status() The current status of the flow.
String	statusAsString() The current status of the flow.
Flow.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

availabilityZone

public 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 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 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.

entitlements

public List<Entitlement> entitlements()

The entitlements in this flow.

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

Returns:

The entitlements in this flow.

flowArn

public 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.

name

public String name()

The name of the flow.

Returns:

The name of the flow.

outputs

public List<Output> outputs()

The outputs in this flow.

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

Returns:

The outputs in this flow.

source

public Source source()

Returns the value of the Source property for this object.

Returns:

The value of the Source property for this object.

status

public 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 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

toBuilder

public Flow.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<Flow.Builder,Flow>

Returns:

a builder for type T

builder

public static Flow.Builder builder()

serializableBuilderClass

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

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.