aws-sdk-eventbridge 1.99.0

AWS SDK for Amazon EventBridge
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeArchiveOutput {
    /// <p>The ARN of the archive.</p>
    pub archive_arn: ::std::option::Option<::std::string::String>,
    /// <p>The name of the archive.</p>
    pub archive_name: ::std::option::Option<::std::string::String>,
    /// <p>The ARN of the event source associated with the archive.</p>
    pub event_source_arn: ::std::option::Option<::std::string::String>,
    /// <p>The description of the archive.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>The event pattern used to filter events sent to the archive.</p>
    pub event_pattern: ::std::option::Option<::std::string::String>,
    /// <p>The state of the archive.</p>
    pub state: ::std::option::Option<crate::types::ArchiveState>,
    /// <p>The reason that the archive is in the state.</p>
    pub state_reason: ::std::option::Option<::std::string::String>,
    /// <p>The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.</p>
    /// <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html">Encrypting archives</a> in the <i>Amazon EventBridge User Guide</i>.</p>
    pub kms_key_identifier: ::std::option::Option<::std::string::String>,
    /// <p>The number of days to retain events for in the archive.</p>
    pub retention_days: ::std::option::Option<i32>,
    /// <p>The size of the archive in bytes.</p>
    pub size_bytes: i64,
    /// <p>The number of events in the archive.</p>
    pub event_count: i64,
    /// <p>The time at which the archive was created.</p>
    pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    _request_id: Option<String>,
}
impl DescribeArchiveOutput {
    /// <p>The ARN of the archive.</p>
    pub fn archive_arn(&self) -> ::std::option::Option<&str> {
        self.archive_arn.as_deref()
    }
    /// <p>The name of the archive.</p>
    pub fn archive_name(&self) -> ::std::option::Option<&str> {
        self.archive_name.as_deref()
    }
    /// <p>The ARN of the event source associated with the archive.</p>
    pub fn event_source_arn(&self) -> ::std::option::Option<&str> {
        self.event_source_arn.as_deref()
    }
    /// <p>The description of the archive.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>The event pattern used to filter events sent to the archive.</p>
    pub fn event_pattern(&self) -> ::std::option::Option<&str> {
        self.event_pattern.as_deref()
    }
    /// <p>The state of the archive.</p>
    pub fn state(&self) -> ::std::option::Option<&crate::types::ArchiveState> {
        self.state.as_ref()
    }
    /// <p>The reason that the archive is in the state.</p>
    pub fn state_reason(&self) -> ::std::option::Option<&str> {
        self.state_reason.as_deref()
    }
    /// <p>The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.</p>
    /// <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html">Encrypting archives</a> in the <i>Amazon EventBridge User Guide</i>.</p>
    pub fn kms_key_identifier(&self) -> ::std::option::Option<&str> {
        self.kms_key_identifier.as_deref()
    }
    /// <p>The number of days to retain events for in the archive.</p>
    pub fn retention_days(&self) -> ::std::option::Option<i32> {
        self.retention_days
    }
    /// <p>The size of the archive in bytes.</p>
    pub fn size_bytes(&self) -> i64 {
        self.size_bytes
    }
    /// <p>The number of events in the archive.</p>
    pub fn event_count(&self) -> i64 {
        self.event_count
    }
    /// <p>The time at which the archive was created.</p>
    pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.creation_time.as_ref()
    }
}
impl ::aws_types::request_id::RequestId for DescribeArchiveOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl DescribeArchiveOutput {
    /// Creates a new builder-style object to manufacture [`DescribeArchiveOutput`](crate::operation::describe_archive::DescribeArchiveOutput).
    pub fn builder() -> crate::operation::describe_archive::builders::DescribeArchiveOutputBuilder {
        crate::operation::describe_archive::builders::DescribeArchiveOutputBuilder::default()
    }
}

/// A builder for [`DescribeArchiveOutput`](crate::operation::describe_archive::DescribeArchiveOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeArchiveOutputBuilder {
    pub(crate) archive_arn: ::std::option::Option<::std::string::String>,
    pub(crate) archive_name: ::std::option::Option<::std::string::String>,
    pub(crate) event_source_arn: ::std::option::Option<::std::string::String>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) event_pattern: ::std::option::Option<::std::string::String>,
    pub(crate) state: ::std::option::Option<crate::types::ArchiveState>,
    pub(crate) state_reason: ::std::option::Option<::std::string::String>,
    pub(crate) kms_key_identifier: ::std::option::Option<::std::string::String>,
    pub(crate) retention_days: ::std::option::Option<i32>,
    pub(crate) size_bytes: ::std::option::Option<i64>,
    pub(crate) event_count: ::std::option::Option<i64>,
    pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    _request_id: Option<String>,
}
impl DescribeArchiveOutputBuilder {
    /// <p>The ARN of the archive.</p>
    pub fn archive_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.archive_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ARN of the archive.</p>
    pub fn set_archive_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.archive_arn = input;
        self
    }
    /// <p>The ARN of the archive.</p>
    pub fn get_archive_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.archive_arn
    }
    /// <p>The name of the archive.</p>
    pub fn archive_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.archive_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the archive.</p>
    pub fn set_archive_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.archive_name = input;
        self
    }
    /// <p>The name of the archive.</p>
    pub fn get_archive_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.archive_name
    }
    /// <p>The ARN of the event source associated with the archive.</p>
    pub fn event_source_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.event_source_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ARN of the event source associated with the archive.</p>
    pub fn set_event_source_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.event_source_arn = input;
        self
    }
    /// <p>The ARN of the event source associated with the archive.</p>
    pub fn get_event_source_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.event_source_arn
    }
    /// <p>The description of the archive.</p>
    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The description of the archive.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>The description of the archive.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>The event pattern used to filter events sent to the archive.</p>
    pub fn event_pattern(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.event_pattern = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The event pattern used to filter events sent to the archive.</p>
    pub fn set_event_pattern(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.event_pattern = input;
        self
    }
    /// <p>The event pattern used to filter events sent to the archive.</p>
    pub fn get_event_pattern(&self) -> &::std::option::Option<::std::string::String> {
        &self.event_pattern
    }
    /// <p>The state of the archive.</p>
    pub fn state(mut self, input: crate::types::ArchiveState) -> Self {
        self.state = ::std::option::Option::Some(input);
        self
    }
    /// <p>The state of the archive.</p>
    pub fn set_state(mut self, input: ::std::option::Option<crate::types::ArchiveState>) -> Self {
        self.state = input;
        self
    }
    /// <p>The state of the archive.</p>
    pub fn get_state(&self) -> &::std::option::Option<crate::types::ArchiveState> {
        &self.state
    }
    /// <p>The reason that the archive is in the state.</p>
    pub fn state_reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.state_reason = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The reason that the archive is in the state.</p>
    pub fn set_state_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.state_reason = input;
        self
    }
    /// <p>The reason that the archive is in the state.</p>
    pub fn get_state_reason(&self) -> &::std::option::Option<::std::string::String> {
        &self.state_reason
    }
    /// <p>The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.</p>
    /// <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html">Encrypting archives</a> in the <i>Amazon EventBridge User Guide</i>.</p>
    pub fn kms_key_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.kms_key_identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.</p>
    /// <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html">Encrypting archives</a> in the <i>Amazon EventBridge User Guide</i>.</p>
    pub fn set_kms_key_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.kms_key_identifier = input;
        self
    }
    /// <p>The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.</p>
    /// <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html">Encrypting archives</a> in the <i>Amazon EventBridge User Guide</i>.</p>
    pub fn get_kms_key_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.kms_key_identifier
    }
    /// <p>The number of days to retain events for in the archive.</p>
    pub fn retention_days(mut self, input: i32) -> Self {
        self.retention_days = ::std::option::Option::Some(input);
        self
    }
    /// <p>The number of days to retain events for in the archive.</p>
    pub fn set_retention_days(mut self, input: ::std::option::Option<i32>) -> Self {
        self.retention_days = input;
        self
    }
    /// <p>The number of days to retain events for in the archive.</p>
    pub fn get_retention_days(&self) -> &::std::option::Option<i32> {
        &self.retention_days
    }
    /// <p>The size of the archive in bytes.</p>
    pub fn size_bytes(mut self, input: i64) -> Self {
        self.size_bytes = ::std::option::Option::Some(input);
        self
    }
    /// <p>The size of the archive in bytes.</p>
    pub fn set_size_bytes(mut self, input: ::std::option::Option<i64>) -> Self {
        self.size_bytes = input;
        self
    }
    /// <p>The size of the archive in bytes.</p>
    pub fn get_size_bytes(&self) -> &::std::option::Option<i64> {
        &self.size_bytes
    }
    /// <p>The number of events in the archive.</p>
    pub fn event_count(mut self, input: i64) -> Self {
        self.event_count = ::std::option::Option::Some(input);
        self
    }
    /// <p>The number of events in the archive.</p>
    pub fn set_event_count(mut self, input: ::std::option::Option<i64>) -> Self {
        self.event_count = input;
        self
    }
    /// <p>The number of events in the archive.</p>
    pub fn get_event_count(&self) -> &::std::option::Option<i64> {
        &self.event_count
    }
    /// <p>The time at which the archive was created.</p>
    pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.creation_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The time at which the archive was created.</p>
    pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.creation_time = input;
        self
    }
    /// <p>The time at which the archive was created.</p>
    pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.creation_time
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`DescribeArchiveOutput`](crate::operation::describe_archive::DescribeArchiveOutput).
    pub fn build(self) -> crate::operation::describe_archive::DescribeArchiveOutput {
        crate::operation::describe_archive::DescribeArchiveOutput {
            archive_arn: self.archive_arn,
            archive_name: self.archive_name,
            event_source_arn: self.event_source_arn,
            description: self.description,
            event_pattern: self.event_pattern,
            state: self.state,
            state_reason: self.state_reason,
            kms_key_identifier: self.kms_key_identifier,
            retention_days: self.retention_days,
            size_bytes: self.size_bytes.unwrap_or_default(),
            event_count: self.event_count.unwrap_or_default(),
            creation_time: self.creation_time,
            _request_id: self._request_id,
        }
    }
}