Class DescribeMultiplexResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.medialive.model.MediaLiveResponse
software.amazon.awssdk.services.medialive.model.DescribeMultiplexResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeMultiplexResponse.Builder,DescribeMultiplexResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeMultiplexResponse extends MediaLiveResponse implements ToCopyableBuilder<DescribeMultiplexResponse.Builder,DescribeMultiplexResponse>
Placeholder documentation for DescribeMultiplexResponse

  • Method Details

    • arn

      public final String arn()
      The unique arn of the multiplex.
      Returns:
      The unique arn of the multiplex.

    • hasAvailabilityZones

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

    • availabilityZones

      public final List<String> availabilityZones()
      A list of availability zones for the multiplex.

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

      Returns:
      A list of availability zones for the multiplex.

    • hasDestinations

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

    • destinations

      public final List<MultiplexOutputDestination> destinations()
      A list of the multiplex output destinations.

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

      Returns:
      A list of the multiplex output destinations.

    • id

      public final String id()
      The unique id of the multiplex.
      Returns:
      The unique id of the multiplex.

    • multiplexSettings

      public final MultiplexSettings multiplexSettings()
      Configuration for a multiplex event.
      Returns:
      Configuration for a multiplex event.

    • name

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

    • pipelinesRunningCount

      public final Integer pipelinesRunningCount()
      The number of currently healthy pipelines.
      Returns:
      The number of currently healthy pipelines.

    • programCount

      public final Integer programCount()
      The number of programs in the multiplex.
      Returns:
      The number of programs in the multiplex.

    • state

      public final MultiplexState state()
      The current state of the multiplex.

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

      Returns:
      The current state of the multiplex.
      See Also:

    • stateAsString

      public final String stateAsString()
      The current state of the multiplex.

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

      Returns:
      The current state of the multiplex.
      See Also:

    • 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()
      A collection of key-value pairs.

      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:
      A collection of key-value pairs.

    • toBuilder

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

    • builder

      public static DescribeMultiplexResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.