FairsharePolicy (AWS Java SDK for AWS Batch 1.12.124 API)

java.lang.Object
- com.amazonaws.services.batch.model.FairsharePolicy

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The fair share policy for a scheduling policy.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FairsharePolicy()

Constructors
Constructor and Description
`FairsharePolicy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FairsharePolicy`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getComputeReservation()` A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.
`Integer`	`getShareDecaySeconds()` The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds.
`List<ShareAttributes>`	`getShareDistribution()` An array of `SharedIdentifier` objects that contain the weights for the fair share identifiers for the fair share policy.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setComputeReservation(Integer computeReservation)` A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.
`void`	`setShareDecaySeconds(Integer shareDecaySeconds)` The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds.
`void`	`setShareDistribution(Collection<ShareAttributes> shareDistribution)` An array of `SharedIdentifier` objects that contain the weights for the fair share identifiers for the fair share policy.
`String`	`toString()` Returns a string representation of this object.
`FairsharePolicy`	`withComputeReservation(Integer computeReservation)` A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.
`FairsharePolicy`	`withShareDecaySeconds(Integer shareDecaySeconds)` The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds.
`FairsharePolicy`	`withShareDistribution(Collection<ShareAttributes> shareDistribution)` An array of `SharedIdentifier` objects that contain the weights for the fair share identifiers for the fair share policy.
`FairsharePolicy`	`withShareDistribution(ShareAttributes... shareDistribution)` An array of `SharedIdentifier` objects that contain the weights for the fair share identifiers for the fair share policy.

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

- Constructor Detail
  - FairsharePolicy
```
public FairsharePolicy()
```
- Method Detail
  - setShareDecaySeconds
```
public void setShareDecaySeconds(Integer shareDecaySeconds)
```
    The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds. A value of zero (0) indicates that only current usage should be measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
    
    Parameters:
    
    shareDecaySeconds - The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds. A value of zero (0) indicates that only current usage should be measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
  - getShareDecaySeconds
```
public Integer getShareDecaySeconds()
```
    The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds. A value of zero (0) indicates that only current usage should be measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
    
    Returns:
    
    The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds. A value of zero (0) indicates that only current usage should be measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
  - withShareDecaySeconds
```
public FairsharePolicy withShareDecaySeconds(Integer shareDecaySeconds)
```
    The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds. A value of zero (0) indicates that only current usage should be measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
    
    Parameters:
    
    shareDecaySeconds - The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds. A value of zero (0) indicates that only current usage should be measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComputeReservation
```
public void setComputeReservation(Integer computeReservation)
```
    A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.
    
    The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.
    
    For example, a computeReservation value of 50 indicates that Batch should reserve 50% of the maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there is only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.
    
    The minimum value is 0 and the maximum value is 99.
    
    Parameters:
    
    computeReservation - A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.
    
    The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.
    
    For example, a computeReservation value of 50 indicates that Batch should reserve 50% of the maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there is only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.
    
    The minimum value is 0 and the maximum value is 99.
  - getComputeReservation
```
public Integer getComputeReservation()
```
    A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.
    
    The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.
    
    For example, a computeReservation value of 50 indicates that Batch should reserve 50% of the maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there is only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.
    
    The minimum value is 0 and the maximum value is 99.
    
    Returns:
    
    A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.
    
    The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.
    
    For example, a computeReservation value of 50 indicates that Batch should reserve 50% of the maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there is only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.
    
    The minimum value is 0 and the maximum value is 99.
  - withComputeReservation
```
public FairsharePolicy withComputeReservation(Integer computeReservation)
```
    A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.
    
    The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.
    
    For example, a computeReservation value of 50 indicates that Batch should reserve 50% of the maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there is only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.
    
    The minimum value is 0 and the maximum value is 99.
    
    Parameters:
    
    computeReservation - A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.
    
    The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.
    
    For example, a computeReservation value of 50 indicates that Batch should reserve 50% of the maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there is only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.
    
    The minimum value is 0 and the maximum value is 99.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getShareDistribution
```
public List<ShareAttributes> getShareDistribution()
```
    An array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.
    
    Returns:
    
    An array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.
  - setShareDistribution
```
public void setShareDistribution(Collection<ShareAttributes> shareDistribution)
```
    An array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.
    
    Parameters:
    
    shareDistribution - An array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.
  - withShareDistribution
```
public FairsharePolicy withShareDistribution(ShareAttributes... shareDistribution)
```
    An array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.
    
    NOTE: This method appends the values to the existing list (if any). Use setShareDistribution(java.util.Collection) or withShareDistribution(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    shareDistribution - An array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withShareDistribution
```
public FairsharePolicy withShareDistribution(Collection<ShareAttributes> shareDistribution)
```
    An array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.
    
    Parameters:
    
    shareDistribution - An array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.
    
    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 FairsharePolicy clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class FairsharePolicy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FairsharePolicy

Method Detail

setShareDecaySeconds

getShareDecaySeconds

withShareDecaySeconds

setComputeReservation

getComputeReservation

withComputeReservation

getShareDistribution

setShareDistribution

withShareDistribution

withShareDistribution

toString

equals

hashCode

clone

marshall