confluent_kafka/admin/options/update_features_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::update_features`.
16
17/// Options for `Admin::update_features`.
18#[derive(Clone, Debug, Default)]
19#[doc(alias = "org.apache.kafka.clients.admin.UpdateFeaturesOptions")]
20pub struct UpdateFeaturesOptions {
21 timeout_ms: Option<i32>,
22 validate_only: bool,
23}
24
25impl UpdateFeaturesOptions {
26 /// Creates default options (default API timeout, `validate_only = false`).
27 #[doc(alias = "org.apache.kafka.clients.admin.UpdateFeaturesOptions#UpdateFeaturesOptions")]
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 `UpdateFeaturesOptions` instance.
42 #[must_use]
43 #[doc(alias = "org.apache.kafka.clients.admin.AbstractOptions#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.AbstractOptions#timeoutMs")]
52 pub fn timeout_ms(&self) -> Option<i32> {
53 self.timeout_ms
54 }
55
56 /// Set whether the request should only be validated, without performing the upgrade or
57 /// downgrade.
58 ///
59 /// # Arguments
60 ///
61 /// - `validate_only` - `true` to only validate the request.
62 ///
63 /// # Returns
64 ///
65 /// This `UpdateFeaturesOptions` instance.
66 #[must_use]
67 #[doc(alias = "org.apache.kafka.clients.admin.UpdateFeaturesOptions#validateOnly")]
68 pub fn set_validate_only(mut self, validate_only: bool) -> Self {
69 self.validate_only = validate_only;
70 self
71 }
72
73 /// Returns whether the request should only be validated.
74 #[doc(alias = "org.apache.kafka.clients.admin.UpdateFeaturesOptions#validateOnly")]
75 pub fn validate_only(&self) -> bool {
76 self.validate_only
77 }
78}
79
80#[cfg(test)]
81mod tests {
82 use super::*;
83
84 #[test]
85 fn defaults_match_java() {
86 let options = UpdateFeaturesOptions::new();
87 assert_eq!(options.timeout_ms(), None);
88 assert!(!options.validate_only());
89 }
90
91 #[test]
92 fn fluent_setters() {
93 let options = UpdateFeaturesOptions::new().set_timeout_ms(Some(100)).set_validate_only(true);
94 assert_eq!(options.timeout_ms(), Some(100));
95 assert!(options.validate_only());
96 }
97}