Class VpcEndpointDetail

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

Details about an OpenSearch Serverless-managed interface endpoint.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier of the endpoint.

      Returns:
      The unique identifier of the endpoint.

    • name

      public final String name()

      The name of the endpoint.

      Returns:
      The name of the endpoint.

    • vpcId

      public final String vpcId()

      The ID of the VPC from which you access OpenSearch Serverless.

      Returns:
      The ID of the VPC from which you access OpenSearch Serverless.

    • hasSubnetIds

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

    • subnetIds

      public final List<String> subnetIds()

      The ID of the subnets from which you access OpenSearch Serverless.

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

      Returns:
      The ID of the subnets from which you access OpenSearch Serverless.

    • hasSecurityGroupIds

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

    • securityGroupIds

      public final List<String> securityGroupIds()

      The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

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

      Returns:
      The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your 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:

    • createdDate

      public final Long createdDate()

      The date the endpoint was created.

      Returns:
      The date the endpoint was created.

    • failureCode

      public final String failureCode()

      A failure code associated with the request.

      Returns:
      A failure code associated with the request.

    • failureMessage

      public final String failureMessage()

      A message associated with the failure code.

      Returns:
      A message associated with the failure code.

    • toBuilder

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

    • builder

      public static VpcEndpointDetail.Builder builder()

    • serializableBuilderClass

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