Struct aws_sdk_s3control::model::JobDescriptor
source · #[non_exhaustive]pub struct JobDescriptor { /* private fields */ }
Expand description
A container element for the job configuration and status information returned by a Describe Job
request.
Implementations§
source§impl JobDescriptor
impl JobDescriptor
sourcepub fn confirmation_required(&self) -> Option<bool>
pub fn confirmation_required(&self) -> Option<bool>
Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description for this job, if one was provided in this job's Create Job
request.
sourcepub fn manifest(&self) -> Option<&JobManifest>
pub fn manifest(&self) -> Option<&JobManifest>
The configuration information for the specified job's manifest object.
sourcepub fn operation(&self) -> Option<&JobOperation>
pub fn operation(&self) -> Option<&JobOperation>
The operation that the specified job is configured to run on the objects listed in the manifest.
sourcepub fn progress_summary(&self) -> Option<&JobProgressSummary>
pub fn progress_summary(&self) -> Option<&JobProgressSummary>
Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.
sourcepub fn status_update_reason(&self) -> Option<&str>
pub fn status_update_reason(&self) -> Option<&str>
The reason for updating the job.
sourcepub fn failure_reasons(&self) -> Option<&[JobFailure]>
pub fn failure_reasons(&self) -> Option<&[JobFailure]>
If the specified job failed, this field contains information describing the failure.
sourcepub fn report(&self) -> Option<&JobReport>
pub fn report(&self) -> Option<&JobReport>
Contains the configuration information for the job-completion report if you requested one in the Create Job
request.
sourcepub fn creation_time(&self) -> Option<&DateTime>
pub fn creation_time(&self) -> Option<&DateTime>
A timestamp indicating when this job was created.
sourcepub fn termination_date(&self) -> Option<&DateTime>
pub fn termination_date(&self) -> Option<&DateTime>
A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role assigned to run the tasks for this job.
sourcepub fn suspended_date(&self) -> Option<&DateTime>
pub fn suspended_date(&self) -> Option<&DateTime>
The timestamp when this job was suspended, if it has been suspended.
sourcepub fn suspended_cause(&self) -> Option<&str>
pub fn suspended_cause(&self) -> Option<&str>
The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended
state to await confirmation before running. After you confirm the job, it automatically exits the Suspended
state.
sourcepub fn manifest_generator(&self) -> Option<&JobManifestGenerator>
pub fn manifest_generator(&self) -> Option<&JobManifestGenerator>
The manifest generator that was used to generate a job manifest for this job.
sourcepub fn generated_manifest_descriptor(
&self
) -> Option<&S3GeneratedManifestDescriptor>
pub fn generated_manifest_descriptor(
&self
) -> Option<&S3GeneratedManifestDescriptor>
The attribute of the JobDescriptor containing details about the job's generated manifest.
source§impl JobDescriptor
impl JobDescriptor
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture JobDescriptor
.
Examples found in repository?
2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336
pub fn deser_structure_crate_model_job_descriptor(
decoder: &mut aws_smithy_xml::decode::ScopedDecoder,
) -> Result<crate::model::JobDescriptor, aws_smithy_xml::decode::XmlDecodeError> {
#[allow(unused_mut)]
let mut builder = crate::model::JobDescriptor::builder();
while let Some(mut tag) = decoder.next_tag() {
match tag.start_el() {
s if s.matches("JobId") /* JobId com.amazonaws.s3control#JobDescriptor$JobId */ => {
let var_71 =
Some(
Result::<std::string::String, aws_smithy_xml::decode::XmlDecodeError>::Ok(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
.into()
)
?
)
;
builder = builder.set_job_id(var_71);
}
,
s if s.matches("ConfirmationRequired") /* ConfirmationRequired com.amazonaws.s3control#JobDescriptor$ConfirmationRequired */ => {
let var_72 =
Some(
{
<bool as aws_smithy_types::primitive::Parse>::parse_smithy_primitive(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
)
.map_err(|_|aws_smithy_xml::decode::XmlDecodeError::custom("expected (boolean: `com.amazonaws.s3control#ConfirmationRequired`)"))
}
?
)
;
builder = builder.set_confirmation_required(var_72);
}
,
s if s.matches("Description") /* Description com.amazonaws.s3control#JobDescriptor$Description */ => {
let var_73 =
Some(
Result::<std::string::String, aws_smithy_xml::decode::XmlDecodeError>::Ok(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
.into()
)
?
)
;
builder = builder.set_description(var_73);
}
,
s if s.matches("JobArn") /* JobArn com.amazonaws.s3control#JobDescriptor$JobArn */ => {
let var_74 =
Some(
Result::<std::string::String, aws_smithy_xml::decode::XmlDecodeError>::Ok(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
.into()
)
?
)
;
builder = builder.set_job_arn(var_74);
}
,
s if s.matches("Status") /* Status com.amazonaws.s3control#JobDescriptor$Status */ => {
let var_75 =
Some(
Result::<crate::model::JobStatus, aws_smithy_xml::decode::XmlDecodeError>::Ok(
crate::model::JobStatus::from(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
)
)
?
)
;
builder = builder.set_status(var_75);
}
,
s if s.matches("Manifest") /* Manifest com.amazonaws.s3control#JobDescriptor$Manifest */ => {
let var_76 =
Some(
crate::xml_deser::deser_structure_crate_model_job_manifest(&mut tag)
?
)
;
builder = builder.set_manifest(var_76);
}
,
s if s.matches("Operation") /* Operation com.amazonaws.s3control#JobDescriptor$Operation */ => {
let var_77 =
Some(
crate::xml_deser::deser_structure_crate_model_job_operation(&mut tag)
?
)
;
builder = builder.set_operation(var_77);
}
,
s if s.matches("Priority") /* Priority com.amazonaws.s3control#JobDescriptor$Priority */ => {
let var_78 =
Some(
{
<i32 as aws_smithy_types::primitive::Parse>::parse_smithy_primitive(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
)
.map_err(|_|aws_smithy_xml::decode::XmlDecodeError::custom("expected (integer: `com.amazonaws.s3control#JobPriority`)"))
}
?
)
;
builder = builder.set_priority(var_78);
}
,
s if s.matches("ProgressSummary") /* ProgressSummary com.amazonaws.s3control#JobDescriptor$ProgressSummary */ => {
let var_79 =
Some(
crate::xml_deser::deser_structure_crate_model_job_progress_summary(&mut tag)
?
)
;
builder = builder.set_progress_summary(var_79);
}
,
s if s.matches("StatusUpdateReason") /* StatusUpdateReason com.amazonaws.s3control#JobDescriptor$StatusUpdateReason */ => {
let var_80 =
Some(
Result::<std::string::String, aws_smithy_xml::decode::XmlDecodeError>::Ok(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
.into()
)
?
)
;
builder = builder.set_status_update_reason(var_80);
}
,
s if s.matches("FailureReasons") /* FailureReasons com.amazonaws.s3control#JobDescriptor$FailureReasons */ => {
let var_81 =
Some(
crate::xml_deser::deser_list_com_amazonaws_s3control_job_failure_list(&mut tag)
?
)
;
builder = builder.set_failure_reasons(var_81);
}
,
s if s.matches("Report") /* Report com.amazonaws.s3control#JobDescriptor$Report */ => {
let var_82 =
Some(
crate::xml_deser::deser_structure_crate_model_job_report(&mut tag)
?
)
;
builder = builder.set_report(var_82);
}
,
s if s.matches("CreationTime") /* CreationTime com.amazonaws.s3control#JobDescriptor$CreationTime */ => {
let var_83 =
Some(
aws_smithy_types::DateTime::from_str(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
, aws_smithy_types::date_time::Format::DateTime
)
.map_err(|_|aws_smithy_xml::decode::XmlDecodeError::custom("expected (timestamp: `com.amazonaws.s3control#JobCreationTime`)"))
?
)
;
builder = builder.set_creation_time(var_83);
}
,
s if s.matches("TerminationDate") /* TerminationDate com.amazonaws.s3control#JobDescriptor$TerminationDate */ => {
let var_84 =
Some(
aws_smithy_types::DateTime::from_str(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
, aws_smithy_types::date_time::Format::DateTime
)
.map_err(|_|aws_smithy_xml::decode::XmlDecodeError::custom("expected (timestamp: `com.amazonaws.s3control#JobTerminationDate`)"))
?
)
;
builder = builder.set_termination_date(var_84);
}
,
s if s.matches("RoleArn") /* RoleArn com.amazonaws.s3control#JobDescriptor$RoleArn */ => {
let var_85 =
Some(
Result::<std::string::String, aws_smithy_xml::decode::XmlDecodeError>::Ok(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
.into()
)
?
)
;
builder = builder.set_role_arn(var_85);
}
,
s if s.matches("SuspendedDate") /* SuspendedDate com.amazonaws.s3control#JobDescriptor$SuspendedDate */ => {
let var_86 =
Some(
aws_smithy_types::DateTime::from_str(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
, aws_smithy_types::date_time::Format::DateTime
)
.map_err(|_|aws_smithy_xml::decode::XmlDecodeError::custom("expected (timestamp: `com.amazonaws.s3control#SuspendedDate`)"))
?
)
;
builder = builder.set_suspended_date(var_86);
}
,
s if s.matches("SuspendedCause") /* SuspendedCause com.amazonaws.s3control#JobDescriptor$SuspendedCause */ => {
let var_87 =
Some(
Result::<std::string::String, aws_smithy_xml::decode::XmlDecodeError>::Ok(
aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
.into()
)
?
)
;
builder = builder.set_suspended_cause(var_87);
}
,
s if s.matches("ManifestGenerator") /* ManifestGenerator com.amazonaws.s3control#JobDescriptor$ManifestGenerator */ => {
let var_88 =
Some(
crate::xml_deser::deser_union_crate_model_job_manifest_generator(&mut tag)
?
)
;
builder = builder.set_manifest_generator(var_88);
}
,
s if s.matches("GeneratedManifestDescriptor") /* GeneratedManifestDescriptor com.amazonaws.s3control#JobDescriptor$GeneratedManifestDescriptor */ => {
let var_89 =
Some(
crate::xml_deser::deser_structure_crate_model_s3_generated_manifest_descriptor(&mut tag)
?
)
;
builder = builder.set_generated_manifest_descriptor(var_89);
}
,
_ => {}
}
}
Ok(builder.build())
}
Trait Implementations§
source§impl Clone for JobDescriptor
impl Clone for JobDescriptor
source§fn clone(&self) -> JobDescriptor
fn clone(&self) -> JobDescriptor
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more