Query Objects

datapipeline_query_objects

R Documentation

Queries the specified pipeline for the names of objects that match the specified set of conditions¶

Description¶

Queries the specified pipeline for the names of objects that match the specified set of conditions.

Usage¶

datapipeline_query_objects(pipelineId, query, sphere, marker, limit)

Arguments¶

pipelineId: [required] The ID of the pipeline.
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.
sphere: [required] Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.
marker: 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 query_objects with the marker value from the previous call to retrieve the next set of results.
limit: The maximum number of object names that query_objects will return in a single call. The default value is 100.

Value¶

A list with the following syntax:

list(
  ids = list(
    "string"
  ),
  marker = "string",
  hasMoreResults = TRUE|FALSE
)

Request syntax¶

svc$query_objects(
  pipelineId = "string",
  query = list(
    selectors = list(
      list(
        fieldName = "string",
        operator = list(
          type = "EQ"|"REF_EQ"|"LE"|"GE"|"BETWEEN",
          values = list(
            "string"
          )
        )
      )
    )
  ),
  sphere = "string",
  marker = "string",
  limit = 123
)