Class JobFilter
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<JobFilter.Builder,
JobFilter>
Describes a filter that returns a more specific list of recommendation export jobs. Use this filter with the DescribeRecommendationExportJobs action.
You can use EBSFilter
with the GetEBSVolumeRecommendations action,
LambdaFunctionRecommendationFilter
with the GetLambdaFunctionRecommendations action, and
Filter
with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations
actions.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic JobFilter.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Values property.final JobFilterName
name()
The name of the filter.final String
The name of the filter.static Class
<? extends JobFilter.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.values()
The value of the filter.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the filter.
Specify
ResourceType
to return export jobs of a specific resource type (for example,Ec2Instance
).Specify
JobStatus
to return export jobs with a specific status (e.g,Complete
).If the service returns an enum value that is not available in the current SDK version,
name
will returnJobFilterName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The name of the filter.
Specify
ResourceType
to return export jobs of a specific resource type (for example,Ec2Instance
).Specify
JobStatus
to return export jobs with a specific status (e.g,Complete
). - See Also:
-
nameAsString
The name of the filter.
Specify
ResourceType
to return export jobs of a specific resource type (for example,Ec2Instance
).Specify
JobStatus
to return export jobs with a specific status (e.g,Complete
).If the service returns an enum value that is not available in the current SDK version,
name
will returnJobFilterName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The name of the filter.
Specify
ResourceType
to return export jobs of a specific resource type (for example,Ec2Instance
).Specify
JobStatus
to return export jobs with a specific status (e.g,Complete
). - See Also:
-
hasValues
public final boolean hasValues()For responses, this returns true if the service returned a value for the Values 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. -
values
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the
name
parameter:-
Specify
Ec2Instance
orAutoScalingGroup
if you specify thename
parameter asResourceType
. There is no filter for EBS volumes because volume recommendations cannot be exported at this time. -
Specify
Queued
,InProgress
,Complete
, orFailed
if you specify thename
parameter asJobStatus
.
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
hasValues()
method.- Returns:
- The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the
name
parameter:-
Specify
Ec2Instance
orAutoScalingGroup
if you specify thename
parameter asResourceType
. There is no filter for EBS volumes because volume recommendations cannot be exported at this time. -
Specify
Queued
,InProgress
,Complete
, orFailed
if you specify thename
parameter asJobStatus
.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<JobFilter.Builder,
JobFilter> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-