Class PipelineEndpoint

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

Represents a VPC endpoint for an OpenSearch Ingestion pipeline, enabling private connectivity between your VPC and the pipeline.

See Also:

  • Method Details

    • pipelineArn

      public final String pipelineArn()

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

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

    • endpointId

      public final String endpointId()

      The unique identifier for the pipeline endpoint.

      Returns:
      The unique identifier for the pipeline endpoint.

    • status

      public final PipelineEndpointStatus status()

      The current status of the pipeline endpoint.

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

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

    • statusAsString

      public final String statusAsString()

      The current status of the pipeline endpoint.

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

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

    • vpcId

      public final String vpcId()

      The ID of the VPC where the pipeline endpoint is created.

      Returns:
      The ID of the VPC where the pipeline endpoint is created.

    • vpcOptions

      public final PipelineEndpointVpcOptions vpcOptions()

      Configuration options for the VPC endpoint, including subnet and security group settings.

      Returns:
      Configuration options for the VPC endpoint, including subnet and security group settings.

    • ingestEndpointUrl

      public final String ingestEndpointUrl()

      The URL used to ingest data to the pipeline through the VPC endpoint.

      Returns:
      The URL used to ingest data to the pipeline through the VPC endpoint.

    • toBuilder

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

    • builder

      public static PipelineEndpoint.Builder builder()

    • serializableBuilderClass

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