diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-transcribe.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-transcribe.json index 5f32ba2efeebd..c80db2b3fefc6 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-transcribe.json +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-transcribe.json @@ -30,7 +30,7 @@ "overrideEndpoint": { "index": 3, "kind": "property", "displayName": "Override Endpoint", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option" }, "pojoRequest": { "index": 4, "kind": "property", "displayName": "Pojo Request", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "If we want to use a POJO request as body or not" }, "profileCredentialsName": { "index": 5, "kind": "property", "displayName": "Profile Credentials Name", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "If using a profile credentials provider this parameter will set the profile name." }, - "protocol": { "index": 6, "kind": "property", "displayName": "Protocol", "group": "producer", "label": "", "required": false, "type": "enum", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the Transcribe client" }, + "protocol": { "index": 6, "kind": "property", "displayName": "Protocol", "group": "producer", "label": "", "required": false, "type": "enum", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": true, "deprecationNote": "Not used: nothing reads this option when the Transcribe client is built", "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "The protocol to use when instantiating the Transcribe client. Deprecation note: Not used: nothing reads this option when the Transcribe client is built" }, "proxyHost": { "index": 7, "kind": "property", "displayName": "Proxy Host", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the Transcribe client" }, "proxyPort": { "index": 8, "kind": "property", "displayName": "Proxy Port", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the Transcribe client" }, "proxyProtocol": { "index": 9, "kind": "property", "displayName": "Proxy Protocol", "group": "producer", "label": "", "required": false, "type": "enum", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the Transcribe client" }, @@ -83,7 +83,7 @@ "overrideEndpoint": { "index": 2, "kind": "parameter", "displayName": "Override Endpoint", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option" }, "pojoRequest": { "index": 3, "kind": "parameter", "displayName": "Pojo Request", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "If we want to use a POJO request as body or not" }, "profileCredentialsName": { "index": 4, "kind": "parameter", "displayName": "Profile Credentials Name", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "If using a profile credentials provider this parameter will set the profile name." }, - "protocol": { "index": 5, "kind": "parameter", "displayName": "Protocol", "group": "producer", "label": "", "required": false, "type": "enum", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the Transcribe client" }, + "protocol": { "index": 5, "kind": "parameter", "displayName": "Protocol", "group": "producer", "label": "", "required": false, "type": "enum", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": true, "deprecationNote": "Not used: nothing reads this option when the Transcribe client is built", "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "The protocol to use when instantiating the Transcribe client. Deprecation note: Not used: nothing reads this option when the Transcribe client is built" }, "proxyHost": { "index": 6, "kind": "parameter", "displayName": "Proxy Host", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the Transcribe client" }, "proxyPort": { "index": 7, "kind": "parameter", "displayName": "Proxy Port", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the Transcribe client" }, "proxyProtocol": { "index": 8, "kind": "parameter", "displayName": "Proxy Protocol", "group": "producer", "label": "", "required": false, "type": "enum", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the Transcribe client" }, diff --git a/components/camel-aws/camel-aws2-transcribe/src/generated/resources/META-INF/org/apache/camel/component/aws2/transcribe/aws2-transcribe.json b/components/camel-aws/camel-aws2-transcribe/src/generated/resources/META-INF/org/apache/camel/component/aws2/transcribe/aws2-transcribe.json index 5f32ba2efeebd..c80db2b3fefc6 100644 --- a/components/camel-aws/camel-aws2-transcribe/src/generated/resources/META-INF/org/apache/camel/component/aws2/transcribe/aws2-transcribe.json +++ b/components/camel-aws/camel-aws2-transcribe/src/generated/resources/META-INF/org/apache/camel/component/aws2/transcribe/aws2-transcribe.json @@ -30,7 +30,7 @@ "overrideEndpoint": { "index": 3, "kind": "property", "displayName": "Override Endpoint", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option" }, "pojoRequest": { "index": 4, "kind": "property", "displayName": "Pojo Request", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "If we want to use a POJO request as body or not" }, "profileCredentialsName": { "index": 5, "kind": "property", "displayName": "Profile Credentials Name", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "If using a profile credentials provider this parameter will set the profile name." }, - "protocol": { "index": 6, "kind": "property", "displayName": "Protocol", "group": "producer", "label": "", "required": false, "type": "enum", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the Transcribe client" }, + "protocol": { "index": 6, "kind": "property", "displayName": "Protocol", "group": "producer", "label": "", "required": false, "type": "enum", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": true, "deprecationNote": "Not used: nothing reads this option when the Transcribe client is built", "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "The protocol to use when instantiating the Transcribe client. Deprecation note: Not used: nothing reads this option when the Transcribe client is built" }, "proxyHost": { "index": 7, "kind": "property", "displayName": "Proxy Host", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the Transcribe client" }, "proxyPort": { "index": 8, "kind": "property", "displayName": "Proxy Port", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the Transcribe client" }, "proxyProtocol": { "index": 9, "kind": "property", "displayName": "Proxy Protocol", "group": "producer", "label": "", "required": false, "type": "enum", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the Transcribe client" }, @@ -83,7 +83,7 @@ "overrideEndpoint": { "index": 2, "kind": "parameter", "displayName": "Override Endpoint", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option" }, "pojoRequest": { "index": 3, "kind": "parameter", "displayName": "Pojo Request", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "If we want to use a POJO request as body or not" }, "profileCredentialsName": { "index": 4, "kind": "parameter", "displayName": "Profile Credentials Name", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "If using a profile credentials provider this parameter will set the profile name." }, - "protocol": { "index": 5, "kind": "parameter", "displayName": "Protocol", "group": "producer", "label": "", "required": false, "type": "enum", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the Transcribe client" }, + "protocol": { "index": 5, "kind": "parameter", "displayName": "Protocol", "group": "producer", "label": "", "required": false, "type": "enum", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": true, "deprecationNote": "Not used: nothing reads this option when the Transcribe client is built", "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "The protocol to use when instantiating the Transcribe client. Deprecation note: Not used: nothing reads this option when the Transcribe client is built" }, "proxyHost": { "index": 6, "kind": "parameter", "displayName": "Proxy Host", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the Transcribe client" }, "proxyPort": { "index": 7, "kind": "parameter", "displayName": "Proxy Port", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the Transcribe client" }, "proxyProtocol": { "index": 8, "kind": "parameter", "displayName": "Proxy Protocol", "group": "producer", "label": "", "required": false, "type": "enum", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws2.transcribe.Transcribe2Configuration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the Transcribe client" }, diff --git a/components/camel-aws/camel-aws2-transcribe/src/main/java/org/apache/camel/component/aws2/transcribe/Transcribe2Configuration.java b/components/camel-aws/camel-aws2-transcribe/src/main/java/org/apache/camel/component/aws2/transcribe/Transcribe2Configuration.java index 1125854fd3bcd..e7d393d56341d 100644 --- a/components/camel-aws/camel-aws2-transcribe/src/main/java/org/apache/camel/component/aws2/transcribe/Transcribe2Configuration.java +++ b/components/camel-aws/camel-aws2-transcribe/src/main/java/org/apache/camel/component/aws2/transcribe/Transcribe2Configuration.java @@ -56,6 +56,8 @@ public class Transcribe2Configuration implements Cloneable, AwsCommonConfigurati @UriParam private String profileCredentialsName; @UriParam(enums = "HTTP,HTTPS", defaultValue = "HTTPS") + @Metadata(deprecationNote = "Not used: nothing reads this option when the Transcribe client is built") + @Deprecated private Protocol protocol = Protocol.HTTPS; @UriParam(label = "producer") private Transcribe2Operations operation; @@ -263,15 +265,21 @@ public void setProfileCredentialsName(String profileCredentialsName) { } /** - * To define a proxy protocol when instantiating the Transcribe client + * The protocol to use when instantiating the Transcribe client + * + * @deprecated Not used: nothing reads this option when the Transcribe client is built */ + @Deprecated public Protocol getProtocol() { return protocol; } /** - * To define a proxy protocol when instantiating the Transcribe client + * The protocol to use when instantiating the Transcribe client + * + * @deprecated Not used: nothing reads this option when the Transcribe client is built */ + @Deprecated public void setProtocol(Protocol protocol) { this.protocol = protocol; } diff --git a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc index e53d680725de2..e7cf4c4504522 100644 --- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc +++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc @@ -8106,3 +8106,14 @@ The `apiKeyHeader` option never had any effect: the name of the header that carr docling-serve client, which always sends it as `X-Api-Key`, and the producer never read the option. It is now deprecated, with a `deprecationNote` that says so. Remove `apiKeyHeader` from the endpoint URI or the configuration: with `authenticationScheme=API_KEY` and `authenticationToken` set, the key is still sent, as `X-Api-Key`. + +=== camel-aws2-transcribe - the protocol option is deprecated + +The `protocol` option never had any effect. Nothing reads it: the Transcribe client is built by the shared +`AwsClientBuilderUtil`, which takes the region, the endpoint override and the proxy settings, and `getProtocol()` is +called only by the generated configurer. Its description was also the one belonging to `proxyProtocol`, so it read as +if it configured the proxy. + +It is now deprecated, with a `deprecationNote` that says so, and its description no longer claims to configure a proxy. +Remove `protocol` from the endpoint URI or the configuration. To send the client's traffic through a proxy, use +`proxyProtocol` together with `proxyHost` and `proxyPort`, which the shared client builder does apply. diff --git a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/Aws2TranscribeComponentBuilderFactory.java b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/Aws2TranscribeComponentBuilderFactory.java index 9c57807fb4725..aa05cc5020388 100644 --- a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/Aws2TranscribeComponentBuilderFactory.java +++ b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/Aws2TranscribeComponentBuilderFactory.java @@ -160,7 +160,9 @@ default Aws2TranscribeComponentBuilder profileCredentialsName(java.lang.String p /** - * To define a proxy protocol when instantiating the Transcribe client. + * The protocol to use when instantiating the Transcribe client. + * Deprecation note: Not used: nothing reads this option when the + * Transcribe client is built. * * The option is a: * <code>software.amazon.awssdk.core.Protocol</code> type. @@ -171,6 +173,7 @@ default Aws2TranscribeComponentBuilder profileCredentialsName(java.lang.String p * @param protocol the value to set * @return the dsl builder */ + @Deprecated default Aws2TranscribeComponentBuilder protocol(software.amazon.awssdk.core.Protocol protocol) { doSetProperty("protocol", protocol); return this; diff --git a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/Transcribe2EndpointBuilderFactory.java b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/Transcribe2EndpointBuilderFactory.java index 656ad0618a2bb..d8bf92eeca5de 100644 --- a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/Transcribe2EndpointBuilderFactory.java +++ b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/Transcribe2EndpointBuilderFactory.java @@ -152,7 +152,9 @@ default Transcribe2EndpointBuilder profileCredentialsName(String profileCredenti return this; } /** - * To define a proxy protocol when instantiating the Transcribe client. + * The protocol to use when instantiating the Transcribe client. + * Deprecation note: Not used: nothing reads this option when the + * Transcribe client is built. * * The option is a: software.amazon.awssdk.core.Protocol * type. @@ -163,12 +165,15 @@ default Transcribe2EndpointBuilder profileCredentialsName(String profileCredenti * @param protocol the value to set * @return the dsl builder */ + @Deprecated default Transcribe2EndpointBuilder protocol(software.amazon.awssdk.core.Protocol protocol) { doSetProperty("protocol", protocol); return this; } /** - * To define a proxy protocol when instantiating the Transcribe client. + * The protocol to use when instantiating the Transcribe client. + * Deprecation note: Not used: nothing reads this option when the + * Transcribe client is built. * * The option will be converted to a * software.amazon.awssdk.core.Protocol type. @@ -179,6 +184,7 @@ default Transcribe2EndpointBuilder protocol(software.amazon.awssdk.core.Protocol * @param protocol the value to set * @return the dsl builder */ + @Deprecated default Transcribe2EndpointBuilder protocol(String protocol) { doSetProperty("protocol", protocol); return this;