InstanceRecommendation (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.computeoptimizer.model.InstanceRecommendation

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Describes an Amazon EC2 instance recommendation.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

InstanceRecommendation()

Constructors
Constructor and Description
`InstanceRecommendation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InstanceRecommendation`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccountId()` The AWS account ID of the instance.
`String`	`getCurrentInstanceType()` The instance type of the current instance.
`String`	`getFinding()` The finding classification for the instance.
`String`	`getInstanceArn()` The Amazon Resource Name (ARN) of the current instance.
`String`	`getInstanceName()` The name of the current instance.
`Date`	`getLastRefreshTimestamp()` The time stamp of when the instance recommendation was last refreshed.
`Double`	`getLookBackPeriodInDays()` The number of days for which utilization metrics were analyzed for the instance.
`List<InstanceRecommendationOption>`	`getRecommendationOptions()` An array of objects that describe the recommendation options for the instance.
`List<RecommendationSource>`	`getRecommendationSources()` An array of objects that describe the source resource of the recommendation.
`List<UtilizationMetric>`	`getUtilizationMetrics()` An array of objects that describe the utilization metrics of the instance.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccountId(String accountId)` The AWS account ID of the instance.
`void`	`setCurrentInstanceType(String currentInstanceType)` The instance type of the current instance.
`void`	`setFinding(String finding)` The finding classification for the instance.
`void`	`setInstanceArn(String instanceArn)` The Amazon Resource Name (ARN) of the current instance.
`void`	`setInstanceName(String instanceName)` The name of the current instance.
`void`	`setLastRefreshTimestamp(Date lastRefreshTimestamp)` The time stamp of when the instance recommendation was last refreshed.
`void`	`setLookBackPeriodInDays(Double lookBackPeriodInDays)` The number of days for which utilization metrics were analyzed for the instance.
`void`	`setRecommendationOptions(Collection<InstanceRecommendationOption> recommendationOptions)` An array of objects that describe the recommendation options for the instance.
`void`	`setRecommendationSources(Collection<RecommendationSource> recommendationSources)` An array of objects that describe the source resource of the recommendation.
`void`	`setUtilizationMetrics(Collection<UtilizationMetric> utilizationMetrics)` An array of objects that describe the utilization metrics of the instance.
`String`	`toString()` Returns a string representation of this object.
`InstanceRecommendation`	`withAccountId(String accountId)` The AWS account ID of the instance.
`InstanceRecommendation`	`withCurrentInstanceType(String currentInstanceType)` The instance type of the current instance.
`InstanceRecommendation`	`withFinding(Finding finding)` The finding classification for the instance.
`InstanceRecommendation`	`withFinding(String finding)` The finding classification for the instance.
`InstanceRecommendation`	`withInstanceArn(String instanceArn)` The Amazon Resource Name (ARN) of the current instance.
`InstanceRecommendation`	`withInstanceName(String instanceName)` The name of the current instance.
`InstanceRecommendation`	`withLastRefreshTimestamp(Date lastRefreshTimestamp)` The time stamp of when the instance recommendation was last refreshed.
`InstanceRecommendation`	`withLookBackPeriodInDays(Double lookBackPeriodInDays)` The number of days for which utilization metrics were analyzed for the instance.
`InstanceRecommendation`	`withRecommendationOptions(Collection<InstanceRecommendationOption> recommendationOptions)` An array of objects that describe the recommendation options for the instance.
`InstanceRecommendation`	`withRecommendationOptions(InstanceRecommendationOption... recommendationOptions)` An array of objects that describe the recommendation options for the instance.
`InstanceRecommendation`	`withRecommendationSources(Collection<RecommendationSource> recommendationSources)` An array of objects that describe the source resource of the recommendation.
`InstanceRecommendation`	`withRecommendationSources(RecommendationSource... recommendationSources)` An array of objects that describe the source resource of the recommendation.
`InstanceRecommendation`	`withUtilizationMetrics(Collection<UtilizationMetric> utilizationMetrics)` An array of objects that describe the utilization metrics of the instance.
`InstanceRecommendation`	`withUtilizationMetrics(UtilizationMetric... utilizationMetrics)` An array of objects that describe the utilization metrics of the instance.

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

- Constructor Detail
  - InstanceRecommendation
```
public InstanceRecommendation()
```
- Method Detail
  - setInstanceArn
```
public void setInstanceArn(String instanceArn)
```
    The Amazon Resource Name (ARN) of the current instance.
    
    Parameters:
    
    instanceArn - The Amazon Resource Name (ARN) of the current instance.
  - getInstanceArn
```
public String getInstanceArn()
```
    The Amazon Resource Name (ARN) of the current instance.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the current instance.
  - withInstanceArn
```
public InstanceRecommendation withInstanceArn(String instanceArn)
```
    The Amazon Resource Name (ARN) of the current instance.
    
    Parameters:
    
    instanceArn - The Amazon Resource Name (ARN) of the current instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccountId
```
public void setAccountId(String accountId)
```
    The AWS account ID of the instance.
    
    Parameters:
    
    accountId - The AWS account ID of the instance.
  - getAccountId
```
public String getAccountId()
```
    The AWS account ID of the instance.
    
    Returns:
    
    The AWS account ID of the instance.
  - withAccountId
```
public InstanceRecommendation withAccountId(String accountId)
```
    The AWS account ID of the instance.
    
    Parameters:
    
    accountId - The AWS account ID of the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceName
```
public void setInstanceName(String instanceName)
```
    The name of the current instance.
    
    Parameters:
    
    instanceName - The name of the current instance.
  - getInstanceName
```
public String getInstanceName()
```
    The name of the current instance.
    
    Returns:
    
    The name of the current instance.
  - withInstanceName
```
public InstanceRecommendation withInstanceName(String instanceName)
```
    The name of the current instance.
    
    Parameters:
    
    instanceName - The name of the current instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCurrentInstanceType
```
public void setCurrentInstanceType(String currentInstanceType)
```
    The instance type of the current instance.
    
    Parameters:
    
    currentInstanceType - The instance type of the current instance.
  - getCurrentInstanceType
```
public String getCurrentInstanceType()
```
    The instance type of the current instance.
    
    Returns:
    
    The instance type of the current instance.
  - withCurrentInstanceType
```
public InstanceRecommendation withCurrentInstanceType(String currentInstanceType)
```
    The instance type of the current instance.
    
    Parameters:
    
    currentInstanceType - The instance type of the current instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFinding
```
public void setFinding(String finding)
```
    The finding classification for the instance.
    
    Findings for instances include:
    - Underprovisioned —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance.
    - Overprovisioned —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost.
    - Optimized —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. An optimized instance runs your workloads with optimal performance and infrastructure cost. For optimized resources, AWS Compute Optimizer might recommend a new generation instance type.
    Parameters:
    finding - The finding classification for the instance.
    
    Findings for instances include:
    
    Underprovisioned —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance.
    
    Overprovisioned —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost.
    
    Optimized —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. An optimized instance runs your workloads with optimal performance and infrastructure cost. For optimized resources, AWS Compute Optimizer might recommend a new generation instance type.
    See Also:
    
    Finding
  - getFinding
```
public String getFinding()
```
    The finding classification for the instance.
    
    Findings for instances include:
    - Underprovisioned —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance.
    - Overprovisioned —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost.
    - Optimized —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. An optimized instance runs your workloads with optimal performance and infrastructure cost. For optimized resources, AWS Compute Optimizer might recommend a new generation instance type.
    Returns:
    The finding classification for the instance.
    
    Findings for instances include:
    
    Underprovisioned —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance.
    
    Overprovisioned —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost.
    
    Optimized —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. An optimized instance runs your workloads with optimal performance and infrastructure cost. For optimized resources, AWS Compute Optimizer might recommend a new generation instance type.
    See Also:
    
    Finding
  - withFinding
```
public InstanceRecommendation withFinding(String finding)
```
    The finding classification for the instance.
    
    Findings for instances include:
    - Underprovisioned —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance.
    - Overprovisioned —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost.
    - Optimized —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. An optimized instance runs your workloads with optimal performance and infrastructure cost. For optimized resources, AWS Compute Optimizer might recommend a new generation instance type.
    Parameters:
    finding - The finding classification for the instance.
    
    Findings for instances include:
    
    Underprovisioned —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance.
    
    Overprovisioned —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost.
    
    Optimized —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. An optimized instance runs your workloads with optimal performance and infrastructure cost. For optimized resources, AWS Compute Optimizer might recommend a new generation instance type.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Finding
  - withFinding
```
public InstanceRecommendation withFinding(Finding finding)
```
    The finding classification for the instance.
    
    Findings for instances include:
    - Underprovisioned —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance.
    - Overprovisioned —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost.
    - Optimized —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. An optimized instance runs your workloads with optimal performance and infrastructure cost. For optimized resources, AWS Compute Optimizer might recommend a new generation instance type.
    Parameters:
    finding - The finding classification for the instance.
    
    Findings for instances include:
    
    Underprovisioned —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance.
    
    Overprovisioned —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost.
    
    Optimized —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. An optimized instance runs your workloads with optimal performance and infrastructure cost. For optimized resources, AWS Compute Optimizer might recommend a new generation instance type.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Finding
  - getUtilizationMetrics
```
public List<UtilizationMetric> getUtilizationMetrics()
```
    An array of objects that describe the utilization metrics of the instance.
    
    Returns:
    
    An array of objects that describe the utilization metrics of the instance.
  - setUtilizationMetrics
```
public void setUtilizationMetrics(Collection<UtilizationMetric> utilizationMetrics)
```
    An array of objects that describe the utilization metrics of the instance.
    
    Parameters:
    
    utilizationMetrics - An array of objects that describe the utilization metrics of the instance.
  - withUtilizationMetrics
```
public InstanceRecommendation withUtilizationMetrics(UtilizationMetric... utilizationMetrics)
```
    An array of objects that describe the utilization metrics of the instance.
    
    NOTE: This method appends the values to the existing list (if any). Use setUtilizationMetrics(java.util.Collection) or withUtilizationMetrics(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    utilizationMetrics - An array of objects that describe the utilization metrics of the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUtilizationMetrics
```
public InstanceRecommendation withUtilizationMetrics(Collection<UtilizationMetric> utilizationMetrics)
```
    An array of objects that describe the utilization metrics of the instance.
    
    Parameters:
    
    utilizationMetrics - An array of objects that describe the utilization metrics of the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLookBackPeriodInDays
```
public void setLookBackPeriodInDays(Double lookBackPeriodInDays)
```
    The number of days for which utilization metrics were analyzed for the instance.
    
    Parameters:
    
    lookBackPeriodInDays - The number of days for which utilization metrics were analyzed for the instance.
  - getLookBackPeriodInDays
```
public Double getLookBackPeriodInDays()
```
    The number of days for which utilization metrics were analyzed for the instance.
    
    Returns:
    
    The number of days for which utilization metrics were analyzed for the instance.
  - withLookBackPeriodInDays
```
public InstanceRecommendation withLookBackPeriodInDays(Double lookBackPeriodInDays)
```
    The number of days for which utilization metrics were analyzed for the instance.
    
    Parameters:
    
    lookBackPeriodInDays - The number of days for which utilization metrics were analyzed for the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRecommendationOptions
```
public List<InstanceRecommendationOption> getRecommendationOptions()
```
    An array of objects that describe the recommendation options for the instance.
    
    Returns:
    
    An array of objects that describe the recommendation options for the instance.
  - setRecommendationOptions
```
public void setRecommendationOptions(Collection<InstanceRecommendationOption> recommendationOptions)
```
    An array of objects that describe the recommendation options for the instance.
    
    Parameters:
    
    recommendationOptions - An array of objects that describe the recommendation options for the instance.
  - withRecommendationOptions
```
public InstanceRecommendation withRecommendationOptions(InstanceRecommendationOption... recommendationOptions)
```
    An array of objects that describe the recommendation options for the instance.
    
    NOTE: This method appends the values to the existing list (if any). Use setRecommendationOptions(java.util.Collection) or withRecommendationOptions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    recommendationOptions - An array of objects that describe the recommendation options for the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRecommendationOptions
```
public InstanceRecommendation withRecommendationOptions(Collection<InstanceRecommendationOption> recommendationOptions)
```
    An array of objects that describe the recommendation options for the instance.
    
    Parameters:
    
    recommendationOptions - An array of objects that describe the recommendation options for the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRecommendationSources
```
public List<RecommendationSource> getRecommendationSources()
```
    An array of objects that describe the source resource of the recommendation.
    
    Returns:
    
    An array of objects that describe the source resource of the recommendation.
  - setRecommendationSources
```
public void setRecommendationSources(Collection<RecommendationSource> recommendationSources)
```
    An array of objects that describe the source resource of the recommendation.
    
    Parameters:
    
    recommendationSources - An array of objects that describe the source resource of the recommendation.
  - withRecommendationSources
```
public InstanceRecommendation withRecommendationSources(RecommendationSource... recommendationSources)
```
    An array of objects that describe the source resource of the recommendation.
    
    NOTE: This method appends the values to the existing list (if any). Use setRecommendationSources(java.util.Collection) or withRecommendationSources(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    recommendationSources - An array of objects that describe the source resource of the recommendation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRecommendationSources
```
public InstanceRecommendation withRecommendationSources(Collection<RecommendationSource> recommendationSources)
```
    An array of objects that describe the source resource of the recommendation.
    
    Parameters:
    
    recommendationSources - An array of objects that describe the source resource of the recommendation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastRefreshTimestamp
```
public void setLastRefreshTimestamp(Date lastRefreshTimestamp)
```
    The time stamp of when the instance recommendation was last refreshed.
    
    Parameters:
    
    lastRefreshTimestamp - The time stamp of when the instance recommendation was last refreshed.
  - getLastRefreshTimestamp
```
public Date getLastRefreshTimestamp()
```
    The time stamp of when the instance recommendation was last refreshed.
    
    Returns:
    
    The time stamp of when the instance recommendation was last refreshed.
  - withLastRefreshTimestamp
```
public InstanceRecommendation withLastRefreshTimestamp(Date lastRefreshTimestamp)
```
    The time stamp of when the instance recommendation was last refreshed.
    
    Parameters:
    
    lastRefreshTimestamp - The time stamp of when the instance recommendation was last refreshed.
    
    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 InstanceRecommendation 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 InstanceRecommendation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstanceRecommendation

Method Detail

setInstanceArn

getInstanceArn

withInstanceArn

setAccountId

getAccountId

withAccountId

setInstanceName

getInstanceName

withInstanceName

setCurrentInstanceType

getCurrentInstanceType

withCurrentInstanceType

setFinding

getFinding

withFinding

withFinding

getUtilizationMetrics

setUtilizationMetrics

withUtilizationMetrics

withUtilizationMetrics

setLookBackPeriodInDays

getLookBackPeriodInDays

withLookBackPeriodInDays

getRecommendationOptions

setRecommendationOptions

withRecommendationOptions

withRecommendationOptions

getRecommendationSources

setRecommendationSources

withRecommendationSources

withRecommendationSources

setLastRefreshTimestamp

getLastRefreshTimestamp

withLastRefreshTimestamp

toString

equals

hashCode

clone

marshall