aws_sdk_kinesis/operation/describe_stream/
_describe_stream_output.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3/// <p>Represents the output for <code>DescribeStream</code>.</p>
4#[non_exhaustive]
5#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
6pub struct DescribeStreamOutput {
7    /// <p>The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the stream, and whether there are more shards available.</p>
8    pub stream_description: ::std::option::Option<crate::types::StreamDescription>,
9    _request_id: Option<String>,
10}
11impl DescribeStreamOutput {
12    /// <p>The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the stream, and whether there are more shards available.</p>
13    pub fn stream_description(&self) -> ::std::option::Option<&crate::types::StreamDescription> {
14        self.stream_description.as_ref()
15    }
16}
17impl ::aws_types::request_id::RequestId for DescribeStreamOutput {
18    fn request_id(&self) -> Option<&str> {
19        self._request_id.as_deref()
20    }
21}
22impl DescribeStreamOutput {
23    /// Creates a new builder-style object to manufacture [`DescribeStreamOutput`](crate::operation::describe_stream::DescribeStreamOutput).
24    pub fn builder() -> crate::operation::describe_stream::builders::DescribeStreamOutputBuilder {
25        crate::operation::describe_stream::builders::DescribeStreamOutputBuilder::default()
26    }
27}
28
29/// A builder for [`DescribeStreamOutput`](crate::operation::describe_stream::DescribeStreamOutput).
30#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
31#[non_exhaustive]
32pub struct DescribeStreamOutputBuilder {
33    pub(crate) stream_description: ::std::option::Option<crate::types::StreamDescription>,
34    _request_id: Option<String>,
35}
36impl DescribeStreamOutputBuilder {
37    /// <p>The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the stream, and whether there are more shards available.</p>
38    /// This field is required.
39    pub fn stream_description(mut self, input: crate::types::StreamDescription) -> Self {
40        self.stream_description = ::std::option::Option::Some(input);
41        self
42    }
43    /// <p>The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the stream, and whether there are more shards available.</p>
44    pub fn set_stream_description(mut self, input: ::std::option::Option<crate::types::StreamDescription>) -> Self {
45        self.stream_description = input;
46        self
47    }
48    /// <p>The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the stream, and whether there are more shards available.</p>
49    pub fn get_stream_description(&self) -> &::std::option::Option<crate::types::StreamDescription> {
50        &self.stream_description
51    }
52    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
53        self._request_id = Some(request_id.into());
54        self
55    }
56
57    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
58        self._request_id = request_id;
59        self
60    }
61    /// Consumes the builder and constructs a [`DescribeStreamOutput`](crate::operation::describe_stream::DescribeStreamOutput).
62    pub fn build(self) -> crate::operation::describe_stream::DescribeStreamOutput {
63        crate::operation::describe_stream::DescribeStreamOutput {
64            stream_description: self.stream_description,
65            _request_id: self._request_id,
66        }
67    }
68}