OBJECT

GuardrailsDesiredStateRun

GuardrailsDesiredStateRun - It is a point-in-time instance of guardrails desired state run.

link GraphQL Schema definition

  • type GuardrailsDesiredStateRun implements Node {
  • # GuardrailsAccountState on which GuardrailsDesiredStateRun was executed
  • accountState: [GuardrailsAccountState!]
  • # CSP user who created guardrail desired state run
  • createdBy: User!
  • # Timestamp at which guardrail desired state run is created. Expressed in UTC
  • # ISO-8601 format
  • createdOn: DateTime!
  • # CSP project associated with guardrail desired state run
  • cspProjectEntity: Entity
  • # Flag indicating whether the desired state run is archived
  • deleted: Boolean
  • # Guardrail DesiredState
  • desiredState: GuardrailsDesiredState!
  • # Guardrails EnforcedStates - result of this DesiredState run
  • #
  • # Arguments
  • # after: Return records after the given cursor, as per GraphQL
  • # Relay spec
  • # before: Return records before the given cursor, as per GraphQL
  • # Relay spec
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # sort: Results are sorted as per fields and order specified.
  • # Supported fields are createdBy, updatedBy, status, stateId, stateRef
  • enforcedStates(
  • after: String,
  • before: String,
  • first: Int,
  • sort: [QuerySort!]
  • ): GuardrailsEnforcedStateConnection
  • # Error message when running desired state if any
  • errorMessage: String
  • # Unique identifier for guardrail desired state run
  • id: ID!
  • # Required for backward compatibility, will be removed in future
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • idemTaskId: String
  • # indicates if this run is a test run
  • isTestRun: Boolean
  • # desired state mode as provided during run
  • mode: GuardrailsDesiredStateMode!
  • # Parameters used with this desired state run
  • parameters: JSON
  • # run response that resulted in this run
  • runResponse: GuardrailsDesiredStateRunResponse!
  • # DesiredState run status
  • status: GuardrailsDesiredStateRunStatus
  • # Summary of this run
  • summary: GuardrailsDesiredStateRunSummary
  • # Guardrails template instance with which the desired state was run
  • template: GuardrailsTemplate
  • # CSP user who updated guardrail desired state run
  • updatedBy: User
  • # Timestamp at which guardrail desired state run is updated. Expressed in UTC
  • # ISO-8601 format
  • updatedOn: DateTime
  • # worker group used for the guardrail desired state run
  • #
  • # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
  • # and schema elements may change over future iterations.
  • workerGroup: GuardrailsWorkerGroup
  • }