Class CreateRouterInputRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.mediaconnect.model.MediaConnectRequest
software.amazon.awssdk.services.mediaconnect.model.CreateRouterInputRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateRouterInputRequest.Builder,CreateRouterInputRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateRouterInputRequest extends MediaConnectRequest implements ToCopyableBuilder<CreateRouterInputRequest.Builder,CreateRouterInputRequest>

  • Method Details

    • name

      public final String name()

      The name of the router input.

      Returns:
      The name of the router input.

    • configuration

      public final RouterInputConfiguration configuration()

      The configuration settings for the router input, which can include the protocol, network interface, and other details.

      Returns:
      The configuration settings for the router input, which can include the protocol, network interface, and other details.

    • maximumBitrate

      public final Long maximumBitrate()

      The maximum bitrate for the router input.

      Returns:
      The maximum bitrate for the router input.

    • routingScope

      public final RoutingScope routingScope()

      Specifies whether the router input can be assigned to outputs in different Regions. REGIONAL (default) - connects only to outputs in same Region. GLOBAL - connects to outputs in any Region.

      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:
      Specifies whether the router input can be assigned to outputs in different Regions. REGIONAL (default) - connects only to outputs in same Region. GLOBAL - connects to outputs in any Region.
      See Also:

    • routingScopeAsString

      public final String routingScopeAsString()

      Specifies whether the router input can be assigned to outputs in different Regions. REGIONAL (default) - connects only to outputs in same Region. GLOBAL - connects to outputs in any Region.

      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:
      Specifies whether the router input can be assigned to outputs in different Regions. REGIONAL (default) - connects only to outputs in same Region. GLOBAL - connects to outputs in any Region.
      See Also:

    • tier

      public final RouterInputTier tier()

      The tier level for 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 for the router input.
      See Also:

    • tierAsString

      public final String tierAsString()

      The tier level for 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 for the router input.
      See Also:

    • regionName

      public final String regionName()

      The AWS Region for the router input. Defaults to the current region if not specified.

      Returns:
      The AWS Region for the router input. Defaults to the current region if not specified.

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone where you want to create the router input. This must be a valid Availability Zone for the region specified by regionName, or the current region if no regionName is provided.

      Returns:
      The Availability Zone where you want to create the router input. This must be a valid Availability Zone for the region specified by regionName, or the current region if no regionName is provided.

    • transitEncryption

      public final RouterInputTransitEncryption transitEncryption()

      The transit encryption settings for the router input.

      Returns:
      The transit encryption settings for the router input.

    • maintenanceConfiguration

      public final MaintenanceConfiguration maintenanceConfiguration()

      The maintenance configuration settings for the router input, including preferred maintenance windows and schedules.

      Returns:
      The maintenance configuration settings for the router input, including preferred maintenance windows and schedules.

    • 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.

    • clientToken

      public final String clientToken()

      A unique identifier for the request to ensure idempotency.

      Returns:
      A unique identifier for the request to ensure idempotency.

    • toBuilder

      public CreateRouterInputRequest.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<CreateRouterInputRequest.Builder,CreateRouterInputRequest>
      Specified by:
      toBuilder in class MediaConnectRequest
      Returns:
      a builder for type T

    • builder

      public static CreateRouterInputRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateRouterInputRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.