Class AmazonOpenSearchServerlessDestinationUpdate

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

Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.

See Also:

  • Method Details

    • roleARN

      public final String roleARN()

      The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

    • 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. If no value is specified, AmazonopensearchBufferingHints object default values are used.

      Returns:
      The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.

    • retryOptions

      public final AmazonOpenSearchServerlessRetryOptions retryOptions()

      The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

      Returns:
      The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

    • s3Update

      public final S3DestinationUpdate s3Update()
      Returns the value of the S3Update property for this object.
      Returns:
      The value of the S3Update 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.

    • toBuilder

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

    • builder

      public static AmazonOpenSearchServerlessDestinationUpdate.Builder builder()

    • serializableBuilderClass

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