aws-sdk-batch 1.124.0

AWS SDK for AWS Batch
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

// 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 UpdateQuotaShareInput {
    /// <p>The Amazon Resource Name (ARN) of the quota share to update.</p>
    pub quota_share_arn: ::std::option::Option<::std::string::String>,
    /// <p>A list that specifies the quantity and type of compute capacity allocated to the quota share.</p>
    pub capacity_limits: ::std::option::Option<::std::vec::Vec<crate::types::QuotaShareCapacityLimit>>,
    /// <p>Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.</p>
    pub resource_sharing_configuration: ::std::option::Option<crate::types::QuotaShareResourceSharingConfiguration>,
    /// <p>Specifies the preemption behavior for jobs in a quota share.</p>
    pub preemption_configuration: ::std::option::Option<crate::types::QuotaSharePreemptionConfiguration>,
    /// <p>The state of the quota share. If the quota share is <code>ENABLED</code>, it is able to accept jobs. If the quota share is <code>DISABLED</code>, new jobs won't be accepted but jobs already submitted can finish.</p>
    pub state: ::std::option::Option<crate::types::QuotaShareState>,
}
impl UpdateQuotaShareInput {
    /// <p>The Amazon Resource Name (ARN) of the quota share to update.</p>
    pub fn quota_share_arn(&self) -> ::std::option::Option<&str> {
        self.quota_share_arn.as_deref()
    }
    /// <p>A list that specifies the quantity and type of compute capacity allocated to the quota share.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.capacity_limits.is_none()`.
    pub fn capacity_limits(&self) -> &[crate::types::QuotaShareCapacityLimit] {
        self.capacity_limits.as_deref().unwrap_or_default()
    }
    /// <p>Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.</p>
    pub fn resource_sharing_configuration(&self) -> ::std::option::Option<&crate::types::QuotaShareResourceSharingConfiguration> {
        self.resource_sharing_configuration.as_ref()
    }
    /// <p>Specifies the preemption behavior for jobs in a quota share.</p>
    pub fn preemption_configuration(&self) -> ::std::option::Option<&crate::types::QuotaSharePreemptionConfiguration> {
        self.preemption_configuration.as_ref()
    }
    /// <p>The state of the quota share. If the quota share is <code>ENABLED</code>, it is able to accept jobs. If the quota share is <code>DISABLED</code>, new jobs won't be accepted but jobs already submitted can finish.</p>
    pub fn state(&self) -> ::std::option::Option<&crate::types::QuotaShareState> {
        self.state.as_ref()
    }
}
impl UpdateQuotaShareInput {
    /// Creates a new builder-style object to manufacture [`UpdateQuotaShareInput`](crate::operation::update_quota_share::UpdateQuotaShareInput).
    pub fn builder() -> crate::operation::update_quota_share::builders::UpdateQuotaShareInputBuilder {
        crate::operation::update_quota_share::builders::UpdateQuotaShareInputBuilder::default()
    }
}

