Class PlatformFilter
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic PlatformFilter.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 String
operator()
The operator to apply to theType
with each of theValues
.static Class
<? extends PlatformFilter.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.final String
type()
The platform version attribute to which the filter values are applied.values()
The list of values applied to the filtering platform version attribute.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The operator to apply to the
Type
with each of theValues
.Valid values:
=
|!=
|<
|<=
|>
|>=
|contains
|begins_with
|ends_with
- Returns:
- The operator to apply to the
Type
with each of theValues
.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 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 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
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<PlatformFilter.Builder,
PlatformFilter> - 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
-