Class AmazonOpenSearchServerlessDestinationDescription

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

The destination description in the Serverless offering for Amazon OpenSearch Service.

See Also:

  • Method Details

    • roleARN

      public final String roleARN()

      The Amazon Resource Name (ARN) of the Amazon Web Services credentials.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Web Services credentials.

    • collectionEndpoint

      public final String collectionEndpoint()

      The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

      Returns:
      The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

    • indexName

      public final String indexName()

      The Serverless offering for Amazon OpenSearch Service index name.

      Returns:
      The Serverless offering for Amazon OpenSearch Service index name.

    • bufferingHints

      public final AmazonOpenSearchServerlessBufferingHints bufferingHints()

      The buffering options.

      Returns:
      The buffering options.

    • retryOptions

      public final AmazonOpenSearchServerlessRetryOptions retryOptions()

      The Serverless offering for Amazon OpenSearch Service retry options.

      Returns:
      The Serverless offering for Amazon OpenSearch Service retry options.

    • s3BackupMode

      public final AmazonOpenSearchServerlessS3BackupMode s3BackupMode()

      The Amazon S3 backup mode.

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

      Returns:
      The Amazon S3 backup mode.
      See Also:

    • s3BackupModeAsString

      public final String s3BackupModeAsString()

      The Amazon S3 backup mode.

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

      Returns:
      The Amazon S3 backup mode.
      See Also:

    • s3DestinationDescription

      public final S3DestinationDescription s3DestinationDescription()
      Returns the value of the S3DestinationDescription property for this object.
      Returns:
      The value of the S3DestinationDescription property for this object.

    • processingConfiguration

      public final ProcessingConfiguration processingConfiguration()
      Returns the value of the ProcessingConfiguration property for this object.
      Returns:
      The value of the ProcessingConfiguration property for this object.

    • cloudWatchLoggingOptions

      public final CloudWatchLoggingOptions cloudWatchLoggingOptions()
      Returns the value of the CloudWatchLoggingOptions property for this object.
      Returns:
      The value of the CloudWatchLoggingOptions property for this object.

    • vpcConfigurationDescription

      public final VpcConfigurationDescription vpcConfigurationDescription()
      Returns the value of the VpcConfigurationDescription property for this object.
      Returns:
      The value of the VpcConfigurationDescription property for this object.

    • toBuilder

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

    • builder

      public static AmazonOpenSearchServerlessDestinationDescription.Builder builder()

    • serializableBuilderClass

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