Class VpcEndpoint

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

The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.

See Also:

  • Method Details

    • vpcEndpointId

      public final String vpcEndpointId()

      The unique identifier of the endpoint.

      Returns:
      The unique identifier of the endpoint.

    • vpcEndpointOwner

      public final String vpcEndpointOwner()

      The creator of the endpoint.

      Returns:
      The creator of the endpoint.

    • domainArn

      public final String domainArn()

      The Amazon Resource Name (ARN) of the domain associated with the endpoint.

      Returns:
      The Amazon Resource Name (ARN) of the domain associated with the endpoint.

    • vpcOptions

      public final VPCDerivedInfo vpcOptions()

      Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

      Returns:
      Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

    • status

      public final VpcEndpointStatus status()

      The current status of the endpoint.

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

      Returns:
      The current status of the endpoint.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the endpoint.

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

      Returns:
      The current status of the endpoint.
      See Also:

    • endpoint

      public final String endpoint()

      The connection endpoint ID for connecting to the domain.

      Returns:
      The connection endpoint ID for connecting to the domain.

    • toBuilder

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

    • builder

      public static VpcEndpoint.Builder builder()

    • serializableBuilderClass

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