confluent_kafka/admin/options/alter_configs_options.rs
1// Copyright 2025 Confluent Inc.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! Options for `Admin::incremental_alter_configs`.
16
17/// Options for `Admin::incremental_alter_configs`.
18#[derive(Clone, Debug, Default)]
19#[doc(alias = "org.apache.kafka.clients.admin.AlterConfigsOptions")]
20pub struct AlterConfigsOptions {
21 timeout_ms: Option<i32>,
22 validate_only: bool,
23}
24
25impl AlterConfigsOptions {
26 /// Creates default options.
27 #[doc(alias = "org.apache.kafka.clients.admin.AlterConfigsOptions#AlterConfigsOptions")]
28 pub fn new() -> Self {
29 Self::default()
30 }
31
32 /// Set the timeout in milliseconds for this operation, or `None` if the default
33 /// API timeout for the `AdminClient` should be used.
34 ///
35 /// # Arguments
36 ///
37 /// - `timeout_ms` - the timeout in milliseconds, or `None` for the default API timeout.
38 ///
39 /// # Returns
40 ///
41 /// This `AlterConfigsOptions` instance.
42 #[must_use]
43 #[doc(alias = "org.apache.kafka.clients.admin.AlterConfigsOptions#timeoutMs")]
44 pub fn set_timeout_ms(mut self, timeout_ms: Option<i32>) -> Self {
45 self.timeout_ms = timeout_ms;
46 self
47 }
48
49 /// Returns the timeout in milliseconds for this operation, or `None` if the
50 /// default API timeout for the `AdminClient` should be used.
51 #[doc(alias = "org.apache.kafka.clients.admin.AlterConfigsOptions#timeoutMs")]
52 pub fn timeout_ms(&self) -> Option<i32> {
53 self.timeout_ms
54 }
55
56 /// Set to true if the request should be validated without altering the configs.
57 ///
58 /// # Arguments
59 ///
60 /// - `validate_only` - `true` to only validate the request.
61 ///
62 /// # Returns
63 ///
64 /// This `AlterConfigsOptions` instance.
65 #[must_use]
66 #[doc(alias = "org.apache.kafka.clients.admin.AlterConfigsOptions#validateOnly")]
67 pub fn set_validate_only(mut self, validate_only: bool) -> Self {
68 self.validate_only = validate_only;
69 self
70 }
71
72 /// Returns true if the request should be validated without altering the configs.
73 #[doc(alias = "org.apache.kafka.clients.admin.AlterConfigsOptions#shouldValidateOnly")]
74 pub fn should_validate_only(&self) -> bool {
75 self.validate_only
76 }
77}
78
79#[cfg(test)]
80mod tests {
81 use super::*;
82
83 #[test]
84 fn defaults_match_java() {
85 let options = AlterConfigsOptions::new();
86 assert_eq!(options.timeout_ms(), None);
87 assert!(!options.should_validate_only());
88 }
89
90 #[test]
91 fn fluent_setters() {
92 let options = AlterConfigsOptions::new().set_validate_only(true);
93 assert!(options.should_validate_only());
94 }
95}