Class KinesisVideoStreamPoolConfiguration

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

The video stream pool configuration object.

See Also:

  • Method Details

    • poolArn

      public final String poolArn()

      The ARN of the video stream pool configuration.

      Returns:
      The ARN of the video stream pool configuration.

    • poolName

      public final String poolName()

      The name of the video stream pool configuration.

      Returns:
      The name of the video stream pool configuration.

    • poolId

      public final String poolId()

      The ID of the video stream pool in the configuration.

      Returns:
      The ID of the video stream pool in the configuration.

    • poolStatus

      public final KinesisVideoStreamPoolStatus poolStatus()

      The status of the video stream pool in the configuration.

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

      Returns:
      The status of the video stream pool in the configuration.
      See Also:

    • poolStatusAsString

      public final String poolStatusAsString()

      The status of the video stream pool in the configuration.

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

      Returns:
      The status of the video stream pool in the configuration.
      See Also:

    • poolSize

      public final Integer poolSize()

      The size of the video stream pool in the configuration.

      Returns:
      The size of the video stream pool in the configuration.

    • streamConfiguration

      public final KinesisVideoStreamConfiguration streamConfiguration()

      The Kinesis video stream pool configuration object.

      Returns:
      The Kinesis video stream pool configuration object.

    • createdTimestamp

      public final Instant createdTimestamp()

      The time at which the configuration was created.

      Returns:
      The time at which the configuration was created.

    • updatedTimestamp

      public final Instant updatedTimestamp()

      The time at which the configuration was updated.

      Returns:
      The time at which the configuration was updated.

    • toBuilder

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

    • builder

      public static KinesisVideoStreamPoolConfiguration.Builder builder()

    • serializableBuilderClass

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