Class GetEc2InstanceRecommendationsRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.computeoptimizer.model.ComputeOptimizerRequest
-
- software.amazon.awssdk.services.computeoptimizer.model.GetEc2InstanceRecommendationsRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetEc2InstanceRecommendationsRequest.Builder,GetEc2InstanceRecommendationsRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetEc2InstanceRecommendationsRequest extends ComputeOptimizerRequest implements ToCopyableBuilder<GetEc2InstanceRecommendationsRequest.Builder,GetEc2InstanceRecommendationsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetEc2InstanceRecommendationsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>accountIds()The ID of the Amazon Web Services account for which to return instance recommendations.static GetEc2InstanceRecommendationsRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<Filter>filters()An array of objects to specify a filter that returns a more specific list of instance recommendations.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAccountIds()For responses, this returns true if the service returned a value for the AccountIds property.booleanhasFilters()For responses, this returns true if the service returned a value for the Filters property.inthashCode()booleanhasInstanceArns()For responses, this returns true if the service returned a value for the InstanceArns property.List<String>instanceArns()The Amazon Resource Name (ARN) of the instances for which to return recommendations.IntegermaxResults()The maximum number of instance recommendations to return with a single request.StringnextToken()The token to advance to the next page of instance recommendations.RecommendationPreferencesrecommendationPreferences()An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.List<SdkField<?>>sdkFields()static Class<? extends GetEc2InstanceRecommendationsRequest.Builder>serializableBuilderClass()GetEc2InstanceRecommendationsRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
hasInstanceArns
public final boolean hasInstanceArns()
For responses, this returns true if the service returned a value for the InstanceArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
instanceArns
public final List<String> instanceArns()
The Amazon Resource Name (ARN) of the instances for which to return 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
hasInstanceArns()method.- Returns:
- The Amazon Resource Name (ARN) of the instances for which to return recommendations.
-
nextToken
public final String nextToken()
The token to advance to the next page of instance recommendations.
- Returns:
- The token to advance to the next page of instance recommendations.
-
maxResults
public final Integer maxResults()
The maximum number of instance recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned
nextTokenvalue.- Returns:
- The maximum number of instance recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned
nextTokenvalue.
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
filters
public final List<Filter> filters()
An array of objects to specify a filter that returns a more specific list of instance 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
hasFilters()method.- Returns:
- An array of objects to specify a filter that returns a more specific list of instance recommendations.
-
hasAccountIds
public final boolean hasAccountIds()
For responses, this returns true if the service returned a value for the AccountIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
accountIds
public final List<String> accountIds()
The ID of the Amazon Web Services account for which to return instance recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.
Only one account ID can be specified per request.
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
hasAccountIds()method.- Returns:
- The ID of the Amazon Web Services account for which to return instance recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.
Only one account ID can be specified per request.
-
recommendationPreferences
public final RecommendationPreferences recommendationPreferences()
An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.
- Returns:
- An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.
-
toBuilder
public GetEc2InstanceRecommendationsRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetEc2InstanceRecommendationsRequest.Builder,GetEc2InstanceRecommendationsRequest>- Specified by:
toBuilderin classComputeOptimizerRequest
-
builder
public static GetEc2InstanceRecommendationsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetEc2InstanceRecommendationsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-