Describe Objects

datapipeline_describe_objects

R Documentation

Gets the object definitions for a set of objects associated with the pipeline¶

Description¶

Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.

Usage¶

datapipeline_describe_objects(pipelineId, objectIds,
  evaluateExpressions, marker)

Arguments¶

pipelineId

[required] The ID of the pipeline that contains the object definitions.

objectIds

[required] The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to describe_objects.

evaluateExpressions

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

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 describe_objects with the marker value from the previous call to retrieve the next set of results.

Value¶

A list with the following syntax:

list(
  pipelineObjects = list(
    list(
      id = "string",
      name = "string",
      fields = list(
        list(
          key = "string",
          stringValue = "string",
          refValue = "string"
        )
      )
    )
  ),
  marker = "string",
  hasMoreResults = TRUE|FALSE
)

Request syntax¶

svc$describe_objects(
  pipelineId = "string",
  objectIds = list(
    "string"
  ),
  evaluateExpressions = TRUE|FALSE,
  marker = "string"
)