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)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
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() Returns true if the Entitlements property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasOutputs() Returns true if the Outputs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSources() Returns true if the Sources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasVpcInterfaces() Returns true if the VpcInterfaces property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() Take this object and create a builder that contains all of the current property values of this object.
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

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()

Returns true if the Entitlements property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasEntitlements() to see if a value was sent in this field.

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.

name

public final String name()

The name of the flow.

Returns:

The name of the flow.

hasOutputs

public final boolean hasOutputs()

Returns true if the Outputs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasOutputs() to see if a value was sent in this field.

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()

Returns true if the Sources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasSources() to see if a value was sent in this field.

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()

Returns true if the VpcInterfaces property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasVpcInterfaces() to see if a value was sent in this field.

Returns:

The VPC Interfaces for this flow.

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

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)

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.