Class Endpoint

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

An endpoint available for interaction with the scheduler.

See Also:

  • Method Details

    • type

      public final EndpointType type()

      Indicates the type of endpoint running at the specific IP address.

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

      Returns:
      Indicates the type of endpoint running at the specific IP address.
      See Also:

    • typeAsString

      public final String typeAsString()

      Indicates the type of endpoint running at the specific IP address.

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

      Returns:
      Indicates the type of endpoint running at the specific IP address.
      See Also:

    • privateIpAddress

      public final String privateIpAddress()

      For clusters that use IPv4, this is the endpoint's private IP address.

      Example: 10.1.2.3

      For clusters configured to use IPv6, this is an empty string.

      Returns:
      For clusters that use IPv4, this is the endpoint's private IP address.

      Example: 10.1.2.3

      For clusters configured to use IPv6, this is an empty string.

    • publicIpAddress

      public final String publicIpAddress()

      The endpoint's public IP address.

      Example: 192.0.2.1

      Returns:
      The endpoint's public IP address.

      Example: 192.0.2.1

    • ipv6Address

      public final String ipv6Address()

      The endpoint's IPv6 address.

      Example: 2001:db8::1

      Returns:
      The endpoint's IPv6 address.

      Example: 2001:db8::1

    • port

      public final String port()

      The endpoint's connection port number.

      Example: 1234

      Returns:
      The endpoint's connection port number.

      Example: 1234

    • toBuilder

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

    • builder

      public static Endpoint.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.