Class OperationFilter
- java.lang.Object
-
- software.amazon.awssdk.services.servicediscovery.model.OperationFilter
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<OperationFilter.Builder,OperationFilter>
@Generated("software.amazon.awssdk:codegen") public final class OperationFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OperationFilter.Builder,OperationFilter>
A complex type that lets you select the operations that you want to list.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceOperationFilter.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static OperationFilter.Builderbuilder()FilterConditioncondition()The operator that you want to use to determine whether an operation matches the specified value.StringconditionAsString()The operator that you want to use to determine whether an operation matches the specified value.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasValues()For responses, this returns true if the service returned a value for the Values property.OperationFilterNamename()Specify the operations that you want to get:StringnameAsString()Specify the operations that you want to get:Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends OperationFilter.Builder>serializableBuilderClass()OperationFilter.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<String>values()Specify values that are applicable to the value that you specify forName:-
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 OperationFilterName name()
Specify the operations that you want to get:
-
NAMESPACE_ID: Gets operations related to specified namespaces.
-
SERVICE_ID: Gets operations related to specified services.
-
STATUS: Gets operations based on the status of the operations:
SUBMITTED,PENDING,SUCCEED, orFAIL. -
TYPE: Gets specified types of operation.
-
UPDATE_DATE: Gets operations that changed status during a specified date/time range.
If the service returns an enum value that is not available in the current SDK version,
namewill returnOperationFilterName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromnameAsString().- Returns:
- Specify the operations that you want to get:
-
NAMESPACE_ID: Gets operations related to specified namespaces.
-
SERVICE_ID: Gets operations related to specified services.
-
STATUS: Gets operations based on the status of the operations:
SUBMITTED,PENDING,SUCCEED, orFAIL. -
TYPE: Gets specified types of operation.
-
UPDATE_DATE: Gets operations that changed status during a specified date/time range.
-
- See Also:
OperationFilterName
-
-
nameAsString
public final String nameAsString()
Specify the operations that you want to get:
-
NAMESPACE_ID: Gets operations related to specified namespaces.
-
SERVICE_ID: Gets operations related to specified services.
-
STATUS: Gets operations based on the status of the operations:
SUBMITTED,PENDING,SUCCEED, orFAIL. -
TYPE: Gets specified types of operation.
-
UPDATE_DATE: Gets operations that changed status during a specified date/time range.
If the service returns an enum value that is not available in the current SDK version,
namewill returnOperationFilterName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromnameAsString().- Returns:
- Specify the operations that you want to get:
-
NAMESPACE_ID: Gets operations related to specified namespaces.
-
SERVICE_ID: Gets operations related to specified services.
-
STATUS: Gets operations based on the status of the operations:
SUBMITTED,PENDING,SUCCEED, orFAIL. -
TYPE: Gets specified types of operation.
-
UPDATE_DATE: Gets operations that changed status during a specified date/time range.
-
- See Also:
OperationFilterName
-
-
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
public final List<String> values()
Specify values that are applicable to the value that you specify for
Name:-
NAMESPACE_ID: Specify one namespace ID.
-
SERVICE_ID: Specify one service ID.
-
STATUS: Specify one or more statuses:
SUBMITTED,PENDING,SUCCEED, orFAIL. -
TYPE: Specify one or more of the following types:
CREATE_NAMESPACE,DELETE_NAMESPACE,UPDATE_SERVICE,REGISTER_INSTANCE, orDEREGISTER_INSTANCE. -
UPDATE_DATE: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first 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
hasValues()method.- Returns:
- Specify values that are applicable to the value that you specify for
Name:-
NAMESPACE_ID: Specify one namespace ID.
-
SERVICE_ID: Specify one service ID.
-
STATUS: Specify one or more statuses:
SUBMITTED,PENDING,SUCCEED, orFAIL. -
TYPE: Specify one or more of the following types:
CREATE_NAMESPACE,DELETE_NAMESPACE,UPDATE_SERVICE,REGISTER_INSTANCE, orDEREGISTER_INSTANCE. -
UPDATE_DATE: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.
-
-
-
condition
public final FilterCondition condition()
The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include:
-
EQ: When you specifyEQfor the condition, you can specify only one value.EQis supported forNAMESPACE_ID,SERVICE_ID,STATUS, andTYPE.EQis the default condition and can be omitted. -
IN: When you specifyINfor the condition, you can specify a list of one or more values.INis supported forSTATUSandTYPE. An operation must match one of the specified values to be returned in the response. -
BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.BETWEENis supported forUPDATE_DATE.
If the service returns an enum value that is not available in the current SDK version,
conditionwill returnFilterCondition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconditionAsString().- Returns:
- The operator that you want to use to determine whether an operation matches the specified value. Valid
values for condition include:
-
EQ: When you specifyEQfor the condition, you can specify only one value.EQis supported forNAMESPACE_ID,SERVICE_ID,STATUS, andTYPE.EQis the default condition and can be omitted. -
IN: When you specifyINfor the condition, you can specify a list of one or more values.INis supported forSTATUSandTYPE. An operation must match one of the specified values to be returned in the response. -
BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.BETWEENis supported forUPDATE_DATE.
-
- See Also:
FilterCondition
-
-
conditionAsString
public final String conditionAsString()
The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include:
-
EQ: When you specifyEQfor the condition, you can specify only one value.EQis supported forNAMESPACE_ID,SERVICE_ID,STATUS, andTYPE.EQis the default condition and can be omitted. -
IN: When you specifyINfor the condition, you can specify a list of one or more values.INis supported forSTATUSandTYPE. An operation must match one of the specified values to be returned in the response. -
BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.BETWEENis supported forUPDATE_DATE.
If the service returns an enum value that is not available in the current SDK version,
conditionwill returnFilterCondition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconditionAsString().- Returns:
- The operator that you want to use to determine whether an operation matches the specified value. Valid
values for condition include:
-
EQ: When you specifyEQfor the condition, you can specify only one value.EQis supported forNAMESPACE_ID,SERVICE_ID,STATUS, andTYPE.EQis the default condition and can be omitted. -
IN: When you specifyINfor the condition, you can specify a list of one or more values.INis supported forSTATUSandTYPE. An operation must match one of the specified values to be returned in the response. -
BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.BETWEENis supported forUPDATE_DATE.
-
- See Also:
FilterCondition
-
-
toBuilder
public OperationFilter.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<OperationFilter.Builder,OperationFilter>
-
builder
public static OperationFilter.Builder builder()
-
serializableBuilderClass
public static Class<? extends OperationFilter.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-