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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribeEphemerisResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeEphemerisResponse.Builderbuilder()InstantcreationTime()The time the ephemeris was uploaded in UTC.Booleanenabled()Whether or not the ephemeris is enabled.StringephemerisId()The AWS Ground Station ephemeris ID.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.EphemerisInvalidReasoninvalidReason()Reason that an ephemeris failed validation.StringinvalidReasonAsString()Reason that an ephemeris failed validation.Stringname()A name string associated with the ephemeris.Integerpriority()Customer-provided priority score to establish the order in which overlapping ephemerides should be used.StringsatelliteId()The AWS Ground Station satellite ID associated with ephemeris.List<SdkField<?>>sdkFields()static Class<? extends DescribeEphemerisResponse.Builder>serializableBuilderClass()EphemerisStatusstatus()The status of the ephemeris.StringstatusAsString()The status of the ephemeris.EphemerisTypeDescriptionsuppliedData()Supplied ephemeris data.Map<String,String>tags()Tags assigned to an ephemeris.DescribeEphemerisResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.groundstation.model.GroundStationResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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.
-
ephemerisId
public final String ephemerisId()
The AWS Ground Station ephemeris ID.
- Returns:
- The AWS Ground Station ephemeris ID.
-
invalidReason
public final EphemerisInvalidReason invalidReason()
Reason that an ephemeris failed validation. Only provided for ephemerides with
INVALIDstatus.If the service returns an enum value that is not available in the current SDK version,
invalidReasonwill returnEphemerisInvalidReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominvalidReasonAsString().- Returns:
- Reason that an ephemeris failed validation. Only provided for ephemerides with
INVALIDstatus. - See Also:
EphemerisInvalidReason
-
invalidReasonAsString
public final String invalidReasonAsString()
Reason that an ephemeris failed validation. Only provided for ephemerides with
INVALIDstatus.If the service returns an enum value that is not available in the current SDK version,
invalidReasonwill returnEphemerisInvalidReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominvalidReasonAsString().- Returns:
- Reason that an ephemeris failed validation. Only provided for ephemerides with
INVALIDstatus. - See Also:
EphemerisInvalidReason
-
name
public final String name()
A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
- Returns:
- A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
-
priority
public final Integer priority()
Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
- Returns:
- Customer-provided priority score to establish the order in which overlapping ephemerides should be
used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
-
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,
statuswill returnEphemerisStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the ephemeris.
- See Also:
EphemerisStatus
-
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,
statuswill returnEphemerisStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the ephemeris.
- See Also:
EphemerisStatus
-
suppliedData
public final EphemerisTypeDescription suppliedData()
Supplied ephemeris data.
- Returns:
- Supplied ephemeris data.
-
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 theisEmpty()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.
-
toBuilder
public DescribeEphemerisResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeEphemerisResponse.Builder,DescribeEphemerisResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static DescribeEphemerisResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeEphemerisResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-