Package software.amazon.awssdk.services.elasticbeanstalk.model

Class PlatformFilter

java.lang.Object

software.amazon.awssdk.services.elasticbeanstalk.model.PlatformFilter

All Implemented Interfaces:

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

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

Describes criteria to restrict the results when listing platform versions.

The filter is evaluated as follows: Type Operator Values[1]

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PlatformFilter.Builder

Method Summary

Modifier and Type	Method	Description
static PlatformFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
String	operator()	The operator to apply to the Type with each of the Values.
List<SdkField<?>>	sdkFields()
static Class<? extends PlatformFilter.Builder>	serializableBuilderClass()
PlatformFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	type()	The platform version attribute to which the filter values are applied.
List<String>	values()	The list of values applied to the filtering platform version attribute.

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

type

public final String type()

The platform version attribute to which the filter values are applied.

Valid values: PlatformName | PlatformVersion | PlatformStatus | PlatformBranchName | PlatformLifecycleState | PlatformOwner | SupportedTier | SupportedAddon | ProgrammingLanguageName | OperatingSystemName

Returns:

The platform version attribute to which the filter values are applied.

Valid values: PlatformName | PlatformVersion | PlatformStatus | PlatformBranchName | PlatformLifecycleState | PlatformOwner | SupportedTier | SupportedAddon | ProgrammingLanguageName | OperatingSystemName

operator

public final String operator()

The operator to apply to the Type with each of the Values.

Valid values: = | != | < | <= | > | >= | contains | begins_with | ends_with

Returns:

The operator to apply to the Type with each of the Values.

Valid values: = | != | < | <= | > | >= | contains | begins_with | ends_with

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 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.

values

public final List<String> values()

The list of values applied to the filtering platform version attribute. Only one value is supported for all current operators.

The following list shows valid filter values for some filter attributes.

• PlatformStatus: Creating | Failed | Ready | Deleting | Deleted

• PlatformLifecycleState: recommended

• SupportedTier: WebServer/Standard | Worker/SQS/HTTP

• SupportedAddon: Log/S3 | Monitoring/Healthd | WorkerDaemon/SQSD

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 list of values applied to the filtering platform version attribute. Only one value is supported for all current operators.

The following list shows valid filter values for some filter attributes.

• PlatformStatus: Creating | Failed | Ready | Deleting | Deleted

• PlatformLifecycleState: recommended

• SupportedTier: WebServer/Standard | Worker/SQS/HTTP

• SupportedAddon: Log/S3 | Monitoring/Healthd | WorkerDaemon/SQSD

toBuilder

public PlatformFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PlatformFilter.Builder,PlatformFilter>

builder

public static PlatformFilter.Builder builder()

serializableBuilderClass

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