java.lang.Object
software.amazon.awssdk.services.datapipeline.model.Operator
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Operator.Builder,Operator>

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

Contains a logical operation for comparing the value of a field with a specified value.

See Also:
  • Method Details

    • type

      public final OperatorType type()

      The logical operation to be performed: equal (EQ), equal reference (REF_EQ), less than or equal (LE), greater than or equal (GE), or between (BETWEEN). Equal reference (REF_EQ) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below.

      The comparison operators EQ and REF_EQ act on the following fields:

      • name
      • @sphere
      • parent
      • @componentParent
      • @instanceParent
      • @status
      • @scheduledStartTime
      • @scheduledEndTime
      • @actualStartTime
      • @actualEndTime

      The comparison operators GE, LE, and BETWEEN act on the following fields:

      • @scheduledStartTime
      • @scheduledEndTime
      • @actualStartTime
      • @actualEndTime

      Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string "my".

      If the service returns an enum value that is not available in the current SDK version, type will return OperatorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The logical operation to be performed: equal (EQ), equal reference (REF_EQ), less than or equal (LE), greater than or equal (GE), or between ( BETWEEN). Equal reference (REF_EQ) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below.

      The comparison operators EQ and REF_EQ act on the following fields:

      • name
      • @sphere
      • parent
      • @componentParent
      • @instanceParent
      • @status
      • @scheduledStartTime
      • @scheduledEndTime
      • @actualStartTime
      • @actualEndTime

      The comparison operators GE, LE, and BETWEEN act on the following fields:

      • @scheduledStartTime
      • @scheduledEndTime
      • @actualStartTime
      • @actualEndTime

      Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string "my".

      See Also:
    • typeAsString

      public final String typeAsString()

      The logical operation to be performed: equal (EQ), equal reference (REF_EQ), less than or equal (LE), greater than or equal (GE), or between (BETWEEN). Equal reference (REF_EQ) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below.

      The comparison operators EQ and REF_EQ act on the following fields:

      • name
      • @sphere
      • parent
      • @componentParent
      • @instanceParent
      • @status
      • @scheduledStartTime
      • @scheduledEndTime
      • @actualStartTime
      • @actualEndTime

      The comparison operators GE, LE, and BETWEEN act on the following fields:

      • @scheduledStartTime
      • @scheduledEndTime
      • @actualStartTime
      • @actualEndTime

      Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string "my".

      If the service returns an enum value that is not available in the current SDK version, type will return OperatorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The logical operation to be performed: equal (EQ), equal reference (REF_EQ), less than or equal (LE), greater than or equal (GE), or between ( BETWEEN). Equal reference (REF_EQ) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below.

      The comparison operators EQ and REF_EQ act on the following fields:

      • name
      • @sphere
      • parent
      • @componentParent
      • @instanceParent
      • @status
      • @scheduledStartTime
      • @scheduledEndTime
      • @actualStartTime
      • @actualEndTime

      The comparison operators GE, LE, and BETWEEN act on the following fields:

      • @scheduledStartTime
      • @scheduledEndTime
      • @actualStartTime
      • @actualEndTime

      Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string "my".

      See Also:
    • 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 value that the actual field value will be compared with.

      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 value that the actual field value will be compared with.
    • toBuilder

      public Operator.Builder 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 interface ToCopyableBuilder<Operator.Builder,Operator>
      Returns:
      a builder for type T
    • builder

      public static Operator.Builder builder()
    • serializableBuilderClass

      public static Class<? extends Operator.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.