blob: d27fdb0dc183d379e7f24d06f2f3b338249fce6f [file] [log] [blame]
{"component":{"kind":"component","name":"digitalocean","title":"DigitalOcean","description":"Manage Droplets and resources within the DigitalOcean cloud.","deprecated":false,"firstVersion":"2.19.0","label":"cloud,management","javaType":"org.apache.camel.component.digitalocean.DigitalOceanComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-digitalocean","version":"3.18.1","scheme":"digitalocean","extendsScheme":"","syntax":"digitalocean:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelDigitalOceanOperation":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.digitalocean.constants.DigitalOceanOperations","enum":["create","update","delete","list","ownList","get","listBackups","listActions","listNeighbors","listSnapshots","listKernels","listAllNeighbors","enableBackups","disableBackups","reboot","powerCycle","shutdown","powerOn","powerOff","restore","resetPassword","resize","rebuild","rename","changeKernel","enableIpv6","enablePrivateNetworking","takeSnapshot","transfer","convert","attach","detach","assign","unassign","tag","untag"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#OPERATION"},"CamelDigitalOceanId":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#ID"},"CamelDigitalOceanType":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.digitalocean.constants.DigitalOceanImageTypes","enum":["distribution","application"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#TYPE"},"CamelDigitalOceanName":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#NAME"},"CamelDigitalOceanNames":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List<String>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The names of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#NAMES"},"CamelDigitalOceanRegion":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The code name of the region aka DigitalOcean data centers","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#REGION"},"CamelDigitalOceanDescription":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The description","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DESCRIPTION"},"CamelDigitalOceanDropletSize":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_SIZE"},"CamelDigitalOceanDropletImage":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The image of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_IMAGE"},"CamelDigitalOceanDropletSSHKeys":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List<String>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The keys of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_KEYS"},"CamelDigitalOceanDropletEnableBackups":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag to enable backups","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_ENABLE_BACKUPS"},"CamelDigitalOceanDropletEnableIpv6":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag to enable ipv6","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_ENABLE_IPV6"},"CamelDigitalOceanDropletEnablePrivateNetworking":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag to enable private networking","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_ENABLE_PRIVATE_NETWORKING"},"CamelDigitalOceanDropletUserData":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The user data of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_USER_DATA"},"CamelDigitalOceanDropletVolumes":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List<String>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The volumes' identifier of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_VOLUMES"},"CamelDigitalOceanDropletTags":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List<String>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The tags of the droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_TAGS"},"CamelDigitalOceanDropletId":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The droplet identifier","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#DROPLET_ID"},"CamelDigitalOceanImageId":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the DigitalOcean public image or your private image","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#IMAGE_ID"},"CamelDigitalOceanKernelId":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The kernel id to be changed for droplet","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#KERNEL_ID"},"CamelDigitalOceanVolumeName":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the volume","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#VOLUME_NAME"},"CamelDigitalOceanVolumeSizeGigabytes":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer or Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size value in GB","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#VOLUME_SIZE_GIGABYTES"},"CamelDigitalOceanFloatingIPAddress":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The floating IP address","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#FLOATING_IP_ADDRESS"},"CamelDigitalOceanKeyFingerprint":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The SSH key fingerprint","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#KEY_FINGERPRINT"},"CamelDigitalOceanKeyPublicKey":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The public key","constantName":"org.apache.camel.component.digitalocean.constants.DigitalOceanHeaders#KEY_PUBLIC_KEY"}},"properties":{"operation":{"kind":"path","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.digitalocean.constants.DigitalOceanOperations","enum":["create","update","delete","list","ownList","get","listBackups","listActions","listNeighbors","listSnapshots","listKernels","listAllNeighbors","enableBackups","disableBackups","reboot","powerCycle","shutdown","powerOn","powerOff","restore","resetPassword","resize","rebuild","rename","changeKernel","enableIpv6","enablePrivateNetworking","takeSnapshot","transfer","convert","attach","detach","assign","unassign","tag","untag"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"The operation to perform to the given resource."},"page":{"kind":"parameter","displayName":"Page","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1","configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Use for pagination. Force the page number."},"perPage":{"kind":"parameter","displayName":"Per Page","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"25","configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Use for pagination. Set the number of item per request. The maximum number of results per page is 200."},"resource":{"kind":"parameter","displayName":"Resource","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.digitalocean.constants.DigitalOceanResources","enum":["account","actions","blockStorages","droplets","mages","snapshots","keys","regions","sizes","floatingIPs","tags"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"The DigitalOcean resource type on which perform the operation."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"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."},"digitalOceanClient":{"kind":"parameter","displayName":"Digital Ocean Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.myjeeva.digitalocean.impl.DigitalOceanClient","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"To use a existing configured DigitalOceanClient as client"},"httpProxyHost":{"kind":"parameter","displayName":"Http Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Set a proxy host if needed"},"httpProxyPassword":{"kind":"parameter","displayName":"Http Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Set a proxy password if needed"},"httpProxyPort":{"kind":"parameter","displayName":"Http Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Set a proxy port if needed"},"httpProxyUser":{"kind":"parameter","displayName":"Http Proxy User","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"Set a proxy host if needed"},"oAuthToken":{"kind":"parameter","displayName":"OAuth Token","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.digitalocean.DigitalOceanConfiguration","configurationField":"configuration","description":"DigitalOcean OAuth Token"}}}