Package software.amazon.awssdk.services.opensearchserverless.model

Class UpdateVpcEndpointRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.opensearchserverless.model.OpenSearchServerlessRequest
software.amazon.awssdk.services.opensearchserverless.model.UpdateVpcEndpointRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateVpcEndpointRequest.Builder,UpdateVpcEndpointRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateVpcEndpointRequest extends OpenSearchServerlessRequest implements ToCopyableBuilder<UpdateVpcEndpointRequest.Builder,UpdateVpcEndpointRequest>

  • Method Details

    • hasAddSecurityGroupIds

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

    • addSecurityGroupIds

      public final List<String> addSecurityGroupIds()

      The unique identifiers of the security groups to add to the endpoint. Security groups 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 hasAddSecurityGroupIds() method.

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

    • hasAddSubnetIds

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

    • addSubnetIds

      public final List<String> addSubnetIds()

      The ID of one or more subnets to add to the 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 hasAddSubnetIds() method.

      Returns:
      The ID of one or more subnets to add to the endpoint.

    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier to ensure idempotency of the request.

      Returns:
      Unique, case-sensitive identifier to ensure idempotency of the request.

    • id

      public final String id()

      The unique identifier of the interface endpoint to update.

      Returns:
      The unique identifier of the interface endpoint to update.

    • hasRemoveSecurityGroupIds

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

    • removeSecurityGroupIds

      public final List<String> removeSecurityGroupIds()

      The unique identifiers of the security groups to remove from the 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 hasRemoveSecurityGroupIds() method.

      Returns:
      The unique identifiers of the security groups to remove from the endpoint.

    • hasRemoveSubnetIds

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

    • removeSubnetIds

      public final List<String> removeSubnetIds()

      The unique identifiers of the subnets to remove from the 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 hasRemoveSubnetIds() method.

      Returns:
      The unique identifiers of the subnets to remove from the endpoint.

    • toBuilder

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

    • builder

      public static UpdateVpcEndpointRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.