blob: e554b2a1cdbd74f0a13d5aac701c1c543daf7b3f [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.builder.endpoint.dsl;
import java.util.Map;
import javax.annotation.Generated;
import org.apache.camel.ExchangePattern;
import org.apache.camel.builder.EndpointConsumerBuilder;
import org.apache.camel.builder.EndpointProducerBuilder;
import org.apache.camel.builder.endpoint.AbstractEndpointBuilder;
import org.apache.camel.spi.ExceptionHandler;
/**
* The azure-blob component is used for storing and retrieving blobs from Azure
* Storage Blob Service.
*
* Generated by camel-package-maven-plugin - do not edit this file!
*/
@Generated("org.apache.camel.maven.packaging.EndpointDslMojo")
public interface BlobServiceEndpointBuilderFactory {
/**
* Builder for endpoint consumers for the Azure Storage Blob Service
* component.
*/
public interface BlobServiceEndpointConsumerBuilder
extends
EndpointConsumerBuilder {
default AdvancedBlobServiceEndpointConsumerBuilder advanced() {
return (AdvancedBlobServiceEndpointConsumerBuilder) this;
}
/**
* The blob service client.
*
* The option is a:
* <code>com.microsoft.azure.storage.blob.CloudBlob</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder azureBlobClient(
Object azureBlobClient) {
doSetProperty("azureBlobClient", azureBlobClient);
return this;
}
/**
* The blob service client.
*
* The option will be converted to a
* <code>com.microsoft.azure.storage.blob.CloudBlob</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder azureBlobClient(
String azureBlobClient) {
doSetProperty("azureBlobClient", azureBlobClient);
return this;
}
/**
* Set the blob offset for the upload or download operations, default is
* 0.
*
* The option is a: <code>java.lang.Long</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder blobOffset(Long blobOffset) {
doSetProperty("blobOffset", blobOffset);
return this;
}
/**
* Set the blob offset for the upload or download operations, default is
* 0.
*
* The option will be converted to a <code>java.lang.Long</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder blobOffset(String blobOffset) {
doSetProperty("blobOffset", blobOffset);
return this;
}
/**
* Set a blob type, 'blockblob' is default.
*
* The option is a:
* <code>org.apache.camel.component.azure.blob.BlobType</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder blobType(BlobType blobType) {
doSetProperty("blobType", blobType);
return this;
}
/**
* Set a blob type, 'blockblob' is default.
*
* The option will be converted to a
* <code>org.apache.camel.component.azure.blob.BlobType</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder blobType(String blobType) {
doSetProperty("blobType", blobType);
return this;
}
/**
* Close the stream after read or keep it open, default is true.
*
* The option is a: <code>boolean</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder closeStreamAfterRead(
boolean closeStreamAfterRead) {
doSetProperty("closeStreamAfterRead", closeStreamAfterRead);
return this;
}
/**
* Close the stream after read or keep it open, default is true.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder closeStreamAfterRead(
String closeStreamAfterRead) {
doSetProperty("closeStreamAfterRead", closeStreamAfterRead);
return this;
}
/**
* Set the storage credentials, required in most cases.
*
* The option is a:
* <code>com.microsoft.azure.storage.StorageCredentials</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder credentials(
Object credentials) {
doSetProperty("credentials", credentials);
return this;
}
/**
* Set the storage credentials, required in most cases.
*
* The option will be converted to a
* <code>com.microsoft.azure.storage.StorageCredentials</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder credentials(
String credentials) {
doSetProperty("credentials", credentials);
return this;
}
/**
* Set the data length for the download or page blob upload operations.
*
* The option is a: <code>java.lang.Long</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder dataLength(Long dataLength) {
doSetProperty("dataLength", dataLength);
return this;
}
/**
* Set the data length for the download or page blob upload operations.
*
* The option will be converted to a <code>java.lang.Long</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder dataLength(String dataLength) {
doSetProperty("dataLength", dataLength);
return this;
}
/**
* Set the file directory where the downloaded blobs will be saved to.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder fileDir(String fileDir) {
doSetProperty("fileDir", fileDir);
return this;
}
/**
* Storage resources can be public for reading their content, if this
* property is enabled then the credentials do not have to be set.
*
* The option is a: <code>boolean</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder publicForRead(
boolean publicForRead) {
doSetProperty("publicForRead", publicForRead);
return this;
}
/**
* Storage resources can be public for reading their content, if this
* property is enabled then the credentials do not have to be set.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder publicForRead(
String publicForRead) {
doSetProperty("publicForRead", publicForRead);
return this;
}
/**
* Set the minimum read size in bytes when reading the blob content.
*
* The option is a: <code>int</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder streamReadSize(
int streamReadSize) {
doSetProperty("streamReadSize", streamReadSize);
return this;
}
/**
* Set the minimum read size in bytes when reading the blob content.
*
* The option will be converted to a <code>int</code> type.
*
* Group: common
*/
default BlobServiceEndpointConsumerBuilder streamReadSize(
String streamReadSize) {
doSetProperty("streamReadSize", streamReadSize);
return this;
}
/**
* Allows for bridging the consumer to the Camel routing Error Handler,
* which mean any exceptions occurred while the consumer is trying to
* pickup incoming messages, or the likes, will now be processed as a
* message and handled by the routing Error Handler. By default the
* consumer will use the org.apache.camel.spi.ExceptionHandler to deal
* with exceptions, that will be logged at WARN or ERROR level and
* ignored.
*
* The option is a: <code>boolean</code> type.
*
* Group: consumer
*/
default BlobServiceEndpointConsumerBuilder bridgeErrorHandler(
boolean bridgeErrorHandler) {
doSetProperty("bridgeErrorHandler", bridgeErrorHandler);
return this;
}
/**
* Allows for bridging the consumer to the Camel routing Error Handler,
* which mean any exceptions occurred while the consumer is trying to
* pickup incoming messages, or the likes, will now be processed as a
* message and handled by the routing Error Handler. By default the
* consumer will use the org.apache.camel.spi.ExceptionHandler to deal
* with exceptions, that will be logged at WARN or ERROR level and
* ignored.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: consumer
*/
default BlobServiceEndpointConsumerBuilder bridgeErrorHandler(
String bridgeErrorHandler) {
doSetProperty("bridgeErrorHandler", bridgeErrorHandler);
return this;
}
}
/**
* Advanced builder for endpoint consumers for the Azure Storage Blob
* Service component.
*/
public interface AdvancedBlobServiceEndpointConsumerBuilder
extends
EndpointConsumerBuilder {
default BlobServiceEndpointConsumerBuilder basic() {
return (BlobServiceEndpointConsumerBuilder) this;
}
/**
* To let the consumer use a custom ExceptionHandler. Notice if the
* option bridgeErrorHandler is enabled then this option is not in use.
* By default the consumer will deal with exceptions, that will be
* logged at WARN or ERROR level and ignored.
*
* The option is a: <code>org.apache.camel.spi.ExceptionHandler</code>
* type.
*
* Group: consumer (advanced)
*/
default AdvancedBlobServiceEndpointConsumerBuilder exceptionHandler(
ExceptionHandler exceptionHandler) {
doSetProperty("exceptionHandler", exceptionHandler);
return this;
}
/**
* To let the consumer use a custom ExceptionHandler. Notice if the
* option bridgeErrorHandler is enabled then this option is not in use.
* By default the consumer will deal with exceptions, that will be
* logged at WARN or ERROR level and ignored.
*
* The option will be converted to a
* <code>org.apache.camel.spi.ExceptionHandler</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedBlobServiceEndpointConsumerBuilder exceptionHandler(
String exceptionHandler) {
doSetProperty("exceptionHandler", exceptionHandler);
return this;
}
/**
* Sets the exchange pattern when the consumer creates an exchange.
*
* The option is a: <code>org.apache.camel.ExchangePattern</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedBlobServiceEndpointConsumerBuilder exchangePattern(
ExchangePattern exchangePattern) {
doSetProperty("exchangePattern", exchangePattern);
return this;
}
/**
* Sets the exchange pattern when the consumer creates an exchange.
*
* The option will be converted to a
* <code>org.apache.camel.ExchangePattern</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedBlobServiceEndpointConsumerBuilder exchangePattern(
String exchangePattern) {
doSetProperty("exchangePattern", exchangePattern);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedBlobServiceEndpointConsumerBuilder basicPropertyBinding(
boolean basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedBlobServiceEndpointConsumerBuilder basicPropertyBinding(
String basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedBlobServiceEndpointConsumerBuilder synchronous(
boolean synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedBlobServiceEndpointConsumerBuilder synchronous(
String synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
}
/**
* Builder for endpoint producers for the Azure Storage Blob Service
* component.
*/
public interface BlobServiceEndpointProducerBuilder
extends
EndpointProducerBuilder {
default AdvancedBlobServiceEndpointProducerBuilder advanced() {
return (AdvancedBlobServiceEndpointProducerBuilder) this;
}
/**
* The blob service client.
*
* The option is a:
* <code>com.microsoft.azure.storage.blob.CloudBlob</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder azureBlobClient(
Object azureBlobClient) {
doSetProperty("azureBlobClient", azureBlobClient);
return this;
}
/**
* The blob service client.
*
* The option will be converted to a
* <code>com.microsoft.azure.storage.blob.CloudBlob</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder azureBlobClient(
String azureBlobClient) {
doSetProperty("azureBlobClient", azureBlobClient);
return this;
}
/**
* Set the blob offset for the upload or download operations, default is
* 0.
*
* The option is a: <code>java.lang.Long</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder blobOffset(Long blobOffset) {
doSetProperty("blobOffset", blobOffset);
return this;
}
/**
* Set the blob offset for the upload or download operations, default is
* 0.
*
* The option will be converted to a <code>java.lang.Long</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder blobOffset(String blobOffset) {
doSetProperty("blobOffset", blobOffset);
return this;
}
/**
* Set a blob type, 'blockblob' is default.
*
* The option is a:
* <code>org.apache.camel.component.azure.blob.BlobType</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder blobType(BlobType blobType) {
doSetProperty("blobType", blobType);
return this;
}
/**
* Set a blob type, 'blockblob' is default.
*
* The option will be converted to a
* <code>org.apache.camel.component.azure.blob.BlobType</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder blobType(String blobType) {
doSetProperty("blobType", blobType);
return this;
}
/**
* Close the stream after read or keep it open, default is true.
*
* The option is a: <code>boolean</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder closeStreamAfterRead(
boolean closeStreamAfterRead) {
doSetProperty("closeStreamAfterRead", closeStreamAfterRead);
return this;
}
/**
* Close the stream after read or keep it open, default is true.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder closeStreamAfterRead(
String closeStreamAfterRead) {
doSetProperty("closeStreamAfterRead", closeStreamAfterRead);
return this;
}
/**
* Set the storage credentials, required in most cases.
*
* The option is a:
* <code>com.microsoft.azure.storage.StorageCredentials</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder credentials(
Object credentials) {
doSetProperty("credentials", credentials);
return this;
}
/**
* Set the storage credentials, required in most cases.
*
* The option will be converted to a
* <code>com.microsoft.azure.storage.StorageCredentials</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder credentials(
String credentials) {
doSetProperty("credentials", credentials);
return this;
}
/**
* Set the data length for the download or page blob upload operations.
*
* The option is a: <code>java.lang.Long</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder dataLength(Long dataLength) {
doSetProperty("dataLength", dataLength);
return this;
}
/**
* Set the data length for the download or page blob upload operations.
*
* The option will be converted to a <code>java.lang.Long</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder dataLength(String dataLength) {
doSetProperty("dataLength", dataLength);
return this;
}
/**
* Set the file directory where the downloaded blobs will be saved to.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder fileDir(String fileDir) {
doSetProperty("fileDir", fileDir);
return this;
}
/**
* Storage resources can be public for reading their content, if this
* property is enabled then the credentials do not have to be set.
*
* The option is a: <code>boolean</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder publicForRead(
boolean publicForRead) {
doSetProperty("publicForRead", publicForRead);
return this;
}
/**
* Storage resources can be public for reading their content, if this
* property is enabled then the credentials do not have to be set.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder publicForRead(
String publicForRead) {
doSetProperty("publicForRead", publicForRead);
return this;
}
/**
* Set the minimum read size in bytes when reading the blob content.
*
* The option is a: <code>int</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder streamReadSize(
int streamReadSize) {
doSetProperty("streamReadSize", streamReadSize);
return this;
}
/**
* Set the minimum read size in bytes when reading the blob content.
*
* The option will be converted to a <code>int</code> type.
*
* Group: common
*/
default BlobServiceEndpointProducerBuilder streamReadSize(
String streamReadSize) {
doSetProperty("streamReadSize", streamReadSize);
return this;
}
/**
* Set the blob meta-data.
*
* The option is a: <code>java.util.Map&lt;java.lang.String,
* java.lang.String&gt;</code> type.
*
* Group: producer
*/
default BlobServiceEndpointProducerBuilder blobMetadata(
Map<String, String> blobMetadata) {
doSetProperty("blobMetadata", blobMetadata);
return this;
}
/**
* Set the blob meta-data.
*
* The option will be converted to a
* <code>java.util.Map&lt;java.lang.String, java.lang.String&gt;</code>
* type.
*
* Group: producer
*/
default BlobServiceEndpointProducerBuilder blobMetadata(
String blobMetadata) {
doSetProperty("blobMetadata", blobMetadata);
return this;
}
/**
* Set a prefix which can be used for listing the blobs.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: producer
*/
default BlobServiceEndpointProducerBuilder blobPrefix(String blobPrefix) {
doSetProperty("blobPrefix", blobPrefix);
return this;
}
/**
* Close the stream after write or keep it open, default is true.
*
* The option is a: <code>boolean</code> type.
*
* Group: producer
*/
default BlobServiceEndpointProducerBuilder closeStreamAfterWrite(
boolean closeStreamAfterWrite) {
doSetProperty("closeStreamAfterWrite", closeStreamAfterWrite);
return this;
}
/**
* Close the stream after write or keep it open, default is true.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: producer
*/
default BlobServiceEndpointProducerBuilder closeStreamAfterWrite(
String closeStreamAfterWrite) {
doSetProperty("closeStreamAfterWrite", closeStreamAfterWrite);
return this;
}
/**
* Whether the producer should be started lazy (on the first message).
* By starting lazy you can use this to allow CamelContext and routes to
* startup in situations where a producer may otherwise fail during
* starting and cause the route to fail being started. By deferring this
* startup to be lazy then the startup failure can be handled during
* routing messages via Camel's routing error handlers. Beware that when
* the first message is processed then creating and starting the
* producer may take a little time and prolong the total processing time
* of the processing.
*
* The option is a: <code>boolean</code> type.
*
* Group: producer
*/
default BlobServiceEndpointProducerBuilder lazyStartProducer(
boolean lazyStartProducer) {
doSetProperty("lazyStartProducer", lazyStartProducer);
return this;
}
/**
* Whether the producer should be started lazy (on the first message).
* By starting lazy you can use this to allow CamelContext and routes to
* startup in situations where a producer may otherwise fail during
* starting and cause the route to fail being started. By deferring this
* startup to be lazy then the startup failure can be handled during
* routing messages via Camel's routing error handlers. Beware that when
* the first message is processed then creating and starting the
* producer may take a little time and prolong the total processing time
* of the processing.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: producer
*/
default BlobServiceEndpointProducerBuilder lazyStartProducer(
String lazyStartProducer) {
doSetProperty("lazyStartProducer", lazyStartProducer);
return this;
}
/**
* Blob service operation hint to the producer.
*
* The option is a:
* <code>org.apache.camel.component.azure.blob.BlobServiceOperations</code> type.
*
* Group: producer
*/
default BlobServiceEndpointProducerBuilder operation(
BlobServiceOperations operation) {
doSetProperty("operation", operation);
return this;
}
/**
* Blob service operation hint to the producer.
*
* The option will be converted to a
* <code>org.apache.camel.component.azure.blob.BlobServiceOperations</code> type.
*
* Group: producer
*/
default BlobServiceEndpointProducerBuilder operation(String operation) {
doSetProperty("operation", operation);
return this;
}
/**
* Set the size of the buffer for writing block and page blocks.
*
* The option is a: <code>int</code> type.
*
* Group: producer
*/
default BlobServiceEndpointProducerBuilder streamWriteSize(
int streamWriteSize) {
doSetProperty("streamWriteSize", streamWriteSize);
return this;
}
/**
* Set the size of the buffer for writing block and page blocks.
*
* The option will be converted to a <code>int</code> type.
*
* Group: producer
*/
default BlobServiceEndpointProducerBuilder streamWriteSize(
String streamWriteSize) {
doSetProperty("streamWriteSize", streamWriteSize);
return this;
}
/**
* Specify if the flat or hierarchical blob listing should be used.
*
* The option is a: <code>boolean</code> type.
*
* Group: producer
*/
default BlobServiceEndpointProducerBuilder useFlatListing(
boolean useFlatListing) {
doSetProperty("useFlatListing", useFlatListing);
return this;
}
/**
* Specify if the flat or hierarchical blob listing should be used.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: producer
*/
default BlobServiceEndpointProducerBuilder useFlatListing(
String useFlatListing) {
doSetProperty("useFlatListing", useFlatListing);
return this;
}
}
/**
* Advanced builder for endpoint producers for the Azure Storage Blob
* Service component.
*/
public interface AdvancedBlobServiceEndpointProducerBuilder
extends
EndpointProducerBuilder {
default BlobServiceEndpointProducerBuilder basic() {
return (BlobServiceEndpointProducerBuilder) this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedBlobServiceEndpointProducerBuilder basicPropertyBinding(
boolean basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedBlobServiceEndpointProducerBuilder basicPropertyBinding(
String basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedBlobServiceEndpointProducerBuilder synchronous(
boolean synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedBlobServiceEndpointProducerBuilder synchronous(
String synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
}
/**
* Builder for endpoint for the Azure Storage Blob Service component.
*/
public interface BlobServiceEndpointBuilder
extends
BlobServiceEndpointConsumerBuilder, BlobServiceEndpointProducerBuilder {
default AdvancedBlobServiceEndpointBuilder advanced() {
return (AdvancedBlobServiceEndpointBuilder) this;
}
/**
* The blob service client.
*
* The option is a:
* <code>com.microsoft.azure.storage.blob.CloudBlob</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder azureBlobClient(
Object azureBlobClient) {
doSetProperty("azureBlobClient", azureBlobClient);
return this;
}
/**
* The blob service client.
*
* The option will be converted to a
* <code>com.microsoft.azure.storage.blob.CloudBlob</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder azureBlobClient(
String azureBlobClient) {
doSetProperty("azureBlobClient", azureBlobClient);
return this;
}
/**
* Set the blob offset for the upload or download operations, default is
* 0.
*
* The option is a: <code>java.lang.Long</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder blobOffset(Long blobOffset) {
doSetProperty("blobOffset", blobOffset);
return this;
}
/**
* Set the blob offset for the upload or download operations, default is
* 0.
*
* The option will be converted to a <code>java.lang.Long</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder blobOffset(String blobOffset) {
doSetProperty("blobOffset", blobOffset);
return this;
}
/**
* Set a blob type, 'blockblob' is default.
*
* The option is a:
* <code>org.apache.camel.component.azure.blob.BlobType</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder blobType(BlobType blobType) {
doSetProperty("blobType", blobType);
return this;
}
/**
* Set a blob type, 'blockblob' is default.
*
* The option will be converted to a
* <code>org.apache.camel.component.azure.blob.BlobType</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder blobType(String blobType) {
doSetProperty("blobType", blobType);
return this;
}
/**
* Close the stream after read or keep it open, default is true.
*
* The option is a: <code>boolean</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder closeStreamAfterRead(
boolean closeStreamAfterRead) {
doSetProperty("closeStreamAfterRead", closeStreamAfterRead);
return this;
}
/**
* Close the stream after read or keep it open, default is true.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder closeStreamAfterRead(
String closeStreamAfterRead) {
doSetProperty("closeStreamAfterRead", closeStreamAfterRead);
return this;
}
/**
* Set the storage credentials, required in most cases.
*
* The option is a:
* <code>com.microsoft.azure.storage.StorageCredentials</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder credentials(Object credentials) {
doSetProperty("credentials", credentials);
return this;
}
/**
* Set the storage credentials, required in most cases.
*
* The option will be converted to a
* <code>com.microsoft.azure.storage.StorageCredentials</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder credentials(String credentials) {
doSetProperty("credentials", credentials);
return this;
}
/**
* Set the data length for the download or page blob upload operations.
*
* The option is a: <code>java.lang.Long</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder dataLength(Long dataLength) {
doSetProperty("dataLength", dataLength);
return this;
}
/**
* Set the data length for the download or page blob upload operations.
*
* The option will be converted to a <code>java.lang.Long</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder dataLength(String dataLength) {
doSetProperty("dataLength", dataLength);
return this;
}
/**
* Set the file directory where the downloaded blobs will be saved to.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder fileDir(String fileDir) {
doSetProperty("fileDir", fileDir);
return this;
}
/**
* Storage resources can be public for reading their content, if this
* property is enabled then the credentials do not have to be set.
*
* The option is a: <code>boolean</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder publicForRead(boolean publicForRead) {
doSetProperty("publicForRead", publicForRead);
return this;
}
/**
* Storage resources can be public for reading their content, if this
* property is enabled then the credentials do not have to be set.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder publicForRead(String publicForRead) {
doSetProperty("publicForRead", publicForRead);
return this;
}
/**
* Set the minimum read size in bytes when reading the blob content.
*
* The option is a: <code>int</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder streamReadSize(int streamReadSize) {
doSetProperty("streamReadSize", streamReadSize);
return this;
}
/**
* Set the minimum read size in bytes when reading the blob content.
*
* The option will be converted to a <code>int</code> type.
*
* Group: common
*/
default BlobServiceEndpointBuilder streamReadSize(String streamReadSize) {
doSetProperty("streamReadSize", streamReadSize);
return this;
}
}
/**
* Advanced builder for endpoint for the Azure Storage Blob Service
* component.
*/
public interface AdvancedBlobServiceEndpointBuilder
extends
AdvancedBlobServiceEndpointConsumerBuilder, AdvancedBlobServiceEndpointProducerBuilder {
default BlobServiceEndpointBuilder basic() {
return (BlobServiceEndpointBuilder) this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedBlobServiceEndpointBuilder basicPropertyBinding(
boolean basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedBlobServiceEndpointBuilder basicPropertyBinding(
String basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedBlobServiceEndpointBuilder synchronous(
boolean synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedBlobServiceEndpointBuilder synchronous(
String synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
}
/**
* Proxy enum for
* <code>org.apache.camel.component.azure.blob.BlobType</code> enum.
*/
enum BlobType {
blockblob,
appendblob,
pageblob;
}
/**
* Proxy enum for
* <code>org.apache.camel.component.azure.blob.BlobServiceOperations</code>
* enum.
*/
enum BlobServiceOperations {
getBlob,
deleteBlob,
listBlobs,
updateBlockBlob,
uploadBlobBlocks,
commitBlobBlockList,
getBlobBlockList,
createAppendBlob,
updateAppendBlob,
createPageBlob,
updatePageBlob,
resizePageBlob,
clearPageBlob,
getPageBlobRanges;
}
/**
* Azure Storage Blob Service (camel-azure)
* The azure-blob component is used for storing and retrieving blobs from
* Azure Storage Blob Service.
*
* Category: cloud,database,nosql
* Since: 2.19
* Maven coordinates: org.apache.camel:camel-azure
*
* Syntax: <code>azure-blob:containerOrBlobUri</code>
*
* Path parameter: containerOrBlobUri (required)
* Container or Blob compact Uri
*/
default BlobServiceEndpointBuilder azureBlob(String path) {
class BlobServiceEndpointBuilderImpl extends AbstractEndpointBuilder implements BlobServiceEndpointBuilder, AdvancedBlobServiceEndpointBuilder {
public BlobServiceEndpointBuilderImpl(String path) {
super("azure-blob", path);
}
}
return new BlobServiceEndpointBuilderImpl(path);
}
}