Class Flow

java.lang.Object
software.amazon.awssdk.services.mediaconnect.model.Flow
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Flow.Builder,Flow>
@Generated("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:

  • Method Details

    • 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 Amazon Web Services Region.

      Returns:
      The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region.

    • description

      public final String description()

      A description of the flow. This value is not used or seen outside of the current MediaConnect account.

      Returns:
      A description of the flow. This value is not used or seen outside of the current 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) 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 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()

      The source for the flow.

      Returns:
      The source for the flow.

    • sourceFailoverConfig

      public final FailoverConfig sourceFailoverConfig()

      The settings for the source failover.

      Returns:
      The settings for the source failover.

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

      The settings for the sources that are assigned to 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 hasSources() method.

      Returns:
      The settings for the sources that are assigned to the flow.

    • 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:

    • 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:

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

    • maintenance

      public final Maintenance maintenance()

      The maintenance settings for the flow.

      Returns:
      The maintenance settings for the flow.

    • sourceMonitoringConfig

      public final MonitoringConfig sourceMonitoringConfig()

      The settings for source monitoring.

      Returns:
      The settings for source monitoring.

    • flowSize

      public final FlowSize flowSize()

      Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.

      If the service returns an enum value that is not available in the current SDK version, flowSize will return FlowSize.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from flowSizeAsString().

      Returns:
      Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.
      See Also:

    • flowSizeAsString

      public final String flowSizeAsString()

      Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.

      If the service returns an enum value that is not available in the current SDK version, flowSize will return FlowSize.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from flowSizeAsString().

      Returns:
      Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.
      See Also:

    • ndiConfig

      public final NdiConfig ndiConfig()

      Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.

      Returns:
      Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.