Class ChannelInfo

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

A structure that encapsulates a signaling channel's metadata and properties.

See Also:

  • Method Details

    • channelName

      public final String channelName()

      The name of the signaling channel.

      Returns:
      The name of the signaling channel.

    • channelARN

      public final String channelARN()

      The Amazon Resource Name (ARN) of the signaling channel.

      Returns:
      The Amazon Resource Name (ARN) of the signaling channel.

    • channelType

      public final ChannelType channelType()

      The type of the signaling channel.

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

      Returns:
      The type of the signaling channel.
      See Also:

    • channelTypeAsString

      public final String channelTypeAsString()

      The type of the signaling channel.

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

      Returns:
      The type of the signaling channel.
      See Also:

    • channelStatus

      public final Status channelStatus()

      Current status of the signaling channel.

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

      Returns:
      Current status of the signaling channel.
      See Also:

    • channelStatusAsString

      public final String channelStatusAsString()

      Current status of the signaling channel.

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

      Returns:
      Current status of the signaling channel.
      See Also:

    • creationTime

      public final Instant creationTime()

      The time at which the signaling channel was created.

      Returns:
      The time at which the signaling channel was created.

    • singleMasterConfiguration

      public final SingleMasterConfiguration singleMasterConfiguration()

      A structure that contains the configuration for the SINGLE_MASTER channel type.

      Returns:
      A structure that contains the configuration for the SINGLE_MASTER channel type.

    • version

      public final String version()

      The current version of the signaling channel.

      Returns:
      The current version of the signaling channel.

    • toBuilder

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

    • builder

      public static ChannelInfo.Builder builder()

    • serializableBuilderClass

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