LambdaFunctionRecommendation (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.computeoptimizer.model.LambdaFunctionRecommendation

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<LambdaFunctionRecommendation.Builder,LambdaFunctionRecommendation>

@Generated(value="software.amazon.awssdk:codegen")
public final class LambdaFunctionRecommendation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LambdaFunctionRecommendation.Builder,LambdaFunctionRecommendation>

Describes an Lambda function recommendation.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface LambdaFunctionRecommendation.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`LambdaFunctionRecommendation.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`accountId()` The Amazon Web Services account ID of the function.
`static LambdaFunctionRecommendation.Builder`	`builder()`
`Integer`	`currentMemorySize()` The amount of memory, in MB, that's allocated to the current function.
`CurrentPerformanceRisk`	`currentPerformanceRisk()` The risk of the current Lambda function not meeting the performance needs of its workloads.
`String`	`currentPerformanceRiskAsString()` The risk of the current Lambda function not meeting the performance needs of its workloads.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`LambdaFunctionRecommendationFinding`	`finding()` The finding classification of the function.
`String`	`findingAsString()` The finding classification of the function.
`List<LambdaFunctionRecommendationFindingReasonCode>`	`findingReasonCodes()` The reason for the finding classification of the function.
`List<String>`	`findingReasonCodesAsStrings()` The reason for the finding classification of the function.
`String`	`functionArn()` The Amazon Resource Name (ARN) of the current function.
`String`	`functionVersion()` The version number of the current function.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFindingReasonCodes()` For responses, this returns true if the service returned a value for the FindingReasonCodes property.
`int`	`hashCode()`
`boolean`	`hasMemorySizeRecommendationOptions()` For responses, this returns true if the service returned a value for the MemorySizeRecommendationOptions property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasUtilizationMetrics()` For responses, this returns true if the service returned a value for the UtilizationMetrics property.
`Instant`	`lastRefreshTimestamp()` The timestamp of when the function recommendation was last generated.
`Double`	`lookbackPeriodInDays()` The number of days for which utilization metrics were analyzed for the function.
`List<LambdaFunctionMemoryRecommendationOption>`	`memorySizeRecommendationOptions()` An array of objects that describe the memory configuration recommendation options for the function.
`Long`	`numberOfInvocations()` The number of times your function code was applied during the look-back period.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends LambdaFunctionRecommendation.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` A list of tags assigned to your Lambda function recommendations.
`LambdaFunctionRecommendation.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<LambdaFunctionUtilizationMetric>`	`utilizationMetrics()` An array of objects that describe the utilization metrics of the function.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - functionArn
```
public final String functionArn()
```
    The Amazon Resource Name (ARN) of the current function.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the current function.
  - functionVersion
```
public final String functionVersion()
```
    The version number of the current function.
    
    Returns:
    
    The version number of the current function.
  - accountId
```
public final String accountId()
```
    The Amazon Web Services account ID of the function.
    
    Returns:
    
    The Amazon Web Services account ID of the function.
  - currentMemorySize
```
public final Integer currentMemorySize()
```
    The amount of memory, in MB, that's allocated to the current function.
    
    Returns:
    
    The amount of memory, in MB, that's allocated to the current function.
  - numberOfInvocations
```
public final Long numberOfInvocations()
```
    The number of times your function code was applied during the look-back period.
    
    Returns:
    
    The number of times your function code was applied during the look-back period.
  - hasUtilizationMetrics
```
public final boolean hasUtilizationMetrics()
```
    For responses, this returns true if the service returned a value for the UtilizationMetrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - utilizationMetrics
```
public final List<LambdaFunctionUtilizationMetric> utilizationMetrics()
```
    An array of objects that describe the utilization metrics of the function.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUtilizationMetrics() method.
    
    Returns:
    
    An array of objects that describe the utilization metrics of the function.
  - lookbackPeriodInDays
```
public final Double lookbackPeriodInDays()
```
    The number of days for which utilization metrics were analyzed for the function.
    
    Returns:
    
    The number of days for which utilization metrics were analyzed for the function.
  - lastRefreshTimestamp
```
public final Instant lastRefreshTimestamp()
```
    The timestamp of when the function recommendation was last generated.
    
    Returns:
    
    The timestamp of when the function recommendation was last generated.
  - finding
```
public final LambdaFunctionRecommendationFinding finding()
```
    The finding classification of the function.
    
    Findings for functions include:
    - Optimized — The function is correctly provisioned to run your workload based on its current configuration and its utilization history. This finding classification does not include finding reason codes.
    - NotOptimized — The function is performing at a higher level (over-provisioned) or at a lower level (under-provisioned) than required for your workload because its current configuration is not optimal. Over-provisioned resources might lead to unnecessary infrastructure cost, and under-provisioned resources might lead to poor application performance. This finding classification can include the MemoryUnderprovisioned and MemoryUnderprovisioned finding reason codes.
    - Unavailable — Compute Optimizer was unable to generate a recommendation for the function. This could be because the function has not accumulated sufficient metric data, or the function does not qualify for a recommendation. This finding classification can include the InsufficientData and Inconclusive finding reason codes.
      
      Functions with a finding of unavailable are not returned unless you specify the filter parameter with a value of Unavailable in your GetLambdaFunctionRecommendations request.
    If the service returns an enum value that is not available in the current SDK version, finding will return LambdaFunctionRecommendationFinding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from findingAsString().
    Returns:
    The finding classification of the function.
    
    Findings for functions include:
    
    Optimized — The function is correctly provisioned to run your workload based on its current configuration and its utilization history. This finding classification does not include finding reason codes.
    
    NotOptimized — The function is performing at a higher level (over-provisioned) or at a lower level (under-provisioned) than required for your workload because its current configuration is not optimal. Over-provisioned resources might lead to unnecessary infrastructure cost, and under-provisioned resources might lead to poor application performance. This finding classification can include the MemoryUnderprovisioned and MemoryUnderprovisioned finding reason codes.
    
    Unavailable — Compute Optimizer was unable to generate a recommendation for the function. This could be because the function has not accumulated sufficient metric data, or the function does not qualify for a recommendation. This finding classification can include the InsufficientData and Inconclusive finding reason codes.
    
    Functions with a finding of unavailable are not returned unless you specify the filter parameter with a value of Unavailable in your GetLambdaFunctionRecommendations request.
    See Also:
    
    LambdaFunctionRecommendationFinding
  - findingAsString
```
public final String findingAsString()
```
    The finding classification of the function.
    
    Findings for functions include:
    - Optimized — The function is correctly provisioned to run your workload based on its current configuration and its utilization history. This finding classification does not include finding reason codes.
    - NotOptimized — The function is performing at a higher level (over-provisioned) or at a lower level (under-provisioned) than required for your workload because its current configuration is not optimal. Over-provisioned resources might lead to unnecessary infrastructure cost, and under-provisioned resources might lead to poor application performance. This finding classification can include the MemoryUnderprovisioned and MemoryUnderprovisioned finding reason codes.
    - Unavailable — Compute Optimizer was unable to generate a recommendation for the function. This could be because the function has not accumulated sufficient metric data, or the function does not qualify for a recommendation. This finding classification can include the InsufficientData and Inconclusive finding reason codes.
      
      Functions with a finding of unavailable are not returned unless you specify the filter parameter with a value of Unavailable in your GetLambdaFunctionRecommendations request.
    If the service returns an enum value that is not available in the current SDK version, finding will return LambdaFunctionRecommendationFinding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from findingAsString().
    Returns:
    The finding classification of the function.
    
    Findings for functions include:
    
    Optimized — The function is correctly provisioned to run your workload based on its current configuration and its utilization history. This finding classification does not include finding reason codes.
    
    NotOptimized — The function is performing at a higher level (over-provisioned) or at a lower level (under-provisioned) than required for your workload because its current configuration is not optimal. Over-provisioned resources might lead to unnecessary infrastructure cost, and under-provisioned resources might lead to poor application performance. This finding classification can include the MemoryUnderprovisioned and MemoryUnderprovisioned finding reason codes.
    
    Unavailable — Compute Optimizer was unable to generate a recommendation for the function. This could be because the function has not accumulated sufficient metric data, or the function does not qualify for a recommendation. This finding classification can include the InsufficientData and Inconclusive finding reason codes.
    
    Functions with a finding of unavailable are not returned unless you specify the filter parameter with a value of Unavailable in your GetLambdaFunctionRecommendations request.
    See Also:
    
    LambdaFunctionRecommendationFinding
  - findingReasonCodes
```
public final List<LambdaFunctionRecommendationFindingReasonCode> findingReasonCodes()
```
    The reason for the finding classification of the function.
    
    Functions that have a finding classification of Optimized don't have a finding reason code.
    
    Finding reason codes for functions include:
    - MemoryOverprovisioned — The function is over-provisioned when its memory configuration can be sized down while still meeting the performance requirements of your workload. An over-provisioned function might lead to unnecessary infrastructure cost. This finding reason code is part of the NotOptimized finding classification.
    - MemoryUnderprovisioned — The function is under-provisioned when its memory configuration doesn't meet the performance requirements of the workload. An under-provisioned function might lead to poor application performance. This finding reason code is part of the NotOptimized finding classification.
    - InsufficientData — The function does not have sufficient metric data for Compute Optimizer to generate a recommendation. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide. This finding reason code is part of the Unavailable finding classification.
    - Inconclusive — The function does not qualify for a recommendation because Compute Optimizer cannot generate a recommendation with a high degree of confidence. This finding reason code is part of the Unavailable finding classification.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFindingReasonCodes() method.
    Returns:
    The reason for the finding classification of the function.
    
    Functions that have a finding classification of Optimized don't have a finding reason code.
    
    Finding reason codes for functions include:
    
    MemoryOverprovisioned — The function is over-provisioned when its memory configuration can be sized down while still meeting the performance requirements of your workload. An over-provisioned function might lead to unnecessary infrastructure cost. This finding reason code is part of the NotOptimized finding classification.
    
    MemoryUnderprovisioned — The function is under-provisioned when its memory configuration doesn't meet the performance requirements of the workload. An under-provisioned function might lead to poor application performance. This finding reason code is part of the NotOptimized finding classification.
    
    InsufficientData — The function does not have sufficient metric data for Compute Optimizer to generate a recommendation. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide. This finding reason code is part of the Unavailable finding classification.
    
    Inconclusive — The function does not qualify for a recommendation because Compute Optimizer cannot generate a recommendation with a high degree of confidence. This finding reason code is part of the Unavailable finding classification.
  - hasFindingReasonCodes
```
public final boolean hasFindingReasonCodes()
```
    For responses, this returns true if the service returned a value for the FindingReasonCodes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - findingReasonCodesAsStrings
```
public final List<String> findingReasonCodesAsStrings()
```
    The reason for the finding classification of the function.
    
    Functions that have a finding classification of Optimized don't have a finding reason code.
    
    Finding reason codes for functions include:
    - MemoryOverprovisioned — The function is over-provisioned when its memory configuration can be sized down while still meeting the performance requirements of your workload. An over-provisioned function might lead to unnecessary infrastructure cost. This finding reason code is part of the NotOptimized finding classification.
    - MemoryUnderprovisioned — The function is under-provisioned when its memory configuration doesn't meet the performance requirements of the workload. An under-provisioned function might lead to poor application performance. This finding reason code is part of the NotOptimized finding classification.
    - InsufficientData — The function does not have sufficient metric data for Compute Optimizer to generate a recommendation. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide. This finding reason code is part of the Unavailable finding classification.
    - Inconclusive — The function does not qualify for a recommendation because Compute Optimizer cannot generate a recommendation with a high degree of confidence. This finding reason code is part of the Unavailable finding classification.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFindingReasonCodes() method.
    Returns:
    The reason for the finding classification of the function.
    
    Functions that have a finding classification of Optimized don't have a finding reason code.
    
    Finding reason codes for functions include:
    
    MemoryOverprovisioned — The function is over-provisioned when its memory configuration can be sized down while still meeting the performance requirements of your workload. An over-provisioned function might lead to unnecessary infrastructure cost. This finding reason code is part of the NotOptimized finding classification.
    
    MemoryUnderprovisioned — The function is under-provisioned when its memory configuration doesn't meet the performance requirements of the workload. An under-provisioned function might lead to poor application performance. This finding reason code is part of the NotOptimized finding classification.
    
    InsufficientData — The function does not have sufficient metric data for Compute Optimizer to generate a recommendation. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide. This finding reason code is part of the Unavailable finding classification.
    
    Inconclusive — The function does not qualify for a recommendation because Compute Optimizer cannot generate a recommendation with a high degree of confidence. This finding reason code is part of the Unavailable finding classification.
  - hasMemorySizeRecommendationOptions
```
public final boolean hasMemorySizeRecommendationOptions()
```
    For responses, this returns true if the service returned a value for the MemorySizeRecommendationOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - memorySizeRecommendationOptions
```
public final List<LambdaFunctionMemoryRecommendationOption> memorySizeRecommendationOptions()
```
    An array of objects that describe the memory configuration recommendation options for the function.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMemorySizeRecommendationOptions() method.
    
    Returns:
    
    An array of objects that describe the memory configuration recommendation options for the function.
  - currentPerformanceRisk
```
public final CurrentPerformanceRisk currentPerformanceRisk()
```
    The risk of the current Lambda function not meeting the performance needs of its workloads. The higher the risk, the more likely the current Lambda function requires more memory.
    
    If the service returns an enum value that is not available in the current SDK version, currentPerformanceRisk will return CurrentPerformanceRisk.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currentPerformanceRiskAsString().
    
    Returns:
    
    The risk of the current Lambda function not meeting the performance needs of its workloads. The higher the risk, the more likely the current Lambda function requires more memory.
    
    See Also:
    
    CurrentPerformanceRisk
  - currentPerformanceRiskAsString
```
public final String currentPerformanceRiskAsString()
```
    The risk of the current Lambda function not meeting the performance needs of its workloads. The higher the risk, the more likely the current Lambda function requires more memory.
    
    If the service returns an enum value that is not available in the current SDK version, currentPerformanceRisk will return CurrentPerformanceRisk.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currentPerformanceRiskAsString().
    
    Returns:
    
    The risk of the current Lambda function not meeting the performance needs of its workloads. The higher the risk, the more likely the current Lambda function requires more memory.
    
    See Also:
    
    CurrentPerformanceRisk
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    A list of tags assigned to your Lambda function recommendations.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    A list of tags assigned to your Lambda function recommendations.
  - toBuilder
```
public LambdaFunctionRecommendation.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<LambdaFunctionRecommendation.Builder,LambdaFunctionRecommendation>
  - builder
```
public static LambdaFunctionRecommendation.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends LambdaFunctionRecommendation.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class LambdaFunctionRecommendation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

functionArn

functionVersion

accountId

currentMemorySize

numberOfInvocations

hasUtilizationMetrics

utilizationMetrics

lookbackPeriodInDays

lastRefreshTimestamp

finding

findingAsString

findingReasonCodes

hasFindingReasonCodes

findingReasonCodesAsStrings

hasMemorySizeRecommendationOptions

memorySizeRecommendationOptions

currentPerformanceRisk

currentPerformanceRiskAsString

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields