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

Inherits:

Struct

• Object
• Struct
• Aws::DataPipeline::Types::QueryObjectsInput

Includes:

Structure

Defined in:

lib/aws-sdk-datapipeline/types.rb

Overview

Contains the parameters for QueryObjects.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #limit ⇒ Integer

  The maximum number of object names that ‘QueryObjects` will return in a single call.

• #marker ⇒ String

  The starting point for the results to be returned.

• #pipeline_id ⇒ String

  The ID of the pipeline.

• #query ⇒ Types::Query

  The query that defines the objects to be returned.

• #sphere ⇒ String

  Indicates whether the query applies to components or instances.

Instance Attribute Details

#limit ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-datapipeline/types.rb', line 876

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

#marker ⇒ String

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)

# File 'lib/aws-sdk-datapipeline/types.rb', line 876

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

#pipeline_id ⇒ String

The ID of the pipeline.

Returns:

• (String)

# File 'lib/aws-sdk-datapipeline/types.rb', line 876

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

#query ⇒ Types::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:

• (Types::Query)

# File 'lib/aws-sdk-datapipeline/types.rb', line 876

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

#sphere ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-datapipeline/types.rb', line 876

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