Class AmazonopensearchserviceDestinationDescription

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

The destination description in 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.

    • domainARN

      public final String domainARN()

      The ARN of the Amazon OpenSearch Service domain.

      Returns:
      The ARN of the Amazon OpenSearch Service domain.

    • clusterEndpoint

      public final String clusterEndpoint()

      The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.

      Returns:
      The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.

    • indexName

      public final String indexName()

      The Amazon OpenSearch Service index name.

      Returns:
      The Amazon OpenSearch Service index name.

    • typeName

      public final String typeName()

      The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

      Returns:
      The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

    • indexRotationPeriod

      public final AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod()

      The Amazon OpenSearch Service index rotation period

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

      Returns:
      The Amazon OpenSearch Service index rotation period
      See Also:

    • indexRotationPeriodAsString

      public final String indexRotationPeriodAsString()

      The Amazon OpenSearch Service index rotation period

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

      Returns:
      The Amazon OpenSearch Service index rotation period
      See Also:

    • bufferingHints

      public final AmazonopensearchserviceBufferingHints bufferingHints()

      The buffering options.

      Returns:
      The buffering options.

    • retryOptions

      public final AmazonopensearchserviceRetryOptions retryOptions()

      The Amazon OpenSearch Service retry options.

      Returns:
      The Amazon OpenSearch Service retry options.

    • s3BackupMode

      public final AmazonopensearchserviceS3BackupMode 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 AmazonopensearchserviceS3BackupMode.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 AmazonopensearchserviceS3BackupMode.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.

    • documentIdOptions

      public final DocumentIdOptions documentIdOptions()

      Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

      Returns:
      Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

    • toBuilder

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

    • builder

      public static AmazonopensearchserviceDestinationDescription.Builder builder()

    • serializableBuilderClass

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