Class DescribeContactResponse

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.DescribeContactResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeContactResponse.Builder,DescribeContactResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeContactResponse extends GroundStationResponse implements ToCopyableBuilder<DescribeContactResponse.Builder,DescribeContactResponse>

  • Method Details

    • contactId

      public final String contactId()

      UUID of a contact.

      Returns:
      UUID of a contact.

    • contactStatus

      public final ContactStatus contactStatus()

      Status of a contact.

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

      Returns:
      Status of a contact.
      See Also:

    • contactStatusAsString

      public final String contactStatusAsString()

      Status of a contact.

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

      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 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.

    • dataflowList

      public final List<DataflowDetail> 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

      public final Instant endTime()

      End time of a contact in UTC.

      Returns:
      End time of a contact in UTC.

    • errorMessage

      public final String errorMessage()

      Error message for a contact.

      Returns:
      Error message for a contact.

    • groundStation

      public final String groundStation()

      Ground station for a contact.

      Returns:
      Ground station for a contact.

    • maximumElevation

      public final Elevation maximumElevation()

      Maximum elevation angle of a contact.

      Returns:
      Maximum elevation angle of a contact.

    • missionProfileArn

      public final String missionProfileArn()

      ARN of a mission profile.

      Returns:
      ARN of a mission profile.

    • postPassEndTime

      public final Instant 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

      public final Instant 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

      public final String region()

      Region of a contact.

      Returns:
      Region of a contact.

    • satelliteArn

      public final String satelliteArn()

      ARN of a satellite.

      Returns:
      ARN of a satellite.

    • startTime

      public final Instant 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 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 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

      public final Instant 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

      public final Instant 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

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

    • builder

      public static DescribeContactResponse.Builder builder()

    • serializableBuilderClass

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