Package software.amazon.awssdk.services.kinesisvideo.model

Class DescribeEdgeConfigurationResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.kinesisvideo.model.KinesisVideoResponse
software.amazon.awssdk.services.kinesisvideo.model.DescribeEdgeConfigurationResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeEdgeConfigurationResponse.Builder,DescribeEdgeConfigurationResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeEdgeConfigurationResponse extends KinesisVideoResponse implements ToCopyableBuilder<DescribeEdgeConfigurationResponse.Builder,DescribeEdgeConfigurationResponse>

  • Method Details

    • streamName

      public final String streamName()

      The name of the stream from which the edge configuration was updated.

      Returns:
      The name of the stream from which the edge configuration was updated.

    • streamARN

      public final String streamARN()

      The Amazon Resource Name (ARN) of the stream.

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

    • creationTime

      public final Instant creationTime()

      The timestamp at which a stream’s edge configuration was first created.

      Returns:
      The timestamp at which a stream’s edge configuration was first created.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The timestamp at which a stream’s edge configuration was last updated.

      Returns:
      The timestamp at which a stream’s edge configuration was last updated.

    • syncStatus

      public final SyncStatus syncStatus()

      The latest status of the edge configuration update.

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

      Returns:
      The latest status of the edge configuration update.
      See Also:

    • syncStatusAsString

      public final String syncStatusAsString()

      The latest status of the edge configuration update.

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

      Returns:
      The latest status of the edge configuration update.
      See Also:

    • failedStatusDetails

      public final String failedStatusDetails()

      A description of the generated failure status.

      Returns:
      A description of the generated failure status.

    • edgeConfig

      public final EdgeConfig edgeConfig()

      A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.

      Returns:
      A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.

    • edgeAgentStatus

      public final EdgeAgentStatus edgeAgentStatus()

      An object that contains the latest status details for an edge agent's recorder and uploader jobs. Use this information to determine the current health of an edge agent.

      Returns:
      An object that contains the latest status details for an edge agent's recorder and uploader jobs. Use this information to determine the current health of an edge agent.

    • toBuilder

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

    • builder

      public static DescribeEdgeConfigurationResponse.Builder builder()

    • serializableBuilderClass

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