libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DataPipeline.Types.Operator

Description

 
Synopsis

Documentation

data Operator Source #

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

See: newOperator smart constructor.

Constructors

Operator' 

Fields

  • values :: Maybe [Text]

    The value that the actual field value will be compared with.

  • type' :: Maybe OperatorType

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

Instances

Instances details
Eq Operator Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.Operator

Read Operator Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.Operator

Show Operator Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.Operator

Generic Operator Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.Operator

Associated Types

type Rep Operator :: Type -> Type #

Methods

from :: Operator -> Rep Operator x #

to :: Rep Operator x -> Operator #

NFData Operator Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.Operator

Methods

rnf :: Operator -> () #

Hashable Operator Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.Operator

Methods

hashWithSalt :: Int -> Operator -> Int #

hash :: Operator -> Int #

ToJSON Operator Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.Operator

type Rep Operator Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.Operator

type Rep Operator = D1 ('MetaData "Operator" "Amazonka.DataPipeline.Types.Operator" "libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline" 'False) (C1 ('MetaCons "Operator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OperatorType))))

newOperator :: Operator Source #

Create a value of Operator with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:values:Operator', operator_values - The value that the actual field value will be compared with.

$sel:type':Operator', operator_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".

operator_values :: Lens' Operator (Maybe [Text]) Source #

The value that the actual field value will be compared with.

operator_type :: Lens' Operator (Maybe OperatorType) Source #

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