Class DescribeContactResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeContactResponse.Builder,
DescribeContactResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
UUID of a contact.final ContactStatus
Status of a contact.final String
Status of a contact.final List
<DataflowDetail> List describing source and destination details for each dataflow edge.final Instant
endTime()
End time of a contact in UTC.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Error message for a contact.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final String
Ground station for a contact.final boolean
For responses, this returns true if the service returned a value for the DataflowList property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Elevation
Maximum elevation angle of a contact.final String
ARN of a mission profile.final Instant
Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.final Instant
Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.final String
region()
Region of a contact.final String
ARN of a satellite.static Class
<? extends DescribeContactResponse.Builder> final Instant
Start time of a contact in UTC.tags()
Tags assigned to a contact.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.final Instant
Projected time in UTC your satellite will set below the receive mask.final Instant
Projected time in UTC your satellite will rise above the receive mask.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
-
contactId
UUID of a contact.
- Returns:
- UUID of a contact.
-
contactStatus
Status of a contact.
If the service returns an enum value that is not available in the current SDK version,
contactStatus
will returnContactStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontactStatusAsString()
.- Returns:
- Status of a contact.
- See Also:
-
contactStatusAsString
Status of a contact.
If the service returns an enum value that is not available in the current SDK version,
contactStatus
will returnContactStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontactStatusAsString()
.- Returns:
- Status of a contact.
- See Also:
-
hasDataflowList
public final boolean hasDataflowList()For responses, this returns true if the service returned a value for the DataflowList 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. -
dataflowList
List describing source and destination details for each dataflow edge.
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
hasDataflowList()
method.- Returns:
- List describing source and destination details for each dataflow edge.
-
endTime
End time of a contact in UTC.
- Returns:
- End time of a contact in UTC.
-
errorMessage
Error message for a contact.
- Returns:
- Error message for a contact.
-
groundStation
Ground station for a contact.
- Returns:
- Ground station for a contact.
-
maximumElevation
Maximum elevation angle of a contact.
- Returns:
- Maximum elevation angle of a contact.
-
missionProfileArn
ARN of a mission profile.
- Returns:
- ARN of a mission profile.
-
postPassEndTime
Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
- Returns:
- Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
-
prePassStartTime
Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
- Returns:
- Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
-
region
Region of a contact.
- Returns:
- Region of a contact.
-
satelliteArn
ARN of a satellite.
- Returns:
- ARN of a satellite.
-
startTime
Start time of a contact in UTC.
- Returns:
- Start time of a contact in UTC.
-
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 a contact.
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 a contact.
-
visibilityEndTime
Projected time in UTC your satellite will set below the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.
- Returns:
- Projected time in UTC your satellite will set below the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.
-
visibilityStartTime
Projected time in UTC your satellite will rise above the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.
- Returns:
- Projected time in UTC your satellite will rise above the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.
-
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<DescribeContactResponse.Builder,
DescribeContactResponse> - 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
-