Class DescribeEphemerisResponse

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

  • Method Details

    • ephemerisId

      public final String ephemerisId()

      The AWS Ground Station ephemeris ID.

      Returns:
      The AWS Ground Station ephemeris ID.

    • satelliteId

      public final String satelliteId()

      The AWS Ground Station satellite ID associated with ephemeris.

      Returns:
      The AWS Ground Station satellite ID associated with ephemeris.

    • status

      public final EphemerisStatus status()

      The status of the ephemeris.

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

      Returns:
      The status of the ephemeris.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the ephemeris.

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

      Returns:
      The status of the ephemeris.
      See Also:

    • priority

      public final Integer priority()

      A priority score that determines which ephemeris to use when multiple ephemerides overlap.

      Higher numbers take precedence. The default is 1. Must be 1 or greater.

      Returns:
      A priority score that determines which ephemeris to use when multiple ephemerides overlap.

      Higher numbers take precedence. The default is 1. Must be 1 or greater.

    • creationTime

      public final Instant creationTime()

      The time the ephemeris was uploaded in UTC.

      Returns:
      The time the ephemeris was uploaded in UTC.

    • enabled

      public final Boolean enabled()

      Whether or not the ephemeris is enabled.

      Returns:
      Whether or not the ephemeris is enabled.

    • name

      public final String name()

      A name that you can use to identify the ephemeris.

      Returns:
      A name that you can use to identify the ephemeris.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      Tags assigned to an ephemeris.

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

      Returns:
      Tags assigned to an ephemeris.

    • suppliedData

      public final EphemerisTypeDescription suppliedData()

      Supplied ephemeris data.

      Returns:
      Supplied ephemeris data.

    • invalidReason

      public final EphemerisInvalidReason invalidReason()

      Reason that an ephemeris failed validation. Appears only when the status is INVALID.

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

      Returns:
      Reason that an ephemeris failed validation. Appears only when the status is INVALID.
      See Also:

    • invalidReasonAsString

      public final String invalidReasonAsString()

      Reason that an ephemeris failed validation. Appears only when the status is INVALID.

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

      Returns:
      Reason that an ephemeris failed validation. Appears only when the status is INVALID.
      See Also:

    • hasErrorReasons

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

    • errorReasons

      public final List<EphemerisErrorReason> errorReasons()

      Detailed error information for ephemerides with INVALID status.

      Provides specific error codes and messages to help diagnose validation failures.

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

      Returns:
      Detailed error information for ephemerides with INVALID status.

      Provides specific error codes and messages to help diagnose validation failures.

    • toBuilder

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

    • builder

      public static DescribeEphemerisResponse.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.