Struct rusoto_glacier::JobParameters
source · [−]pub struct JobParameters {
pub archive_id: Option<String>,
pub description: Option<String>,
pub format: Option<String>,
pub inventory_retrieval_parameters: Option<InventoryRetrievalJobInput>,
pub output_location: Option<OutputLocation>,
pub retrieval_byte_range: Option<String>,
pub sns_topic: Option<String>,
pub select_parameters: Option<SelectParameters>,
pub tier: Option<String>,
pub type_: Option<String>,
}
Expand description
Provides options for defining a job.
Fields
archive_id: Option<String>
The ID of the archive that you want to retrieve. This field is required only if Type
is set to select
or archive-retrieval
code>. An error occurs if you specify this request parameter for an inventory retrieval job request.
description: Option<String>
The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.
format: Option<String>
When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".
inventory_retrieval_parameters: Option<InventoryRetrievalJobInput>
Input parameters used for range inventory retrieval.
output_location: Option<OutputLocation>
Contains information about the location where the select job results are stored.
retrieval_byte_range: Option<String>
The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.
An error occurs if you specify this field for an inventory retrieval job request.
sns_topic: Option<String>
The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.
select_parameters: Option<SelectParameters>
Contains the parameters that define a job.
tier: Option<String>
The tier to use for a select or an archive retrieval job. Valid values are Expedited
, Standard
, or Bulk
. Standard
is the default.
type_: Option<String>
The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".
Trait Implementations
sourceimpl Clone for JobParameters
impl Clone for JobParameters
sourcefn clone(&self) -> JobParameters
fn clone(&self) -> JobParameters
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for JobParameters
impl Debug for JobParameters
sourceimpl Default for JobParameters
impl Default for JobParameters
sourcefn default() -> JobParameters
fn default() -> JobParameters
Returns the “default value” for a type. Read more
sourceimpl PartialEq<JobParameters> for JobParameters
impl PartialEq<JobParameters> for JobParameters
sourcefn eq(&self, other: &JobParameters) -> bool
fn eq(&self, other: &JobParameters) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &JobParameters) -> bool
fn ne(&self, other: &JobParameters) -> bool
This method tests for !=
.
sourceimpl Serialize for JobParameters
impl Serialize for JobParameters
impl StructuralPartialEq for JobParameters
Auto Trait Implementations
impl RefUnwindSafe for JobParameters
impl Send for JobParameters
impl Sync for JobParameters
impl Unpin for JobParameters
impl UnwindSafe for JobParameters
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more