software.amazon.awssdk.services.computeoptimizer.model

Class JobFilter

java.lang.Object

software.amazon.awssdk.services.computeoptimizer.model.JobFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobFilter.Builder,JobFilter>

@Generated(value="software.amazon.awssdk:codegen")
public final class JobFilter
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobFilter.Builder

Method Summary

Modifier and Type	Method and Description
static JobFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues() Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
JobFilterName	name() The name of the filter.
String	nameAsString() The name of the filter.
List<SdkField<?>>	sdkFields()
static Class<? extends JobFilter.Builder>	serializableBuilderClass()
JobFilter.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	values() The value of the filter.

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

name

public final JobFilterName name()

The name of the filter.

Specify ResourceType to return export jobs of a specific resource type (e.g., 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 return JobFilterName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The name of the filter.

Specify ResourceType to return export jobs of a specific resource type (e.g., Ec2Instance).

Specify JobStatus to return export jobs with a specific status (e.g, Complete).

See Also:

JobFilterName

nameAsString

public final String nameAsString()

The name of the filter.

Specify ResourceType to return export jobs of a specific resource type (e.g., 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 return JobFilterName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The name of the filter.

Specify ResourceType to return export jobs of a specific resource type (e.g., Ec2Instance).

Specify JobStatus to return export jobs with a specific status (e.g, Complete).

See Also:

JobFilterName

hasValues

public final boolean hasValues()

Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

values

public final List<String> 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 or AutoScalingGroup if you specify the name parameter as ResourceType. There is no filter for EBS volumes because volume recommendations cannot be exported at this time.

• Specify Queued, InProgress, Complete, or Failed if you specify the name parameter as JobStatus.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasValues() to see if a value was sent in this field.

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 or AutoScalingGroup if you specify the name parameter as ResourceType. There is no filter for EBS volumes because volume recommendations cannot be exported at this time.

• Specify Queued, InProgress, Complete, or Failed if you specify the name parameter as JobStatus.

toBuilder

public JobFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobFilter.Builder,JobFilter>

builder

public static JobFilter.Builder builder()

serializableBuilderClass

public static Class<? extends JobFilter.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