Class RouterInput

java.lang.Object
software.amazon.awssdk.services.mediaconnect.model.RouterInput
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RouterInput.Builder,RouterInput>
@Generated("software.amazon.awssdk:codegen") public final class RouterInput extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RouterInput.Builder,RouterInput>

A router input in AWS Elemental MediaConnect. A router input is a source of media content that can be routed to one or more router outputs.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the router input.

      Returns:
      The name of the router input.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the router input.

      Returns:
      The Amazon Resource Name (ARN) of the router input.

    • id

      public final String id()

      The unique identifier of the router input.

      Returns:
      The unique identifier of the router input.

    • state

      public final RouterInputState state()

      The current state of the router input.

      If the service returns an enum value that is not available in the current SDK version, state will return RouterInputState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of the router input.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the router input.

      If the service returns an enum value that is not available in the current SDK version, state will return RouterInputState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of the router input.
      See Also:

    • inputType

      public final RouterInputType inputType()

      The type of the router input.

      If the service returns an enum value that is not available in the current SDK version, inputType will return RouterInputType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputTypeAsString().

      Returns:
      The type of the router input.
      See Also:

    • inputTypeAsString

      public final String inputTypeAsString()

      The type of the router input.

      If the service returns an enum value that is not available in the current SDK version, inputType will return RouterInputType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputTypeAsString().

      Returns:
      The type of the router input.
      See Also:

    • configuration

      public final RouterInputConfiguration configuration()
      Returns the value of the Configuration property for this object.
      Returns:
      The value of the Configuration property for this object.

    • routedOutputs

      public final Integer routedOutputs()

      The number of router outputs associated with the router input.

      Returns:
      The number of router outputs associated with the router input.

    • maximumRoutedOutputs

      public final Integer maximumRoutedOutputs()

      The maximum number of outputs that can be simultaneously routed to this input.

      Returns:
      The maximum number of outputs that can be simultaneously routed to this input.

    • regionName

      public final String regionName()

      The AWS Region where the router input is located.

      Returns:
      The AWS Region where the router input is located.

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone of the router input.

      Returns:
      The Availability Zone of the router input.

    • maximumBitrate

      public final Long maximumBitrate()

      The maximum bitrate for the router input.

      Returns:
      The maximum bitrate for the router input.

    • tier

      public final RouterInputTier tier()

      The tier level of the router input.

      If the service returns an enum value that is not available in the current SDK version, tier will return RouterInputTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tierAsString().

      Returns:
      The tier level of the router input.
      See Also:

    • tierAsString

      public final String tierAsString()

      The tier level of the router input.

      If the service returns an enum value that is not available in the current SDK version, tier will return RouterInputTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tierAsString().

      Returns:
      The tier level of the router input.
      See Also:

    • routingScope

      public final RoutingScope routingScope()

      Indicates whether the router input is configured for Regional or global routing.

      If the service returns an enum value that is not available in the current SDK version, routingScope will return RoutingScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from routingScopeAsString().

      Returns:
      Indicates whether the router input is configured for Regional or global routing.
      See Also:

    • routingScopeAsString

      public final String routingScopeAsString()

      Indicates whether the router input is configured for Regional or global routing.

      If the service returns an enum value that is not available in the current SDK version, routingScope will return RoutingScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from routingScopeAsString().

      Returns:
      Indicates whether the router input is configured for Regional or global routing.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp when the router input was created.

      Returns:
      The timestamp when the router input was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the router input was last updated.

      Returns:
      The timestamp when the router input was last updated.

    • hasMessages

      public final boolean hasMessages()
      For responses, this returns true if the service returned a value for the Messages 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.

    • messages

      public final List<RouterInputMessage> messages()

      The messages associated with the router input.

      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 hasMessages() method.

      Returns:
      The messages associated with the router input.

    • transitEncryption

      public final RouterInputTransitEncryption transitEncryption()
      Returns the value of the TransitEncryption property for this object.
      Returns:
      The value of the TransitEncryption property for this object.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()

      Key-value pairs that can be used to tag and organize this router input.

      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 hasTags() method.

      Returns:
      Key-value pairs that can be used to tag and organize this router input.

    • streamDetails

      public final RouterInputStreamDetails streamDetails()
      Returns the value of the StreamDetails property for this object.
      Returns:
      The value of the StreamDetails property for this object.

    • ipAddress

      public final String ipAddress()

      The IP address of the router input.

      Returns:
      The IP address of the router input.

    • maintenanceType

      public final MaintenanceType maintenanceType()

      The type of maintenance configuration applied to this router input.

      If the service returns an enum value that is not available in the current SDK version, maintenanceType will return MaintenanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maintenanceTypeAsString().

      Returns:
      The type of maintenance configuration applied to this router input.
      See Also:

    • maintenanceTypeAsString

      public final String maintenanceTypeAsString()

      The type of maintenance configuration applied to this router input.

      If the service returns an enum value that is not available in the current SDK version, maintenanceType will return MaintenanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maintenanceTypeAsString().

      Returns:
      The type of maintenance configuration applied to this router input.
      See Also:

    • maintenanceConfiguration

      public final MaintenanceConfiguration maintenanceConfiguration()

      The maintenance configuration settings applied to this router input.

      Returns:
      The maintenance configuration settings applied to this router input.

    • maintenanceScheduleType

      public final MaintenanceScheduleType maintenanceScheduleType()

      The type of maintenance schedule currently in effect for this router input.

      If the service returns an enum value that is not available in the current SDK version, maintenanceScheduleType will return MaintenanceScheduleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maintenanceScheduleTypeAsString().

      Returns:
      The type of maintenance schedule currently in effect for this router input.
      See Also:

    • maintenanceScheduleTypeAsString

      public final String maintenanceScheduleTypeAsString()

      The type of maintenance schedule currently in effect for this router input.

      If the service returns an enum value that is not available in the current SDK version, maintenanceScheduleType will return MaintenanceScheduleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maintenanceScheduleTypeAsString().

      Returns:
      The type of maintenance schedule currently in effect for this router input.
      See Also:

    • maintenanceSchedule

      public final MaintenanceSchedule maintenanceSchedule()

      The current maintenance schedule details for this router input.

      Returns:
      The current maintenance schedule details for this router input.

    • toBuilder

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

    • builder

      public static RouterInput.Builder builder()

    • serializableBuilderClass

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