Interface AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointBuilder
Enclosing interface:
AWS2S3VectorsEndpointBuilderFactory

public static interface AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the AWS S3 Vectors component.
  • Method Details

    • advanced

    • dataType

      The data type of the vector. Options: float32, float16. The option is a: java.lang.String type. Default: float32 Group: common
      Parameters:
      dataType - the value to set
      Returns:
      the dsl builder
    • distanceMetric

      The distance metric to use for similarity search. Options: cosine, euclidean, dot-product. The option is a: java.lang.String type. Default: cosine Group: common
      Parameters:
      distanceMetric - the value to set
      Returns:
      the dsl builder
    • overrideEndpoint

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder overrideEndpoint(boolean overrideEndpoint)
      Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a: boolean type. Default: false Group: common
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder
    • overrideEndpoint

      Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder
    • region

      The region in which S3 Vectors client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1). The option is a: java.lang.String type. Group: common
      Parameters:
      region - the value to set
      Returns:
      the dsl builder
    • similarityThreshold

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder similarityThreshold(Float similarityThreshold)
      The minimum similarity threshold for results. The option is a: java.lang.Float type. Group: common
      Parameters:
      similarityThreshold - the value to set
      Returns:
      the dsl builder
    • similarityThreshold

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder similarityThreshold(String similarityThreshold)
      The minimum similarity threshold for results. The option will be converted to a java.lang.Float type. Group: common
      Parameters:
      similarityThreshold - the value to set
      Returns:
      the dsl builder
    • topK

      The number of top similar vectors to return in a query. The option is a: java.lang.Integer type. Default: 10 Group: common
      Parameters:
      topK - the value to set
      Returns:
      the dsl builder
    • topK

      The number of top similar vectors to return in a query. The option will be converted to a java.lang.Integer type. Default: 10 Group: common
      Parameters:
      topK - the value to set
      Returns:
      the dsl builder
    • uriEndpointOverride

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder uriEndpointOverride(String uriEndpointOverride)
      Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: java.lang.String type. Group: common
      Parameters:
      uriEndpointOverride - the value to set
      Returns:
      the dsl builder
    • vectorDimensions

      The dimensions of the vector embeddings (default: 1536, which is the dimension for OpenAI text-embedding-3-small). The option is a: java.lang.Integer type. Default: 1536 Group: common
      Parameters:
      vectorDimensions - the value to set
      Returns:
      the dsl builder
    • vectorDimensions

      The dimensions of the vector embeddings (default: 1536, which is the dimension for OpenAI text-embedding-3-small). The option will be converted to a java.lang.Integer type. Default: 1536 Group: common
      Parameters:
      vectorDimensions - the value to set
      Returns:
      the dsl builder
    • vectorIndexName

      The name of the vector index. The option is a: java.lang.String type. Group: common
      Parameters:
      vectorIndexName - the value to set
      Returns:
      the dsl builder
    • consumerMetadataFilter

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder consumerMetadataFilter(String consumerMetadataFilter)
      Optional metadata filter for the consumer to filter vectors during polling. The option is a: java.lang.String type. Group: consumer
      Parameters:
      consumerMetadataFilter - the value to set
      Returns:
      the dsl builder
    • consumerQueryVector

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder consumerQueryVector(String consumerQueryVector)
      The query vector to use for the consumer to poll for similar vectors. Specified as comma-separated float values (e.g., 0.1,0.2,0.3). If not specified, the consumer will not poll. The option is a: java.lang.String type. Group: consumer
      Parameters:
      consumerQueryVector - the value to set
      Returns:
      the dsl builder
    • delay

      Milliseconds before the next poll for the consumer. The option is a: long type. Default: 500 Group: consumer
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder
    • delay

      Milliseconds before the next poll for the consumer. The option will be converted to a long type. Default: 500 Group: consumer
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder
    • deleteAfterRead

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder deleteAfterRead(boolean deleteAfterRead)
      Delete vectors after they have been consumed. The option is a: boolean type. Default: false Group: consumer
      Parameters:
      deleteAfterRead - the value to set
      Returns:
      the dsl builder
    • deleteAfterRead

      Delete vectors after they have been consumed. The option will be converted to a boolean type. Default: false Group: consumer
      Parameters:
      deleteAfterRead - the value to set
      Returns:
      the dsl builder
    • maxMessagesPerPoll

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder maxMessagesPerPoll(int maxMessagesPerPoll)
      The maximum number of messages to consume per poll for the consumer. The option is a: int type. Default: 10 Group: consumer
      Parameters:
      maxMessagesPerPoll - the value to set
      Returns:
      the dsl builder
    • maxMessagesPerPoll

      The maximum number of messages to consume per poll for the consumer. The option will be converted to a int type. Default: 10 Group: consumer
      Parameters:
      maxMessagesPerPoll - the value to set
      Returns:
      the dsl builder
    • sendEmptyMessageWhenIdle

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)
      If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: boolean type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder
    • sendEmptyMessageWhenIdle

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)
      If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a boolean type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder
    • proxyHost

      To define a proxy host when instantiating the S3 Vectors client. The option is a: java.lang.String type. Group: proxy
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder
    • proxyPort

      To define a proxy port when instantiating the S3 Vectors client. The option is a: java.lang.Integer type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder
    • proxyPort

      To define a proxy port when instantiating the S3 Vectors client. The option will be converted to a java.lang.Integer type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder
    • proxyProtocol

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the S3 Vectors client. The option is a: software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: proxy
      Parameters:
      proxyProtocol - the value to set
      Returns:
      the dsl builder
    • proxyProtocol

      To define a proxy protocol when instantiating the S3 Vectors client. The option will be converted to a software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: proxy
      Parameters:
      proxyProtocol - the value to set
      Returns:
      the dsl builder
    • backoffErrorThreshold

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold)
      The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder
    • backoffErrorThreshold

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold)
      The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a int type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder
    • backoffIdleThreshold

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
      The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder
    • backoffIdleThreshold

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold)
      The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a int type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder
    • backoffMultiplier

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder backoffMultiplier(int backoffMultiplier)
      To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: int type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder
    • backoffMultiplier

      To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a int type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder
    • greedy

      If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: boolean type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder
    • greedy

      If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a boolean type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder
    • initialDelay

      Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder
    • initialDelay

      Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder
    • repeatCount

      Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: long type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder
    • repeatCount

      Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a long type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder
    • runLoggingLevel

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
      The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder
    • runLoggingLevel

      The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder
    • scheduledExecutorService

      Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: java.util.concurrent.ScheduledExecutorService type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder
    • scheduledExecutorService

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService)
      Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a java.util.concurrent.ScheduledExecutorService type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder
    • scheduler

      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: java.lang.Object type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder
    • scheduler

      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a java.lang.Object type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder
    • schedulerProperties

      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This is a multi-value option with prefix: scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder
    • schedulerProperties

      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This is a multi-value option with prefix: scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
      Parameters:
      values - the values
      Returns:
      the dsl builder
    • startScheduler

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder startScheduler(boolean startScheduler)
      Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder
    • startScheduler

      Whether the scheduler should be auto started. The option will be converted to a boolean type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder
    • timeUnit

      Time unit for initialDelay and delay options. The option is a: java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder
    • timeUnit

      Time unit for initialDelay and delay options. The option will be converted to a java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder
    • useFixedDelay

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)
      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: boolean type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder
    • useFixedDelay

      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a boolean type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder
    • accessKey

      Amazon AWS Access Key. The option is a: java.lang.String type. Group: security
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder
    • profileCredentialsName

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder profileCredentialsName(String profileCredentialsName)
      If using a profile credentials provider, this parameter will set the profile name. The option is a: java.lang.String type. Group: security
      Parameters:
      profileCredentialsName - the value to set
      Returns:
      the dsl builder
    • secretKey

      Amazon AWS Secret Key. The option is a: java.lang.String type. Group: security
      Parameters:
      secretKey - the value to set
      Returns:
      the dsl builder
    • sessionToken

      Amazon AWS Session Token used when the user needs to assume an IAM role. The option is a: java.lang.String type. Group: security
      Parameters:
      sessionToken - the value to set
      Returns:
      the dsl builder
    • trustAllCertificates

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder trustAllCertificates(boolean trustAllCertificates)
      If we want to trust all certificates in case of overriding the endpoint. The option is a: boolean type. Default: false Group: security
      Parameters:
      trustAllCertificates - the value to set
      Returns:
      the dsl builder
    • trustAllCertificates

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder trustAllCertificates(String trustAllCertificates)
      If we want to trust all certificates in case of overriding the endpoint. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      trustAllCertificates - the value to set
      Returns:
      the dsl builder
    • useDefaultCredentialsProvider

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
      Set whether the S3 Vectors client should expect to load credentials through a default credentials provider. The option is a: boolean type. Default: false Group: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder
    • useDefaultCredentialsProvider

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder useDefaultCredentialsProvider(String useDefaultCredentialsProvider)
      Set whether the S3 Vectors client should expect to load credentials through a default credentials provider. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder
    • useProfileCredentialsProvider

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the S3 Vectors client should expect to load credentials through a profile credentials provider. The option is a: boolean type. Default: false Group: security
      Parameters:
      useProfileCredentialsProvider - the value to set
      Returns:
      the dsl builder
    • useProfileCredentialsProvider

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder useProfileCredentialsProvider(String useProfileCredentialsProvider)
      Set whether the S3 Vectors client should expect to load credentials through a profile credentials provider. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      useProfileCredentialsProvider - the value to set
      Returns:
      the dsl builder
    • useSessionCredentials

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder useSessionCredentials(boolean useSessionCredentials)
      Set whether the S3 Vectors client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in S3 Vectors. The option is a: boolean type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder
    • useSessionCredentials

      default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointConsumerBuilder useSessionCredentials(String useSessionCredentials)
      Set whether the S3 Vectors client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in S3 Vectors. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder