-
Notifications
You must be signed in to change notification settings - Fork 165
/
azure-storage-blob.json
253 lines (253 loc) · 16.3 KB
/
azure-storage-blob.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
{
"groups": [
{
"name": "camel.component.azure-storage-blob",
"type": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.customizer",
"type": "org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon$CustomizerProperties",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"sourceMethod": "getCustomizer()"
}
],
"properties": [
{
"name": "camel.component.azure-storage-blob.access-key",
"type": "java.lang.String",
"description": "Access key for the associated azure account name to be used for authentication with azure blob services",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.autowired-enabled",
"type": "java.lang.Boolean",
"description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"defaultValue": true
},
{
"name": "camel.component.azure-storage-blob.blob-name",
"type": "java.lang.String",
"description": "The blob name, to consume specific blob from a container. However, on producer it is only required for the operations on the blob level",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.blob-offset",
"type": "java.lang.Long",
"description": "Set the blob offset for the upload or download operations, default is 0",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"defaultValue": 0
},
{
"name": "camel.component.azure-storage-blob.blob-sequence-number",
"type": "java.lang.Long",
"description": "A user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 263 - 1.The default value is 0.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"defaultValue": 0
},
{
"name": "camel.component.azure-storage-blob.blob-type",
"type": "org.apache.camel.component.azure.storage.blob.BlobType",
"description": "The blob type in order to initiate the appropriate settings for each blob type",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.block-list-type",
"type": "com.azure.storage.blob.models.BlockListType",
"description": "Specifies which type of blocks to return.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.bridge-error-handler",
"type": "java.lang.Boolean",
"description": "Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"defaultValue": false
},
{
"name": "camel.component.azure-storage-blob.change-feed-context",
"type": "com.azure.core.util.Context",
"description": "When using getChangeFeed producer operation, this gives additional context that is passed through the Http pipeline during the service call. The option is a com.azure.core.util.Context type.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.change-feed-end-time",
"type": "java.time.OffsetDateTime",
"description": "When using getChangeFeed producer operation, this filters the results to return events approximately before the end time. Note: A few events belonging to the next hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the end time up by an hour.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.change-feed-start-time",
"type": "java.time.OffsetDateTime",
"description": "When using getChangeFeed producer operation, this filters the results to return events approximately after the start time. Note: A few events belonging to the previous hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the start time down by an hour.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.close-stream-after-read",
"type": "java.lang.Boolean",
"description": "Close the stream after read or keep it open, default is true",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"defaultValue": true
},
{
"name": "camel.component.azure-storage-blob.close-stream-after-write",
"type": "java.lang.Boolean",
"description": "Close the stream after write or keep it open, default is true",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"defaultValue": true
},
{
"name": "camel.component.azure-storage-blob.commit-block-list-later",
"type": "java.lang.Boolean",
"description": "When is set to true, the staged blocks will not be committed directly.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"defaultValue": true
},
{
"name": "camel.component.azure-storage-blob.configuration",
"type": "org.apache.camel.component.azure.storage.blob.BlobConfiguration",
"description": "The component configurations. The option is a org.apache.camel.component.azure.storage.blob.BlobConfiguration type.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.create-append-blob",
"type": "java.lang.Boolean",
"description": "When is set to true, the append blocks will be created when committing append blocks.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"defaultValue": true
},
{
"name": "camel.component.azure-storage-blob.create-page-blob",
"type": "java.lang.Boolean",
"description": "When is set to true, the page blob will be created when uploading page blob.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"defaultValue": true
},
{
"name": "camel.component.azure-storage-blob.credential-type",
"type": "org.apache.camel.component.azure.storage.blob.CredentialType",
"description": "Determines the credential strategy to adopt",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.credentials",
"type": "com.azure.storage.common.StorageSharedKeyCredential",
"description": "StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information. The option is a com.azure.storage.common.StorageSharedKeyCredential type.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.customizer.enabled",
"type": "java.lang.Boolean",
"sourceType": "org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon$CustomizerProperties"
},
{
"name": "camel.component.azure-storage-blob.data-count",
"type": "java.lang.Long",
"description": "How many bytes to include in the range. Must be greater than or equal to 0 if specified.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.download-link-expiration",
"type": "java.lang.Long",
"description": "Override the default expiration (millis) of URL download link.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.enabled",
"type": "java.lang.Boolean",
"description": "Whether to enable auto configuration of the azure-storage-blob component. This is enabled by default.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.file-dir",
"type": "java.lang.String",
"description": "The file directory where the downloaded blobs will be saved to, this can be used in both, producer and consumer",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.health-check-consumer-enabled",
"type": "java.lang.Boolean",
"description": "Used for enabling or disabling all consumer based health checks from this component",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"defaultValue": true
},
{
"name": "camel.component.azure-storage-blob.health-check-producer-enabled",
"type": "java.lang.Boolean",
"description": "Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"defaultValue": true
},
{
"name": "camel.component.azure-storage-blob.lazy-start-producer",
"type": "java.lang.Boolean",
"description": "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.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"defaultValue": false
},
{
"name": "camel.component.azure-storage-blob.max-results-per-page",
"type": "java.lang.Integer",
"description": "Specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxResultsPerPage or specifies a value greater than 5,000, the server will return up to 5,000 items.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.max-retry-requests",
"type": "java.lang.Integer",
"description": "Specifies the maximum number of additional HTTP Get requests that will be made while reading the data from a response body.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"defaultValue": 0
},
{
"name": "camel.component.azure-storage-blob.operation",
"type": "org.apache.camel.component.azure.storage.blob.BlobOperationsDefinition",
"description": "The blob operation that can be used with this component on the producer",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.page-blob-size",
"type": "java.lang.Long",
"description": "Specifies the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a 512-byte boundary.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration",
"defaultValue": 512
},
{
"name": "camel.component.azure-storage-blob.prefix",
"type": "java.lang.String",
"description": "Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.regex",
"type": "java.lang.String",
"description": "Filters the results to return only blobs whose names match the specified regular expression. May be null to return all if both prefix and regex are set, regex takes the priority and prefix is ignored.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.sas-token",
"type": "java.lang.String",
"description": "In case of usage of Shared Access Signature we'll need to set a SAS Token",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.service-client",
"type": "com.azure.storage.blob.BlobServiceClient",
"description": "Client to a storage account. 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. It may also be used to construct URLs to blobs and containers. This client contains operations on a service account. Operations on a container are available on BlobContainerClient through BlobServiceClient#getBlobContainerClient(String), and operations on a blob are available on BlobClient through BlobContainerClient#getBlobClient(String). The option is a com.azure.storage.blob.BlobServiceClient type.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.source-blob-access-key",
"type": "java.lang.String",
"description": "Source Blob Access Key: for copyblob operation, sadly, we need to have an accessKey for the source blob we want to copy Passing an accessKey as header, it's unsafe so we could set as key.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
},
{
"name": "camel.component.azure-storage-blob.timeout",
"type": "java.time.Duration",
"description": "An optional timeout value beyond which a RuntimeException will be raised.",
"sourceType": "org.apache.camel.component.azure.storage.blob.springboot.BlobComponentConfiguration"
}
],
"hints": []
}