Class DescribeEphemerisResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeEphemerisResponse.Builder,
DescribeEphemerisResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The time the ephemeris was uploaded in UTC.final Boolean
enabled()
Whether or not the ephemeris is enabled.final String
The AWS Ground Station ephemeris ID.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final EphemerisInvalidReason
Reason that an ephemeris failed validation.final String
Reason that an ephemeris failed validation.final String
name()
A name string associated with the ephemeris.final Integer
priority()
Customer-provided priority score to establish the order in which overlapping ephemerides should be used.final String
The AWS Ground Station satellite ID associated with ephemeris.static Class
<? extends DescribeEphemerisResponse.Builder> final EphemerisStatus
status()
The status of the ephemeris.final String
The status of the ephemeris.final EphemerisTypeDescription
Supplied ephemeris data.tags()
Tags assigned to an ephemeris.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
creationTime
The time the ephemeris was uploaded in UTC.
- Returns:
- The time the ephemeris was uploaded in UTC.
-
enabled
Whether or not the ephemeris is enabled.
- Returns:
- Whether or not the ephemeris is enabled.
-
ephemerisId
The AWS Ground Station ephemeris ID.
- Returns:
- The AWS Ground Station ephemeris ID.
-
invalidReason
Reason that an ephemeris failed validation. Only provided for ephemerides with
INVALID
status.If the service returns an enum value that is not available in the current SDK version,
invalidReason
will 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
INVALID
status. - See Also:
-
invalidReasonAsString
Reason that an ephemeris failed validation. Only provided for ephemerides with
INVALID
status.If the service returns an enum value that is not available in the current SDK version,
invalidReason
will 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
INVALID
status. - See Also:
-
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
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
The AWS Ground Station satellite ID associated with ephemeris.
- Returns:
- The AWS Ground Station satellite ID associated with ephemeris.
-
status
The status of the ephemeris.
If the service returns an enum value that is not available in the current SDK version,
status
will returnEphemerisStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the ephemeris.
- See Also:
-
statusAsString
The status of the ephemeris.
If the service returns an enum value that is not available in the current SDK version,
status
will returnEphemerisStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the ephemeris.
- See Also:
-
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
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
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 interfaceToCopyableBuilder<DescribeEphemerisResponse.Builder,
DescribeEphemerisResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-