Class StreamBucketConfig

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

S3 bucket configuration for SQS-driven ingestion. The scan mode controls only the optional one-time delta scan of existing objects in this bucket.

See Also:

  • Method Details

    • bucket

      public final String bucket()

      The name or Amazon Resource Name (ARN) of the Amazon S3 bucket to ingest data from.

      Returns:
      The name or Amazon Resource Name (ARN) of the Amazon S3 bucket to ingest data from.

    • bucketOwnerAccountId

      public final String bucketOwnerAccountId()

      The AWS account ID that owns the S3 bucket. Optional. If omitted, the control plane derives it from the account segment of sqsArn.

      Returns:
      The AWS account ID that owns the S3 bucket. Optional. If omitted, the control plane derives it from the account segment of sqsArn.

    • initialScan

      public final InitialScan initialScan()

      Specifies whether to perform a one-time scan of the objects that already exist in the bucket before the stream begins processing Amazon S3 event notifications. If DISABLED, only new objects are ingested.

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

      Returns:
      Specifies whether to perform a one-time scan of the objects that already exist in the bucket before the stream begins processing Amazon S3 event notifications. If DISABLED, only new objects are ingested.
      See Also:

    • initialScanAsString

      public final String initialScanAsString()

      Specifies whether to perform a one-time scan of the objects that already exist in the bucket before the stream begins processing Amazon S3 event notifications. If DISABLED, only new objects are ingested.

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

      Returns:
      Specifies whether to perform a one-time scan of the objects that already exist in the bucket before the stream begins processing Amazon S3 event notifications. If DISABLED, only new objects are ingested.
      See Also:

    • toBuilder

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

    • builder

      public static StreamBucketConfig.Builder builder()

    • serializableBuilderClass

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