You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::DataPipeline::Types::Operator

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb

Overview

Note:

When making an API call, you may pass Operator data as a hash:

{
  type: "EQ", # accepts EQ, REF_EQ, LE, GE, BETWEEN
  values: ["string"],
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#typeString

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

Returns:

  • (String)


604
605
606
607
608
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 604

class Operator < Struct.new(
  :type,
  :values)
  include Aws::Structure
end

#valuesArray<String>

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

Returns:

  • (Array<String>)


604
605
606
607
608
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 604

class Operator < Struct.new(
  :type,
  :values)
  include Aws::Structure
end