/// A builder for [`UpdateQuotaShareInput`](crate::operation::update_quota_share::UpdateQuotaShareInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdateQuotaShareInputBuilder {
    pub(crate) quota_share_arn: ::std::option::Option<::std::string::String>,
    pub(crate) capacity_limits: ::std::option::Option<::std::vec::Vec<crate::types::QuotaShareCapacityLimit>>,
    pub(crate) resource_sharing_configuration: ::std::option::Option<crate::types::QuotaShareResourceSharingConfiguration>,
    pub(crate) preemption_configuration: ::std::option::Option<crate::types::QuotaSharePreemptionConfiguration>,
    pub(crate) state: ::std::option::Option<crate::types::QuotaShareState>,
}
impl UpdateQuotaShareInputBuilder {
    /// <p>The Amazon Resource Name (ARN) of the quota share to update.</p>
    /// This field is required.
    pub fn quota_share_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.quota_share_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the quota share to update.</p>
    pub fn set_quota_share_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.quota_share_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the quota share to update.</p>
    pub fn get_quota_share_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.quota_share_arn
    }
    /// Appends an item to `capacity_limits`.
    ///
    /// To override the contents of this collection use [`set_capacity_limits`](Self::set_capacity_limits).
    ///
    /// <p>A list that specifies the quantity and type of compute capacity allocated to the quota share.</p>
    pub fn capacity_limits(mut self, input: crate::types::QuotaShareCapacityLimit) -> Self {
        let mut v = self.capacity_limits.unwrap_or_default();
        v.push(input);
        self.capacity_limits = ::std::option::Option::Some(v);
        self
    }
    /// <p>A list that specifies the quantity and type of compute capacity allocated to the quota share.</p>
    pub fn set_capacity_limits(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::QuotaShareCapacityLimit>>) -> Self {
        self.capacity_limits = input;
        self
    }
    /// <p>A list that specifies the quantity and type of compute capacity allocated to the quota share.</p>
    pub fn get_capacity_limits(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::QuotaShareCapacityLimit>> {
        &self.capacity_limits
    }
    /// <p>Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.</p>
    pub fn resource_sharing_configuration(mut self, input: crate::types::QuotaShareResourceSharingConfiguration) -> Self {
        self.resource_sharing_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.</p>
    pub fn set_resource_sharing_configuration(mut self, input: ::std::option::Option<crate::types::QuotaShareResourceSharingConfiguration>) -> Self {
        self.resource_sharing_configuration = input;
        self
    }
    /// <p>Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.</p>
    pub fn get_resource_sharing_configuration(&self) -> &::std::option::Option<crate::types::QuotaShareResourceSharingConfiguration> {
        &self.resource_sharing_configuration
    }
    /// <p>Specifies the preemption behavior for jobs in a quota share.</p>
    pub fn preemption_configuration(mut self, input: crate::types::QuotaSharePreemptionConfiguration) -> Self {
        self.preemption_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>Specifies the preemption behavior for jobs in a quota share.</p>
    pub fn set_preemption_configuration(mut self, input: ::std::option::Option<crate::types::QuotaSharePreemptionConfiguration>) -> Self {
        self.preemption_configuration = input;
        self
    }
    /// <p>Specifies the preemption behavior for jobs in a quota share.</p>
    pub fn get_preemption_configuration(&self) -> &::std::option::Option<crate::types::QuotaSharePreemptionConfiguration> {
        &self.preemption_configuration
    }
    /// <p>The state of the quota share. If the quota share is <code>ENABLED</code>, it is able to accept jobs. If the quota share is <code>DISABLED</code>, new jobs won't be accepted but jobs already submitted can finish.</p>
    pub fn state(mut self, input: crate::types::QuotaShareState) -> Self {
        self.state = ::std::option::Option::Some(input);
        self
    }
    /// <p>The state of the quota share. If the quota share is <code>ENABLED</code>, it is able to accept jobs. If the quota share is <code>DISABLED</code>, new jobs won't be accepted but jobs already submitted can finish.</p>
    pub fn set_state(mut self, input: ::std::option::Option<crate::types::QuotaShareState>) -> Self {
        self.state = input;
        self
    }
    /// <p>The state of the quota share. If the quota share is <code>ENABLED</code>, it is able to accept jobs. If the quota share is <code>DISABLED</code>, new jobs won't be accepted but jobs already submitted can finish.</p>
    pub fn get_state(&self) -> &::std::option::Option<crate::types::QuotaShareState> {
        &self.state
    }
    /// Consumes the builder and constructs a [`UpdateQuotaShareInput`](crate::operation::update_quota_share::UpdateQuotaShareInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::update_quota_share::UpdateQuotaShareInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::update_quota_share::UpdateQuotaShareInput {
            quota_share_arn: self.quota_share_arn,
            capacity_limits: self.capacity_limits,
            resource_sharing_configuration: self.resource_sharing_configuration,
            preemption_configuration: self.preemption_configuration,
            state: self.state,
        })
    }
}