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

Interface IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

IBMCOSEndpointBuilderFactory.IBMCOSEndpointBuilder

Enclosing interface:

IBMCOSEndpointBuilderFactory

public static interface IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the IBM Cloud Object Storage component.

Method Summary

Modifier and Type	Method	Description
default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointProducerBuilder	advanced()
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	apiKey(String apiKey)	IBM Cloud API Key for authentication.
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	autoCreateBucket(boolean autoCreateBucket)	Automatically create the bucket if it doesn't exist.
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	autoCreateBucket(String autoCreateBucket)	Automatically create the bucket if it doesn't exist.
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	deleteAfterWrite(boolean deleteAfterWrite)	Delete the object from the local filesystem after uploading.
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	deleteAfterWrite(String deleteAfterWrite)	Delete the object from the local filesystem after uploading.
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	delimiter(String delimiter)	The delimiter to use for listing objects.
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	endpointUrl(String endpointUrl)	IBM COS Endpoint URL (e.g., https://s3.us-south.cloud-object-storage.appdomain.cloud) Note that some operations requires to use a regional endpoint URL instead of a cross-region one.
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	keyName(String keyName)	The key name for the object.
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	location(String location)	IBM COS Location/Region (e.g., us-south, eu-gb).
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	multiPartUpload(boolean multiPartUpload)	Use multi-part upload for large files.
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	multiPartUpload(String multiPartUpload)	Use multi-part upload for large files.
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	operation(String operation)	The operation to perform.
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	operation(org.apache.camel.component.ibm.cos.IBMCOSOperations operation)	The operation to perform.
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	partSize(long partSize)	Part size for multi-part uploads (default 25MB).
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	partSize(String partSize)	Part size for multi-part uploads (default 25MB).
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	prefix(String prefix)	The prefix to use for listing objects.
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	serviceInstanceId(String serviceInstanceId)	IBM COS Service Instance ID (CRN).
default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder	storageClass(String storageClass)	The storage class to use when storing objects (e.g., STANDARD, VAULT, COLD, FLEX).

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Details

advanced

default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointProducerBuilder advanced()

autoCreateBucket

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder autoCreateBucket(boolean autoCreateBucket)

Automatically create the bucket if it doesn't exist. The option is a: boolean type. Default: false Group: common

Parameters:

autoCreateBucket - the value to set

Returns:

the dsl builder

autoCreateBucket

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder autoCreateBucket(String autoCreateBucket)

Automatically create the bucket if it doesn't exist. The option will be converted to a boolean type. Default: false Group: common

Parameters:

autoCreateBucket - the value to set

Returns:

the dsl builder

delimiter

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder delimiter(String delimiter)

The delimiter to use for listing objects. The option is a: java.lang.String type. Group: common

Parameters:

delimiter - the value to set

Returns:

the dsl builder

endpointUrl

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder endpointUrl(String endpointUrl)

IBM COS Endpoint URL (e.g., https://s3.us-south.cloud-object-storage.appdomain.cloud) Note that some operations requires to use a regional endpoint URL instead of a cross-region one. The option is a: java.lang.String type. Group: common

Parameters:

endpointUrl - the value to set

Returns:

the dsl builder

location

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder location(String location)

IBM COS Location/Region (e.g., us-south, eu-gb). The option is a: java.lang.String type. Group: common

Parameters:

location - the value to set

Returns:

the dsl builder

prefix

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder prefix(String prefix)

The prefix to use for listing objects. The option is a: java.lang.String type. Group: common

Parameters:

prefix - the value to set

Returns:

the dsl builder

deleteAfterWrite

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder deleteAfterWrite(boolean deleteAfterWrite)

Delete the object from the local filesystem after uploading. The option is a: boolean type. Default: false Group: producer

Parameters:

deleteAfterWrite - the value to set

Returns:

the dsl builder

deleteAfterWrite

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder deleteAfterWrite(String deleteAfterWrite)

Delete the object from the local filesystem after uploading. The option will be converted to a boolean type. Default: false Group: producer

Parameters:

deleteAfterWrite - the value to set

Returns:

the dsl builder

keyName

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder keyName(String keyName)

The key name for the object. The option is a: java.lang.String type. Group: producer

Parameters:

keyName - the value to set

Returns:

the dsl builder

multiPartUpload

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder multiPartUpload(boolean multiPartUpload)

Use multi-part upload for large files. The option is a: boolean type. Default: false Group: producer

Parameters:

multiPartUpload - the value to set

Returns:

the dsl builder

multiPartUpload

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder multiPartUpload(String multiPartUpload)

Use multi-part upload for large files. The option will be converted to a boolean type. Default: false Group: producer

Parameters:

multiPartUpload - the value to set

Returns:

the dsl builder

operation

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder operation(org.apache.camel.component.ibm.cos.IBMCOSOperations operation)

The operation to perform. The option is a: org.apache.camel.component.ibm.cos.IBMCOSOperations type. Group: producer

Parameters:

operation - the value to set

Returns:

the dsl builder

operation

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder operation(String operation)

The operation to perform. The option will be converted to a org.apache.camel.component.ibm.cos.IBMCOSOperations type. Group: producer

Parameters:

operation - the value to set

Returns:

the dsl builder

partSize

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder partSize(long partSize)

Part size for multi-part uploads (default 25MB). The option is a: long type. Default: 26214400 Group: producer

Parameters:

partSize - the value to set

Returns:

the dsl builder

partSize

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder partSize(String partSize)

Part size for multi-part uploads (default 25MB). The option will be converted to a long type. Default: 26214400 Group: producer

Parameters:

partSize - the value to set

Returns:

the dsl builder

storageClass

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder storageClass(String storageClass)

The storage class to use when storing objects (e.g., STANDARD, VAULT, COLD, FLEX). The option is a: java.lang.String type. Group: producer

Parameters:

storageClass - the value to set

Returns:

the dsl builder

apiKey

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder apiKey(String apiKey)

IBM Cloud API Key for authentication. The option is a: java.lang.String type. Group: security

Parameters:

apiKey - the value to set

Returns:

the dsl builder

serviceInstanceId

default IBMCOSEndpointBuilderFactory.IBMCOSEndpointProducerBuilder serviceInstanceId(String serviceInstanceId)

IBM COS Service Instance ID (CRN). The option is a: java.lang.String type. Group: security

Parameters:

serviceInstanceId - the value to set

Returns:

the dsl builder