Class EndpointDetails

java.lang.Object
software.amazon.awssdk.services.groundstation.model.EndpointDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EndpointDetails.Builder,EndpointDetails>
@Generated("software.amazon.awssdk:codegen") public final class EndpointDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EndpointDetails.Builder,EndpointDetails>

Information about the endpoint details.

See Also:

  • Method Details

    • awsGroundStationAgentEndpoint

      public final AwsGroundStationAgentEndpoint awsGroundStationAgentEndpoint()

      An agent endpoint.

      Returns:
      An agent endpoint.

    • endpoint

      public final DataflowEndpoint endpoint()

      A dataflow endpoint.

      Returns:
      A dataflow endpoint.

    • healthReasons

      public final List<CapabilityHealthReason> healthReasons()

      Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.

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

      Returns:
      Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.

    • hasHealthReasons

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

    • healthReasonsAsStrings

      public final List<String> healthReasonsAsStrings()

      Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.

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

      Returns:
      Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.

    • healthStatus

      public final CapabilityHealth healthStatus()

      A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.

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

      Returns:
      A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.
      See Also:

    • healthStatusAsString

      public final String healthStatusAsString()

      A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.

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

      Returns:
      A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.
      See Also:

    • securityDetails

      public final SecurityDetails securityDetails()

      Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.

      Returns:
      Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.

    • toBuilder

      public EndpointDetails.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<EndpointDetails.Builder,EndpointDetails>
      Returns:
      a builder for type T

    • builder

      public static EndpointDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EndpointDetails.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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)

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