Flow (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mediaconnect.model.Flow

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Flow
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The settings for a flow, including its source, outputs, and entitlements.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Flow()

Constructors
Constructor and Description
`Flow()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Flow`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAvailabilityZone()` The Availability Zone that you want to create the flow in.
`String`	`getDescription()` A description of the flow.
`String`	`getEgressIp()` The IP address from which video will be sent to output destinations.
`List<Entitlement>`	`getEntitlements()` The entitlements in this flow.
`String`	`getFlowArn()` The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
`String`	`getName()` The name of the flow.
`List<Output>`	`getOutputs()` The outputs in this flow.
`Source`	`getSource()`
`String`	`getStatus()` The current status of the flow.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAvailabilityZone(String availabilityZone)` The Availability Zone that you want to create the flow in.
`void`	`setDescription(String description)` A description of the flow.
`void`	`setEgressIp(String egressIp)` The IP address from which video will be sent to output destinations.
`void`	`setEntitlements(Collection<Entitlement> entitlements)` The entitlements in this flow.
`void`	`setFlowArn(String flowArn)` The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
`void`	`setName(String name)` The name of the flow.
`void`	`setOutputs(Collection<Output> outputs)` The outputs in this flow.
`void`	`setSource(Source source)`
`void`	`setStatus(String status)` The current status of the flow.
`String`	`toString()` Returns a string representation of this object.
`Flow`	`withAvailabilityZone(String availabilityZone)` The Availability Zone that you want to create the flow in.
`Flow`	`withDescription(String description)` A description of the flow.
`Flow`	`withEgressIp(String egressIp)` The IP address from which video will be sent to output destinations.
`Flow`	`withEntitlements(Collection<Entitlement> entitlements)` The entitlements in this flow.
`Flow`	`withEntitlements(Entitlement... entitlements)` The entitlements in this flow.
`Flow`	`withFlowArn(String flowArn)` The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
`Flow`	`withName(String name)` The name of the flow.
`Flow`	`withOutputs(Collection<Output> outputs)` The outputs in this flow.
`Flow`	`withOutputs(Output... outputs)` The outputs in this flow.
`Flow`	`withSource(Source source)`
`Flow`	`withStatus(Status status)` The current status of the flow.
`Flow`	`withStatus(String status)` The current status of the flow.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Flow
```
public Flow()
```
- Method Detail
  - setAvailabilityZone
```
public void setAvailabilityZone(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.
    
    Parameters:
    
    availabilityZone - The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
  - getAvailabilityZone
```
public String getAvailabilityZone()
```
    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.
  - withAvailabilityZone
```
public Flow withAvailabilityZone(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
    
    Parameters:
    
    description - A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
  - getDescription
```
public String getDescription()
```
    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.
  - withDescription
```
public Flow withDescription(String description)
```
    A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
    
    Parameters:
    
    description - A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEgressIp
```
public void setEgressIp(String egressIp)
```
    The IP address from which video will be sent to output destinations.
    
    Parameters:
    
    egressIp - The IP address from which video will be sent to output destinations.
  - getEgressIp
```
public String getEgressIp()
```
    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.
  - withEgressIp
```
public Flow withEgressIp(String egressIp)
```
    The IP address from which video will be sent to output destinations.
    
    Parameters:
    
    egressIp - The IP address from which video will be sent to output destinations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEntitlements
```
public List<Entitlement> getEntitlements()
```
    The entitlements in this flow.
    
    Returns:
    
    The entitlements in this flow.
  - setEntitlements
```
public void setEntitlements(Collection<Entitlement> entitlements)
```
    The entitlements in this flow.
    
    Parameters:
    
    entitlements - The entitlements in this flow.
  - withEntitlements
```
public Flow withEntitlements(Entitlement... entitlements)
```
    The entitlements in this flow.
    NOTE: This method appends the values to the existing list (if any). Use setEntitlements(java.util.Collection) or withEntitlements(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    entitlements - The entitlements in this flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEntitlements
```
public Flow withEntitlements(Collection<Entitlement> entitlements)
```
    The entitlements in this flow.
    
    Parameters:
    
    entitlements - The entitlements in this flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFlowArn
```
public void setFlowArn(String flowArn)
```
    The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
    
    Parameters:
    
    flowArn - The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
  - getFlowArn
```
public String getFlowArn()
```
    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.
  - withFlowArn
```
public Flow withFlowArn(String flowArn)
```
    The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
    
    Parameters:
    
    flowArn - The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the flow.
    
    Parameters:
    
    name - The name of the flow.
  - getName
```
public String getName()
```
    The name of the flow.
    
    Returns:
    
    The name of the flow.
  - withName
```
public Flow withName(String name)
```
    The name of the flow.
    
    Parameters:
    
    name - The name of the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getOutputs
```
public List<Output> getOutputs()
```
    The outputs in this flow.
    
    Returns:
    
    The outputs in this flow.
  - setOutputs
```
public void setOutputs(Collection<Output> outputs)
```
    The outputs in this flow.
    
    Parameters:
    
    outputs - The outputs in this flow.
  - withOutputs
```
public Flow withOutputs(Output... outputs)
```
    The outputs in this flow.
    NOTE: This method appends the values to the existing list (if any). Use setOutputs(java.util.Collection) or withOutputs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    outputs - The outputs in this flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withOutputs
```
public Flow withOutputs(Collection<Output> outputs)
```
    The outputs in this flow.
    
    Parameters:
    
    outputs - The outputs in this flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSource
```
public void setSource(Source source)
```
    Parameters:
    
    source -
  - getSource
```
public Source getSource()
```
    Returns:
  - withSource
```
public Flow withSource(Source source)
```
    Parameters:
    
    source -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current status of the flow.
    
    Parameters:
    
    status - The current status of the flow.
    
    See Also:
    
    Status
  - getStatus
```
public String getStatus()
```
    The current status of the flow.
    
    Returns:
    
    The current status of the flow.
    
    See Also:
    
    Status
  - withStatus
```
public Flow withStatus(String status)
```
    The current status of the flow.
    
    Parameters:
    
    status - The current status of the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Status
  - withStatus
```
public Flow withStatus(Status status)
```
    The current status of the flow.
    
    Parameters:
    
    status - The current status of the flow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Status
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Flow clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Flow

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Flow

Method Detail

setAvailabilityZone

getAvailabilityZone

withAvailabilityZone

setDescription

getDescription

withDescription

setEgressIp

getEgressIp

withEgressIp

getEntitlements

setEntitlements

withEntitlements

withEntitlements

setFlowArn

getFlowArn

withFlowArn

setName

getName

withName

getOutputs

setOutputs

withOutputs

withOutputs

setSource

getSource

withSource

setStatus

getStatus

withStatus

withStatus

toString

equals

hashCode

clone

marshall