Class Filter
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Filter.Builder,
Filter>
A filter object, used to optionally filter results from calls to the ListEntities
and
ListChangeSets
actions.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Filter.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 ValueList property.final String
name()
ForListEntities
, the supported value for this is anEntityId
.static Class
<? extends Filter.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.ListEntities
- This is a list of uniqueEntityId
s.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
For
ListEntities
, the supported value for this is anEntityId
.For
ListChangeSets
, the supported values are as follows:- Returns:
- For
ListEntities
, the supported value for this is anEntityId
.For
ListChangeSets
, the supported values are as follows:
-
hasValueList
public final boolean hasValueList()For responses, this returns true if the service returned a value for the ValueList 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. -
valueList
ListEntities
- This is a list of uniqueEntityId
s.ListChangeSets
- The supported filter names and associatedValueList
s is as follows:-
ChangeSetName
- The supportedValueList
is a list of non-uniqueChangeSetName
s. These are defined when you call theStartChangeSet
action. -
Status
- The supportedValueList
is a list of statuses for all change set requests. -
EntityId
- The supportedValueList
is a list of uniqueEntityId
s. -
BeforeStartTime
- The supportedValueList
is a list of all change sets that started before the filter value. -
AfterStartTime
- The supportedValueList
is a list of all change sets that started after the filter value. -
BeforeEndTime
- The supportedValueList
is a list of all change sets that ended before the filter value. -
AfterEndTime
- The supportedValueList
is a list of all change sets that ended after the filter value.
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
hasValueList()
method.- Returns:
ListEntities
- This is a list of uniqueEntityId
s.ListChangeSets
- The supported filter names and associatedValueList
s is as follows:-
ChangeSetName
- The supportedValueList
is a list of non-uniqueChangeSetName
s. These are defined when you call theStartChangeSet
action. -
Status
- The supportedValueList
is a list of statuses for all change set requests. -
EntityId
- The supportedValueList
is a list of uniqueEntityId
s. -
BeforeStartTime
- The supportedValueList
is a list of all change sets that started before the filter value. -
AfterStartTime
- The supportedValueList
is a list of all change sets that started after the filter value. -
BeforeEndTime
- The supportedValueList
is a list of all change sets that ended before the filter value. -
AfterEndTime
- The supportedValueList
is a list of all change sets that ended after the filter value.
-
-
-
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<Filter.Builder,
Filter> - 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
-