Class AzElSegment

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

A time segment containing azimuth elevation pointing data.

Each segment defines a continuous time period with pointing angle data points. AWS Ground Station uses 4th order Lagrange interpolation between the provided points, so each segment must contain at least five data points.

See Also:

  • Method Details

    • referenceEpoch

      public final Instant referenceEpoch()

      The reference time for this segment in ISO 8601 format in Coordinated Universal Time (UTC).

      All time values within the segment's AzElSegment$azElList are specified as offsets in atomic seconds from this reference epoch.

      Example: 2024-01-15T12:00:00.000Z

      Returns:
      The reference time for this segment in ISO 8601 format in Coordinated Universal Time (UTC).

      All time values within the segment's AzElSegment$azElList are specified as offsets in atomic seconds from this reference epoch.

      Example: 2024-01-15T12:00:00.000Z

    • validTimeRange

      public final ISO8601TimeRange validTimeRange()

      The valid time range for this segment.

      Specifies the start and end timestamps in ISO 8601 format in Coordinated Universal Time (UTC). The segment's pointing data must cover this entire time range.

      Returns:
      The valid time range for this segment.

      Specifies the start and end timestamps in ISO 8601 format in Coordinated Universal Time (UTC). The segment's pointing data must cover this entire time range.

    • hasAzElList

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

    • azElList

      public final List<TimeAzEl> azElList()

      List of time-tagged azimuth elevation data points.

      Must contain at least five points to support 4th order Lagrange interpolation. Points must be in chronological order with no duplicates.

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

      Returns:
      List of time-tagged azimuth elevation data points.

      Must contain at least five points to support 4th order Lagrange interpolation. Points must be in chronological order with no duplicates.

    • toBuilder

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

    • builder

      public static AzElSegment.Builder builder()

    • serializableBuilderClass

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