Skip to content

camel-aws2-transcribe: deprecate the protocol option, which has no effect #29706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dhairya-007 wants to merge 4 commits into
base: main
Choose a base branch
from
+37 −9
Open

camel-aws2-transcribe: deprecate the protocol option, which has no effect #29706

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f3fccbf
camel-aws2-transcribe: deprecate the protocol option, which has no ef…
Dhairya-007 Nov 12, 2026
af5f7d7
Update components/camel-aws/camel-aws2-transcribe/src/main/java/org/a…
Dhairya-007 Nov 12, 2026
c26c7a3
Update components/camel-aws/camel-aws2-transcribe/src/main/java/org/a…
Dhairya-007 Nov 12, 2026
e25f90b
camel-aws2-transcribe: collapse the Javadoc the suggestion commits du…
Dhairya-007 Nov 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-transcribe.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" },
Expand Down Expand Up @@ -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" },
Expand Down
4 changes: 2 additions & 2 deletions ...erated/resources/META-INF/org/apache/camel/component/aws2/transcribe/aws2-transcribe.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" },
Expand Down Expand Up @@ -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" },
Expand Down
12 changes: 10 additions & 2 deletions ...be/src/main/java/org/apache/camel/component/aws2/transcribe/Transcribe2Configuration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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() {
Comment thread
Dhairya-007 marked this conversation as resolved.
Resolved
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) {
Comment thread
Dhairya-007 marked this conversation as resolved.
Resolved
this.protocol = protocol;
}
Expand Down
11 changes: 11 additions & 0 deletions docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
5 changes: 4 additions & 1 deletion ...ed/java/org/apache/camel/builder/component/dsl/Aws2TranscribeComponentBuilderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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;
Expand Down
Loading