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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing QueryObjectsInput as input to an Aws::Client method, you can use a vanilla 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.

See Also:

Instance Attribute Summary collapse

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) —

    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. 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) —

    The starting point for the results to be returned.

#pipeline_id ⇒ String

The ID of the pipeline.

Returns:

  • (String) —

    The ID of the pipeline.

#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) —

    The query that defines the objects to be returned.

#sphere ⇒ String

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

Returns:

  • (String) —

    Indicates whether the query applies to components or instances.