Package org.apache.camel.builder.endpoint.dsl

Interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
All Known Subinterfaces:
QueueEndpointBuilderFactory.QueueEndpointBuilder
Enclosing interface:
QueueEndpointBuilderFactory
public static interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the Azure Storage Queue Service component.

  • Method Details

    • advanced

      default QueueEndpointBuilderFactory.AdvancedQueueEndpointProducerBuilder advanced()

    • serviceClient

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder serviceClient(com.azure.storage.queue.QueueServiceClient serviceClient)
      Service client to a storage account to interact with the queue service. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. This client contains all the operations for interacting with a queue account in Azure Storage. Operations allowed by the client are creating, listing, and deleting queues, retrieving and updating properties of the account, and retrieving statistics of the account. The option is a: <code>com.azure.storage.queue.QueueServiceClient</code> type. Group: common
      Parameters:
      serviceClient - the value to set
      Returns:
      the dsl builder

    • serviceClient

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder serviceClient(String serviceClient)
      Service client to a storage account to interact with the queue service. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. This client contains all the operations for interacting with a queue account in Azure Storage. Operations allowed by the client are creating, listing, and deleting queues, retrieving and updating properties of the account, and retrieving statistics of the account. The option will be converted to a <code>com.azure.storage.queue.QueueServiceClient</code> type. Group: common
      Parameters:
      serviceClient - the value to set
      Returns:
      the dsl builder

    • createQueue

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder createQueue(boolean createQueue)
      When is set to true, the queue will be automatically created when sending messages to the queue. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      createQueue - the value to set
      Returns:
      the dsl builder

    • createQueue

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder createQueue(String createQueue)
      When is set to true, the queue will be automatically created when sending messages to the queue. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
      Parameters:
      createQueue - the value to set
      Returns:
      the dsl builder

    • operation

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder operation(org.apache.camel.component.azure.storage.queue.QueueOperationDefinition operation)
      Queue service operation hint to the producer. The option is a: <code>org.apache.camel.component.azure.storage.queue.QueueOperationDefinition</code> type. Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • operation

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder operation(String operation)
      Queue service operation hint to the producer. The option will be converted to a <code>org.apache.camel.component.azure.storage.queue.QueueOperationDefinition</code> type. Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • maxMessages

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder maxMessages(Integer maxMessages)
      Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 messages. The option is a: <code>java.lang.Integer</code> type. Default: 1 Group: queue
      Parameters:
      maxMessages - the value to set
      Returns:
      the dsl builder

    • maxMessages

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder maxMessages(String maxMessages)
      Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 messages. The option will be converted to a <code>java.lang.Integer</code> type. Default: 1 Group: queue
      Parameters:
      maxMessages - the value to set
      Returns:
      the dsl builder

    • messageId

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder messageId(String messageId)
      The ID of the message to be deleted or updated. The option is a: <code>java.lang.String</code> type. Group: queue
      Parameters:
      messageId - the value to set
      Returns:
      the dsl builder

    • popReceipt

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder popReceipt(String popReceipt)
      Unique identifier that must match for the message to be deleted or updated. The option is a: <code>java.lang.String</code> type. Group: queue
      Parameters:
      popReceipt - the value to set
      Returns:
      the dsl builder

    • timeout

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder timeout(Duration timeout)
      An optional timeout applied to the operation. If a response is not returned before the timeout concludes a RuntimeException will be thrown. The option is a: <code>java.time.Duration</code> type. Group: queue
      Parameters:
      timeout - the value to set
      Returns:
      the dsl builder

    • timeout

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder timeout(String timeout)
      An optional timeout applied to the operation. If a response is not returned before the timeout concludes a RuntimeException will be thrown. The option will be converted to a <code>java.time.Duration</code> type. Group: queue
      Parameters:
      timeout - the value to set
      Returns:
      the dsl builder

    • timeToLive

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder timeToLive(Duration timeToLive)
      How long the message will stay alive in the queue. If unset the value will default to 7 days, if -1 is passed the message will not expire. The time to live must be -1 or any positive number. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe. The option is a: <code>java.time.Duration</code> type. Group: queue
      Parameters:
      timeToLive - the value to set
      Returns:
      the dsl builder

    • timeToLive

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder timeToLive(String timeToLive)
      How long the message will stay alive in the queue. If unset the value will default to 7 days, if -1 is passed the message will not expire. The time to live must be -1 or any positive number. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe. The option will be converted to a <code>java.time.Duration</code> type. Group: queue
      Parameters:
      timeToLive - the value to set
      Returns:
      the dsl builder

    • visibilityTimeout

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder visibilityTimeout(Duration visibilityTimeout)
      The timeout period for how long the message is invisible in the queue. The timeout must be between 1 seconds and 7 days. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe. The option is a: <code>java.time.Duration</code> type. Group: queue
      Parameters:
      visibilityTimeout - the value to set
      Returns:
      the dsl builder

    • visibilityTimeout

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder visibilityTimeout(String visibilityTimeout)
      The timeout period for how long the message is invisible in the queue. The timeout must be between 1 seconds and 7 days. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe. The option will be converted to a <code>java.time.Duration</code> type. Group: queue
      Parameters:
      visibilityTimeout - the value to set
      Returns:
      the dsl builder

    • accessKey

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder accessKey(String accessKey)
      Access key for the associated azure account name to be used for authentication with azure queue services. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder

    • credentials

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder credentials(com.azure.storage.common.StorageSharedKeyCredential credentials)
      StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information. The option is a: <code>com.azure.storage.common.StorageSharedKeyCredential</code> type. Group: security
      Parameters:
      credentials - the value to set
      Returns:
      the dsl builder

    • credentials

      default QueueEndpointBuilderFactory.QueueEndpointProducerBuilder credentials(String credentials)
      StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information. The option will be converted to a <code>com.azure.storage.common.StorageSharedKeyCredential</code> type. Group: security
      Parameters:
      credentials - the value to set
      Returns:
      the dsl builder