Class SdiSource
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SdiSource.Builder,
SdiSource>
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The ARN of this SdiSource.static SdiSource.Builder
builder()
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 int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Inputs property.final String
id()
The ID of the SdiSource.inputs()
The list of inputs that are currently using this SDI source.final SdiSourceMode
mode()
Applies only if the type is QUAD.final String
Applies only if the type is QUAD.final String
name()
The name of the SdiSource.static Class
<? extends SdiSource.Builder> final SdiSourceState
state()
Specifies whether the SDI source is attached to an SDI input (IN_USE) or not (IDLE).final String
Specifies whether the SDI source is attached to an SDI input (IN_USE) or not (IDLE).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 SdiSourceType
type()
Returns the value of the Type property for this object.final String
Returns the value of the Type property for this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The ARN of this SdiSource. It is automatically assigned when the SdiSource is created.- Returns:
- The ARN of this SdiSource. It is automatically assigned when the SdiSource is created.
-
id
The ID of the SdiSource. Unique in the AWS account.The ID is the resource-id portion of the ARN.- Returns:
- The ID of the SdiSource. Unique in the AWS account.The ID is the resource-id portion of the ARN.
-
hasInputs
public final boolean hasInputs()For responses, this returns true if the service returned a value for the Inputs 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. -
inputs
The list of inputs that are currently using this SDI source. This list will be empty if the SdiSource has just been deleted.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
hasInputs()
method.- Returns:
- The list of inputs that are currently using this SDI source. This list will be empty if the SdiSource has just been deleted.
-
mode
Applies only if the type is QUAD. The mode for handling the quad-link signal QUADRANT or INTERLEAVE.If the service returns an enum value that is not available in the current SDK version,
mode
will returnSdiSourceMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- Applies only if the type is QUAD. The mode for handling the quad-link signal QUADRANT or INTERLEAVE.
- See Also:
-
modeAsString
Applies only if the type is QUAD. The mode for handling the quad-link signal QUADRANT or INTERLEAVE.If the service returns an enum value that is not available in the current SDK version,
mode
will returnSdiSourceMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- Applies only if the type is QUAD. The mode for handling the quad-link signal QUADRANT or INTERLEAVE.
- See Also:
-
name
-
state
Specifies whether the SDI source is attached to an SDI input (IN_USE) or not (IDLE).If the service returns an enum value that is not available in the current SDK version,
state
will returnSdiSourceState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- Specifies whether the SDI source is attached to an SDI input (IN_USE) or not (IDLE).
- See Also:
-
stateAsString
Specifies whether the SDI source is attached to an SDI input (IN_USE) or not (IDLE).If the service returns an enum value that is not available in the current SDK version,
state
will returnSdiSourceState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- Specifies whether the SDI source is attached to an SDI input (IN_USE) or not (IDLE).
- See Also:
-
type
Returns the value of the Type property for this object.If the service returns an enum value that is not available in the current SDK version,
type
will returnSdiSourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The value of the Type property for this object.
- See Also:
-
typeAsString
Returns the value of the Type property for this object.If the service returns an enum value that is not available in the current SDK version,
type
will returnSdiSourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The value of the Type property for this object.
- See Also:
-
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<SdiSource.Builder,
SdiSource> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-