Class AddOutputRequest
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AddOutputRequest.Builder,
AddOutputRequest>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AddOutputRequest.Builder
builder()
The range of IP addresses that should be allowed to initiate output requests to this flow.final String
A description of the output.final String
The IP address from which video will be sent to output destinations.final Encryption
The type of key used for the encryption.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.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 CidrAllowList property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MediaStreamOutputConfigurations property.final Integer
The maximum latency in milliseconds.The media streams that are associated with the output, and the parameters for those associations.final Integer
The minimum latency in milliseconds for SRT-based streams.final String
name()
The name of the output.final Integer
port()
The port to use when content is distributed to this output.final Protocol
protocol()
The protocol to use for the output.final String
The protocol to use for the output.final String
remoteId()
The remote ID for the Zixi-pull output stream.final Integer
The port that the flow uses to send outbound requests to initiate connection with the sender.static Class
<? extends AddOutputRequest.Builder> final Integer
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.final String
streamId()
The stream ID that you want to use for this transport.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 VpcInterfaceAttachment
The name of the VPC interface attachment to use for this output.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasCidrAllowList
public final boolean hasCidrAllowList()For responses, this returns true if the service returned a value for the CidrAllowList 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. -
cidrAllowList
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.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
hasCidrAllowList()
method.- Returns:
- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
-
description
A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.- Returns:
- A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
-
destination
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.
-
encryption
The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.- Returns:
- The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.
-
maxLatency
The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.- Returns:
- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
-
hasMediaStreamOutputConfigurations
public final boolean hasMediaStreamOutputConfigurations()For responses, this returns true if the service returned a value for the MediaStreamOutputConfigurations 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. -
mediaStreamOutputConfigurations
The media streams that are associated with the output, and the parameters for those associations.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
hasMediaStreamOutputConfigurations()
method.- Returns:
- The media streams that are associated with the output, and the parameters for those associations.
-
minLatency
The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.- Returns:
- The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
-
name
The name of the output. This value must be unique within the current flow.- Returns:
- The name of the output. This value must be unique within the current flow.
-
port
The port to use when content is distributed to this output.- Returns:
- The port to use when content is distributed to this output.
-
protocol
The protocol to use for the output.If the service returns an enum value that is not available in the current SDK version,
protocol
will returnProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolAsString()
.- Returns:
- The protocol to use for the output.
- See Also:
-
protocolAsString
The protocol to use for the output.If the service returns an enum value that is not available in the current SDK version,
protocol
will returnProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolAsString()
.- Returns:
- The protocol to use for the output.
- See Also:
-
remoteId
The remote ID for the Zixi-pull output stream.- Returns:
- The remote ID for the Zixi-pull output stream.
-
senderControlPort
The port that the flow uses to send outbound requests to initiate connection with the sender.- Returns:
- The port that the flow uses to send outbound requests to initiate connection with the sender.
-
smoothingLatency
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.- Returns:
- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
-
streamId
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.- Returns:
- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
-
vpcInterfaceAttachment
The name of the VPC interface attachment to use for this output.- Returns:
- The name of the VPC interface attachment to use for this output.
-
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<AddOutputRequest.Builder,
AddOutputRequest> - 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
-