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

Class: Aws::DataPipeline::Types::QueryObjectsInput

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 QueryObjectsInput data as a hash:

{
  pipeline_id: "id", # required
  query: {
    selectors: [
      {
        field_name: "string",
        operator: {
          type: "EQ", # accepts EQ, REF_EQ, LE, GE, BETWEEN
          values: ["string"],
        },
      },
    ],
  },
  sphere: "string", # required
  marker: "string",
  limit: 1,
}

Contains the parameters for QueryObjects.

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

Returns:

  • (Integer)


1036
1037
1038
1039
1040
1041
1042
1043
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1036

class QueryObjectsInput < Struct.new(
  :pipeline_id,
  :query,
  :sphere,
  :marker,
  :limit)
  include Aws::Structure
end

#markerString

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

Returns:

  • (String)


1036
1037
1038
1039
1040
1041
1042
1043
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1036

class QueryObjectsInput < Struct.new(
  :pipeline_id,
  :query,
  :sphere,
  :marker,
  :limit)
  include Aws::Structure
end

#pipeline_idString

The ID of the pipeline.

Returns:

  • (String)


1036
1037
1038
1039
1040
1041
1042
1043
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1036

class QueryObjectsInput < Struct.new(
  :pipeline_id,
  :query,
  :sphere,
  :marker,
  :limit)
  include Aws::Structure
end

#queryTypes::Query

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

Returns:



1036
1037
1038
1039
1040
1041
1042
1043
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1036

class QueryObjectsInput < Struct.new(
  :pipeline_id,
  :query,
  :sphere,
  :marker,
  :limit)
  include Aws::Structure
end

#sphereString

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Returns:

  • (String)


1036
1037
1038
1039
1040
1041
1042
1043
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1036

class QueryObjectsInput < Struct.new(
  :pipeline_id,
  :query,
  :sphere,
  :marker,
  :limit)
  include Aws::Structure
end