Struct aws_sdk_s3::input::select_object_content_input::Builder

pub struct Builder { /* private fields */ }

A builder for SelectObjectContentInput.

Implementations

impl Builder

pub fn bucket(self, input: impl Into<String>) -> Self

The S3 bucket.

Examples found in repository

src/client.rs (line 15465)

        pub fn bucket(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.bucket(input.into());
            self
        }

pub fn set_bucket(self, input: Option<String>) -> Self

The S3 bucket.

Examples found in repository

src/client.rs (line 15470)

        pub fn set_bucket(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_bucket(input);
            self
        }

pub fn key(self, input: impl Into<String>) -> Self

The object key.

Examples found in repository

src/client.rs (line 15475)

        pub fn key(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.key(input.into());
            self
        }

pub fn set_key(self, input: Option<String>) -> Self

The object key.

Examples found in repository

src/client.rs (line 15480)

        pub fn set_key(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_key(input);
            self
        }

pub fn sse_customer_algorithm(self, input: impl Into<String>) -> Self

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

Examples found in repository

src/client.rs (line 15485)

        pub fn sse_customer_algorithm(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.sse_customer_algorithm(input.into());
            self
        }

pub fn set_sse_customer_algorithm(self, input: Option<String>) -> Self

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

Examples found in repository

src/client.rs (line 15493)

        pub fn set_sse_customer_algorithm(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_sse_customer_algorithm(input);
            self
        }

pub fn sse_customer_key(self, input: impl Into<String>) -> Self

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

Examples found in repository

src/client.rs (line 15498)

        pub fn sse_customer_key(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.sse_customer_key(input.into());
            self
        }

pub fn set_sse_customer_key(self, input: Option<String>) -> Self

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

Examples found in repository

src/client.rs (line 15506)

        pub fn set_sse_customer_key(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_sse_customer_key(input);
            self
        }

pub fn sse_customer_key_md5(self, input: impl Into<String>) -> Self

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

Examples found in repository

src/client.rs (line 15511)

        pub fn sse_customer_key_md5(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.sse_customer_key_md5(input.into());
            self
        }

pub fn set_sse_customer_key_md5(self, input: Option<String>) -> Self

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

Examples found in repository

src/client.rs (line 15519)

        pub fn set_sse_customer_key_md5(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_sse_customer_key_md5(input);
            self
        }

pub fn expression(self, input: impl Into<String>) -> Self

The expression that is used to query the object.

Examples found in repository

src/client.rs (line 15524)

        pub fn expression(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.expression(input.into());
            self
        }

pub fn set_expression(self, input: Option<String>) -> Self

The expression that is used to query the object.

Examples found in repository

src/client.rs (line 15529)

        pub fn set_expression(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_expression(input);
            self
        }

pub fn expression_type(self, input: ExpressionType) -> Self

The type of the provided expression (for example, SQL).

Examples found in repository

src/client.rs (line 15534)

        pub fn expression_type(mut self, input: crate::model::ExpressionType) -> Self {
            self.inner = self.inner.expression_type(input);
            self
        }

pub fn set_expression_type(self, input: Option<ExpressionType>) -> Self

The type of the provided expression (for example, SQL).

Examples found in repository

src/client.rs (line 15542)

        pub fn set_expression_type(
            mut self,
            input: std::option::Option<crate::model::ExpressionType>,
        ) -> Self {
            self.inner = self.inner.set_expression_type(input);
            self
        }

pub fn request_progress(self, input: RequestProgress) -> Self

Specifies if periodic request progress information should be enabled.

Examples found in repository

src/client.rs (line 15547)

        pub fn request_progress(mut self, input: crate::model::RequestProgress) -> Self {
            self.inner = self.inner.request_progress(input);
            self
        }

pub fn set_request_progress(self, input: Option<RequestProgress>) -> Self

Specifies if periodic request progress information should be enabled.

Examples found in repository

src/client.rs (line 15555)

        pub fn set_request_progress(
            mut self,
            input: std::option::Option<crate::model::RequestProgress>,
        ) -> Self {
            self.inner = self.inner.set_request_progress(input);
            self
        }

pub fn input_serialization(self, input: InputSerialization) -> Self

Describes the format of the data in the object that is being queried.

Examples found in repository

src/client.rs (line 15560)

        pub fn input_serialization(mut self, input: crate::model::InputSerialization) -> Self {
            self.inner = self.inner.input_serialization(input);
            self
        }

pub fn set_input_serialization(self, input: Option<InputSerialization>) -> Self

Describes the format of the data in the object that is being queried.

Examples found in repository

src/client.rs (line 15568)

        pub fn set_input_serialization(
            mut self,
            input: std::option::Option<crate::model::InputSerialization>,
        ) -> Self {
            self.inner = self.inner.set_input_serialization(input);
            self
        }

pub fn output_serialization(self, input: OutputSerialization) -> Self

Describes the format of the data that you want Amazon S3 to return in response.

Examples found in repository

src/client.rs (line 15573)

        pub fn output_serialization(mut self, input: crate::model::OutputSerialization) -> Self {
            self.inner = self.inner.output_serialization(input);
            self
        }

pub fn set_output_serialization(self, input: Option<OutputSerialization>) -> Self

Describes the format of the data that you want Amazon S3 to return in response.

Examples found in repository

src/client.rs (line 15581)

        pub fn set_output_serialization(
            mut self,
            input: std::option::Option<crate::model::OutputSerialization>,
        ) -> Self {
            self.inner = self.inner.set_output_serialization(input);
            self
        }

pub fn scan_range(self, input: ScanRange) -> Self

Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.

ScanRangemay be used in the following ways:

• 50 100 - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)

• 50 - process only the records starting after the byte 50

• 50 - process only the records within the last 50 bytes of the file.

Examples found in repository

src/client.rs (line 15610)

        pub fn scan_range(mut self, input: crate::model::ScanRange) -> Self {
            self.inner = self.inner.scan_range(input);
            self
        }

pub fn set_scan_range(self, input: Option<ScanRange>) -> Self

Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.

ScanRangemay be used in the following ways:

• 50 100 - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)

• 50 - process only the records starting after the byte 50

• 50 - process only the records within the last 50 bytes of the file.

Examples found in repository

src/client.rs (line 15642)

        pub fn set_scan_range(
            mut self,
            input: std::option::Option<crate::model::ScanRange>,
        ) -> Self {
            self.inner = self.inner.set_scan_range(input);
            self
        }

pub fn expected_bucket_owner(self, input: impl Into<String>) -> Self

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Examples found in repository

src/client.rs (line 15647)

        pub fn expected_bucket_owner(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.expected_bucket_owner(input.into());
            self
        }

pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Examples found in repository

src/client.rs (line 15655)

        pub fn set_expected_bucket_owner(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_expected_bucket_owner(input);
            self
        }

pub fn build(self) -> Result<SelectObjectContentInput, BuildError>

Consumes the builder and constructs a SelectObjectContentInput.

Examples found in repository

src/client.rs (line 15432)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::SelectObjectContent,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::SelectObjectContentError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// Sends the request and returns the response.
        ///
        /// If an error occurs, an `SdkError` will be returned with additional details that
        /// can be matched against.
        ///
        /// By default, any retryable failures will be retried twice. Retry behavior
        /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::SelectObjectContentOutput,
            aws_smithy_http::result::SdkError<crate::error::SelectObjectContentError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder