CapacityProviderStrategyItem (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ecs.model.CapacityProviderStrategyItem

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CapacityProviderStrategyItem
extends Object
implements Serializable, Cloneable, StructuredPojo

The details of a capacity provider strategy.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CapacityProviderStrategyItem()

Constructors
Constructor and Description
`CapacityProviderStrategyItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CapacityProviderStrategyItem`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getBase()` The base value designates how many tasks, at a minimum, to run on the specified capacity provider.
`String`	`getCapacityProvider()` The short name or full Amazon Resource Name (ARN) of the capacity provider.
`Integer`	`getWeight()` The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBase(Integer base)` The base value designates how many tasks, at a minimum, to run on the specified capacity provider.
`void`	`setCapacityProvider(String capacityProvider)` The short name or full Amazon Resource Name (ARN) of the capacity provider.
`void`	`setWeight(Integer weight)` The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
`String`	`toString()` Returns a string representation of this object.
`CapacityProviderStrategyItem`	`withBase(Integer base)` The base value designates how many tasks, at a minimum, to run on the specified capacity provider.
`CapacityProviderStrategyItem`	`withCapacityProvider(String capacityProvider)` The short name or full Amazon Resource Name (ARN) of the capacity provider.
`CapacityProviderStrategyItem`	`withWeight(Integer weight)` The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CapacityProviderStrategyItem
```
public CapacityProviderStrategyItem()
```
- Method Detail
  - setCapacityProvider
```
public void setCapacityProvider(String capacityProvider)
```
    The short name or full Amazon Resource Name (ARN) of the capacity provider.
    
    Parameters:
    
    capacityProvider - The short name or full Amazon Resource Name (ARN) of the capacity provider.
  - getCapacityProvider
```
public String getCapacityProvider()
```
    The short name or full Amazon Resource Name (ARN) of the capacity provider.
    
    Returns:
    
    The short name or full Amazon Resource Name (ARN) of the capacity provider.
  - withCapacityProvider
```
public CapacityProviderStrategyItem withCapacityProvider(String capacityProvider)
```
    The short name or full Amazon Resource Name (ARN) of the capacity provider.
    
    Parameters:
    
    capacityProvider - The short name or full Amazon Resource Name (ARN) of the capacity provider.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWeight
```
public void setWeight(Integer weight)
```
    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
    
    For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that is run using capacityProviderA, four tasks would use capacityProviderB.
    
    Parameters:
    
    weight - The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
    
    For example, if you have a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that is run using capacityProviderA, four tasks would use capacityProviderB.
  - getWeight
```
public Integer getWeight()
```
    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
    
    For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that is run using capacityProviderA, four tasks would use capacityProviderB.
    
    Returns:
    
    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
    
    For example, if you have a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that is run using capacityProviderA, four tasks would use capacityProviderB.
  - withWeight
```
public CapacityProviderStrategyItem withWeight(Integer weight)
```
    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
    
    For example, if you have a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that is run using capacityProviderA, four tasks would use capacityProviderB.
    
    Parameters:
    
    weight - The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
    
    For example, if you have a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that is run using capacityProviderA, four tasks would use capacityProviderB.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBase
```
public void setBase(Integer base)
```
    The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
    
    Parameters:
    
    base - The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
  - getBase
```
public Integer getBase()
```
    The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
    
    Returns:
    
    The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
  - withBase
```
public CapacityProviderStrategyItem withBase(Integer base)
```
    The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
    
    Parameters:
    
    base - The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CapacityProviderStrategyItem clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CapacityProviderStrategyItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CapacityProviderStrategyItem

Method Detail

setCapacityProvider

getCapacityProvider

withCapacityProvider

setWeight

getWeight

withWeight

setBase

getBase

withBase

toString

equals

hashCode

clone

marshall