blob: 5b43e09464c7d103b81d673a7b1ce49513e458e8 [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 javax.annotation.Generated;
import org.apache.camel.builder.EndpointConsumerBuilder;
import org.apache.camel.builder.EndpointProducerBuilder;
import org.apache.camel.builder.endpoint.AbstractEndpointBuilder;
/**
* The aws-eks is used for managing Amazon EKS
*
* Generated by camel-package-maven-plugin - do not edit this file!
*/
@Generated("org.apache.camel.maven.packaging.EndpointDslMojo")
public interface EKSEndpointBuilderFactory {
/**
* Builder for endpoint for the AWS EKS component.
*/
public interface EKSEndpointBuilder extends EndpointProducerBuilder {
default AdvancedEKSEndpointBuilder advanced() {
return (AdvancedEKSEndpointBuilder) this;
}
/**
* Amazon AWS Access Key.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: producer
*/
default EKSEndpointBuilder accessKey(String accessKey) {
doSetProperty("accessKey", accessKey);
return this;
}
/**
* To use a existing configured AWS EKS as client.
*
* The option is a: <code>com.amazonaws.services.eks.AmazonEKS</code>
* type.
*
* Group: producer
*/
default EKSEndpointBuilder eksClient(Object eksClient) {
doSetProperty("eksClient", eksClient);
return this;
}
/**
* To use a existing configured AWS EKS as client.
*
* The option will be converted to a
* <code>com.amazonaws.services.eks.AmazonEKS</code> type.
*
* Group: producer
*/
default EKSEndpointBuilder eksClient(String eksClient) {
doSetProperty("eksClient", eksClient);
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 EKSEndpointBuilder 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 EKSEndpointBuilder lazyStartProducer(String lazyStartProducer) {
doSetProperty("lazyStartProducer", lazyStartProducer);
return this;
}
/**
* The operation to perform.
*
* The option is a:
* <code>org.apache.camel.component.aws.eks.EKSOperations</code> type.
*
* Required: true
* Group: producer
*/
default EKSEndpointBuilder operation(EKSOperations operation) {
doSetProperty("operation", operation);
return this;
}
/**
* The operation to perform.
*
* The option will be converted to a
* <code>org.apache.camel.component.aws.eks.EKSOperations</code> type.
*
* Required: true
* Group: producer
*/
default EKSEndpointBuilder operation(String operation) {
doSetProperty("operation", operation);
return this;
}
/**
* To define a proxy host when instantiating the EKS client.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: producer
*/
default EKSEndpointBuilder proxyHost(String proxyHost) {
doSetProperty("proxyHost", proxyHost);
return this;
}
/**
* To define a proxy port when instantiating the EKS client.
*
* The option is a: <code>java.lang.Integer</code> type.
*
* Group: producer
*/
default EKSEndpointBuilder proxyPort(Integer proxyPort) {
doSetProperty("proxyPort", proxyPort);
return this;
}
/**
* To define a proxy port when instantiating the EKS client.
*
* The option will be converted to a <code>java.lang.Integer</code>
* type.
*
* Group: producer
*/
default EKSEndpointBuilder proxyPort(String proxyPort) {
doSetProperty("proxyPort", proxyPort);
return this;
}
/**
* To define a proxy protocol when instantiating the EKS client.
*
* The option is a: <code>com.amazonaws.Protocol</code> type.
*
* Group: producer
*/
default EKSEndpointBuilder proxyProtocol(Protocol proxyProtocol) {
doSetProperty("proxyProtocol", proxyProtocol);
return this;
}
/**
* To define a proxy protocol when instantiating the EKS client.
*
* The option will be converted to a <code>com.amazonaws.Protocol</code>
* type.
*
* Group: producer
*/
default EKSEndpointBuilder proxyProtocol(String proxyProtocol) {
doSetProperty("proxyProtocol", proxyProtocol);
return this;
}
/**
* The region in which EKS client needs to work. When using this
* parameter, the configuration will expect the capitalized name of the
* region (for example AP_EAST_1) You'll need to use the name
* Regions.EU_WEST_1.name().
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: producer
*/
default EKSEndpointBuilder region(String region) {
doSetProperty("region", region);
return this;
}
/**
* Amazon AWS Secret Key.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: producer
*/
default EKSEndpointBuilder secretKey(String secretKey) {
doSetProperty("secretKey", secretKey);
return this;
}
}
/**
* Advanced builder for endpoint for the AWS EKS component.
*/
public interface AdvancedEKSEndpointBuilder
extends
EndpointProducerBuilder {
default EKSEndpointBuilder basic() {
return (EKSEndpointBuilder) 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 AdvancedEKSEndpointBuilder 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 AdvancedEKSEndpointBuilder 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 AdvancedEKSEndpointBuilder 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 AdvancedEKSEndpointBuilder synchronous(String synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
}
/**
* Proxy enum for
* <code>org.apache.camel.component.aws.eks.EKSOperations</code> enum.
*/
enum EKSOperations {
listClusters,
describeCluster,
createCluster,
deleteCluster;
}
/**
* Proxy enum for <code>com.amazonaws.Protocol</code> enum.
*/
enum Protocol {
http,
https;
}
/**
* AWS EKS (camel-aws-eks)
* The aws-eks is used for managing Amazon EKS
*
* Category: cloud,management
* Since: 3.0
* Maven coordinates: org.apache.camel:camel-aws-eks
*
* Syntax: <code>aws-eks:label</code>
*
* Path parameter: label (required)
* Logical name
*/
default EKSEndpointBuilder awsEks(String path) {
class EKSEndpointBuilderImpl extends AbstractEndpointBuilder implements EKSEndpointBuilder, AdvancedEKSEndpointBuilder {
public EKSEndpointBuilderImpl(String path) {
super("aws-eks", path);
}
}
return new EKSEndpointBuilderImpl(path);
}
}