Source (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.mediaconnect.model.Source

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Source.Builder,Source>

@Generated(value="software.amazon.awssdk:codegen")
public final class Source
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Source.Builder,Source>

The settings for the source of the flow.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Source.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Source.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Source.Builder`	`builder()`
`Integer`	`dataTransferSubscriberFeePercent()` Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
`Encryption`	`decryption()` The type of encryption that is used on the content ingested from this source.
`String`	`description()` A description for the source.
`String`	`entitlementArn()` The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasMediaStreamSourceConfigurations()` For responses, this returns true if the service returned a value for the MediaStreamSourceConfigurations property.
`String`	`ingestIp()` The IP address that the flow will be listening on for incoming content.
`Integer`	`ingestPort()` The port that the flow will be listening on for incoming content.
`List<MediaStreamSourceConfiguration>`	`mediaStreamSourceConfigurations()` The media streams that are associated with the source, and the parameters for those associations.
`String`	`name()` The name of the source.
`List<SdkField<?>>`	`sdkFields()`
`Integer`	`senderControlPort()` The port that the flow uses to send outbound requests to initiate connection with the sender.
`String`	`senderIpAddress()` The IP address that the flow communicates with to initiate connection with the sender.
`static Class<? extends Source.Builder>`	`serializableBuilderClass()`
`String`	`sourceArn()` The ARN of the source.
`Source.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.
`Transport`	`transport()` Attributes related to the transport stream that are used in the source.
`String`	`vpcInterfaceName()` The name of the VPC interface that is used for this source.
`String`	`whitelistCidr()` The range of IP addresses that should be allowed to contribute content to your source.

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
  - dataTransferSubscriberFeePercent
```
public final Integer dataTransferSubscriberFeePercent()
```
    Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
    
    Returns:
    
    Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
  - decryption
```
public final Encryption decryption()
```
    The type of encryption that is used on the content ingested from this source.
    
    Returns:
    
    The type of encryption that is used on the content ingested from this source.
  - description
```
public final String description()
```
    A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
    
    Returns:
    
    A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
  - entitlementArn
```
public final String entitlementArn()
```
    The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
    
    Returns:
    
    The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
  - ingestIp
```
public final String ingestIp()
```
    The IP address that the flow will be listening on for incoming content.
    
    Returns:
    
    The IP address that the flow will be listening on for incoming content.
  - ingestPort
```
public final Integer ingestPort()
```
    The port that the flow will be listening on for incoming content.
    
    Returns:
    
    The port that the flow will be listening on for incoming content.
  - hasMediaStreamSourceConfigurations
```
public final boolean hasMediaStreamSourceConfigurations()
```
    For responses, this returns true if the service returned a value for the MediaStreamSourceConfigurations 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.
  - mediaStreamSourceConfigurations
```
public final List<MediaStreamSourceConfiguration> mediaStreamSourceConfigurations()
```
    The media streams that are associated with the source, 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 hasMediaStreamSourceConfigurations() method.
    
    Returns:
    
    The media streams that are associated with the source, and the parameters for those associations.
  - name
```
public final String name()
```
    The name of the source.
    
    Returns:
    
    The name of the source.
  - senderControlPort
```
public final Integer 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.
  - senderIpAddress
```
public final String senderIpAddress()
```
    The IP address that the flow communicates with to initiate connection with the sender.
    
    Returns:
    
    The IP address that the flow communicates with to initiate connection with the sender.
  - sourceArn
```
public final String sourceArn()
```
    The ARN of the source.
    
    Returns:
    
    The ARN of the source.
  - transport
```
public final Transport transport()
```
    Attributes related to the transport stream that are used in the source.
    
    Returns:
    
    Attributes related to the transport stream that are used in the source.
  - vpcInterfaceName
```
public final String vpcInterfaceName()
```
    The name of the VPC interface that is used for this source.
    
    Returns:
    
    The name of the VPC interface that is used for this source.
  - whitelistCidr
```
public final String whitelistCidr()
```
    The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    
    Returns:
    
    The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
  - toBuilder
```
public Source.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<Source.Builder,Source>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Source.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Source.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.

AWS SDK for Java API Reference - 2.17.113

Class Source

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dataTransferSubscriberFeePercent

decryption

description

entitlementArn

ingestIp

ingestPort

hasMediaStreamSourceConfigurations

mediaStreamSourceConfigurations

name

senderControlPort

senderIpAddress

sourceArn

transport

vpcInterfaceName

whitelistCidr

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields