aws-sdk-transfer 1.113.0

AWS SDK for AWS Transfer Family
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 TestIdentityProviderOutput {
    /// <p>The response that is returned from your API Gateway or your Lambda function.</p>
    pub response: ::std::option::Option<::std::string::String>,
    /// <p>The HTTP status code that is the response from your API Gateway or your Lambda function.</p>
    pub status_code: i32,
    /// <p>A message that indicates whether the test was successful or not.</p><note>
    /// <p>If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.</p>
    /// </note>
    pub message: ::std::option::Option<::std::string::String>,
    /// <p>The endpoint of the service used to authenticate a user.</p>
    pub url: ::std::string::String,
    _request_id: Option<String>,
}
impl TestIdentityProviderOutput {
    /// <p>The response that is returned from your API Gateway or your Lambda function.</p>
    pub fn response(&self) -> ::std::option::Option<&str> {
        self.response.as_deref()
    }
    /// <p>The HTTP status code that is the response from your API Gateway or your Lambda function.</p>
    pub fn status_code(&self) -> i32 {
        self.status_code
    }
    /// <p>A message that indicates whether the test was successful or not.</p><note>
    /// <p>If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.</p>
    /// </note>
    pub fn message(&self) -> ::std::option::Option<&str> {
        self.message.as_deref()
    }
    /// <p>The endpoint of the service used to authenticate a user.</p>
    pub fn url(&self) -> &str {
        use std::ops::Deref;
        self.url.deref()
    }
}
impl ::aws_types::request_id::RequestId for TestIdentityProviderOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl TestIdentityProviderOutput {
    /// Creates a new builder-style object to manufacture [`TestIdentityProviderOutput`](crate::operation::test_identity_provider::TestIdentityProviderOutput).
    pub fn builder() -> crate::operation::test_identity_provider::builders::TestIdentityProviderOutputBuilder {
        crate::operation::test_identity_provider::builders::TestIdentityProviderOutputBuilder::default()
    }
}

/// A builder for [`TestIdentityProviderOutput`](crate::operation::test_identity_provider::TestIdentityProviderOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct TestIdentityProviderOutputBuilder {
    pub(crate) response: ::std::option::Option<::std::string::String>,
    pub(crate) status_code: ::std::option::Option<i32>,
    pub(crate) message: ::std::option::Option<::std::string::String>,
    pub(crate) url: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl TestIdentityProviderOutputBuilder {
    /// <p>The response that is returned from your API Gateway or your Lambda function.</p>
    pub fn response(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.response = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The response that is returned from your API Gateway or your Lambda function.</p>
    pub fn set_response(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.response = input;
        self
    }
    /// <p>The response that is returned from your API Gateway or your Lambda function.</p>
    pub fn get_response(&self) -> &::std::option::Option<::std::string::String> {
        &self.response
    }
    /// <p>The HTTP status code that is the response from your API Gateway or your Lambda function.</p>
    /// This field is required.
    pub fn status_code(mut self, input: i32) -> Self {
        self.status_code = ::std::option::Option::Some(input);
        self
    }
    /// <p>The HTTP status code that is the response from your API Gateway or your Lambda function.</p>
    pub fn set_status_code(mut self, input: ::std::option::Option<i32>) -> Self {
        self.status_code = input;
        self
    }
    /// <p>The HTTP status code that is the response from your API Gateway or your Lambda function.</p>
    pub fn get_status_code(&self) -> &::std::option::Option<i32> {
        &self.status_code
    }
    /// <p>A message that indicates whether the test was successful or not.</p><note>
    /// <p>If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.</p>
    /// </note>
    pub fn message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.message = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A message that indicates whether the test was successful or not.</p><note>
    /// <p>If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.</p>
    /// </note>
    pub fn set_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.message = input;
        self
    }
    /// <p>A message that indicates whether the test was successful or not.</p><note>
    /// <p>If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.</p>
    /// </note>
    pub fn get_message(&self) -> &::std::option::Option<::std::string::String> {
        &self.message
    }
    /// <p>The endpoint of the service used to authenticate a user.</p>
    /// This field is required.
    pub fn url(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.url = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The endpoint of the service used to authenticate a user.</p>
    pub fn set_url(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.url = input;
        self
    }
    /// <p>The endpoint of the service used to authenticate a user.</p>
    pub fn get_url(&self) -> &::std::option::Option<::std::string::String> {
        &self.url
    }
    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 [`TestIdentityProviderOutput`](crate::operation::test_identity_provider::TestIdentityProviderOutput).
    /// This method will fail if any of the following fields are not set:
    /// - [`url`](crate::operation::test_identity_provider::builders::TestIdentityProviderOutputBuilder::url)
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::test_identity_provider::TestIdentityProviderOutput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::test_identity_provider::TestIdentityProviderOutput {
            response: self.response,
            status_code: self.status_code.unwrap_or_default(),
            message: self.message,
            url: self.url.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "url",
                    "url was not specified but it is required when building TestIdentityProviderOutput",
                )
            })?,
            _request_id: self._request_id,
        })
    }
}