Class SdiSourceSummary

java.lang.Object
software.amazon.awssdk.services.medialive.model.SdiSourceSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SdiSourceSummary.Builder,SdiSourceSummary>
@Generated("software.amazon.awssdk:codegen") public final class SdiSourceSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SdiSourceSummary.Builder,SdiSourceSummary>
Used in CreateSdiSourceResponse, DeleteSdiSourceResponse, DescribeSdiSourceResponse, ListSdiSourcesResponse, UpdateSdiSourceResponse
See Also:

  • Method Details

    • arn

      public final String 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

      public final String 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 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.

    • inputs

      public final List<String> 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

      public final SdiSourceMode 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 return SdiSourceMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

      Returns:
      Applies only if the type is QUAD. The mode for handling the quad-link signal QUADRANT or INTERLEAVE.
      See Also:

    • modeAsString

      public final String 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 return SdiSourceMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

      Returns:
      Applies only if the type is QUAD. The mode for handling the quad-link signal QUADRANT or INTERLEAVE.
      See Also:

    • name

      public final String name()
      The name of the SdiSource.
      Returns:
      The name of the SdiSource.

    • state

      public final SdiSourceState 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 return SdiSourceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      Specifies whether the SDI source is attached to an SDI input (IN_USE) or not (IDLE).
      See Also:

    • stateAsString

      public final String 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 return SdiSourceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      Specifies whether the SDI source is attached to an SDI input (IN_USE) or not (IDLE).
      See Also:

    • type

      public final SdiSourceType 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 return SdiSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The value of the Type property for this object.
      See Also:

    • typeAsString

      public final String 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 return SdiSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The value of the Type property for this object.
      See Also:

    • toBuilder

      public SdiSourceSummary.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<SdiSourceSummary.Builder,SdiSourceSummary>
      Returns:
      a builder for type T

    • builder

      public static SdiSourceSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SdiSourceSummary.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.