Class Flow
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Flow.Builder,
Flow>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Availability Zone that you want to create the flow in.static Flow.Builder
builder()
final String
A description of the flow.final String
egressIp()
The IP address from which video will be sent to output destinations.final List
<Entitlement> The entitlements in this flow.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
flowArn()
The Amazon Resource Name (ARN) of the flow.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Entitlements property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MediaStreams property.final boolean
For responses, this returns true if the service returned a value for the Outputs property.final boolean
For responses, this returns true if the service returned a value for the Sources property.final boolean
For responses, this returns true if the service returned a value for the VpcInterfaces property.final Maintenance
Returns the value of the Maintenance property for this object.final List
<MediaStream> The media streams that are associated with the flow.final String
name()
The name of the flow.outputs()
The outputs in this flow.static Class
<? extends Flow.Builder> final Source
source()
Returns the value of the Source property for this object.final FailoverConfig
Returns the value of the SourceFailoverConfig property for this object.sources()
Returns the value of the Sources property for this object.final Status
status()
The current status of the flow.final String
The current status of the flow.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final List
<VpcInterface> The VPC Interfaces for this flow.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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 theisEmpty()
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
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
The Amazon Resource Name (ARN) of the flow.- Returns:
- The Amazon Resource Name (ARN) 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 theisEmpty()
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
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
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 theisEmpty()
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
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
Returns the value of the Source property for this object.- Returns:
- The value of the Source property for this object.
-
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 theisEmpty()
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
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
The current status of the flow.If the service returns an enum value that is not available in the current SDK version,
status
will returnStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the flow.
- See Also:
-
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 returnStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the flow.
- See Also:
-
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 theisEmpty()
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
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.
-
maintenance
Returns the value of the Maintenance property for this object.- Returns:
- The value of the Maintenance property for this object.
-
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 interfaceToCopyableBuilder<Flow.Builder,
Flow> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-