Class VpcOptions

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

Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

See Also:

  • Method Details

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

      A list of subnet IDs associated with the VPC 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 hasSubnetIds() method.

      Returns:
      A list of subnet IDs associated with the VPC endpoint.

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

      A list of security groups associated with the VPC 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:
      A list of security groups associated with the VPC endpoint.

    • vpcAttachmentOptions

      public final VpcAttachmentOptions vpcAttachmentOptions()

      Options for attaching a VPC to a pipeline.

      Returns:
      Options for attaching a VPC to a pipeline.

    • vpcEndpointManagement

      public final VpcEndpointManagement vpcEndpointManagement()

      Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.

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

      Returns:
      Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.
      See Also:

    • vpcEndpointManagementAsString

      public final String vpcEndpointManagementAsString()

      Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.

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

      Returns:
      Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.
      See Also:

    • toBuilder

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

    • builder

      public static VpcOptions.Builder builder()

    • serializableBuilderClass

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