Class EdgeConfig

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

See Also:

  • Method Details

    • hubDeviceArn

      public final String hubDeviceArn()

      The "Internet of Things (IoT) Thing" Arn of the stream.

      Returns:
      The "Internet of Things (IoT) Thing" Arn of the stream.

    • recorderConfig

      public final RecorderConfig recorderConfig()

      The recorder configuration consists of the local MediaSourceConfig details, that are used as credentials to access the local media files streamed on the camera.

      Returns:
      The recorder configuration consists of the local MediaSourceConfig details, that are used as credentials to access the local media files streamed on the camera.

    • uploaderConfig

      public final UploaderConfig uploaderConfig()

      The uploader configuration contains the ScheduleExpression details that are used to schedule upload jobs for the recorded media files from the Edge Agent to a Kinesis Video Stream.

      Returns:
      The uploader configuration contains the ScheduleExpression details that are used to schedule upload jobs for the recorded media files from the Edge Agent to a Kinesis Video Stream.

    • deletionConfig

      public final DeletionConfig deletionConfig()

      The deletion configuration is made up of the retention time (EdgeRetentionInHours) and local size configuration (LocalSizeConfig) details that are used to make the deletion.

      Returns:
      The deletion configuration is made up of the retention time (EdgeRetentionInHours) and local size configuration (LocalSizeConfig) details that are used to make the deletion.

    • toBuilder

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

    • builder

      public static EdgeConfig.Builder builder()

    • serializableBuilderClass

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