Rollout

Represents a Rollout.

displayName

string

required

Human-friendly name of this instance.

state

string

required

Current state of the workflow instance.

createTime

object

required

Time when the workflow instance was created.

updateTime

object

required

Time when the workflow instance was last updated.

creator

string

required

Reference to the identity that created this workflow instance.

updater

string

required

Reference to the identity that last updated this workflow instance.

name

string

Unique id of the instance for example workflows/abtest/instances/vxpoqirnwawxzasv4tuu.

owner

string

The owner of the resource. If not set will default to the creator.

jobQueue

object

Show child attributes

pendingTransition

object

if present, denotes information about an ongoing attempt to transition to another state

Show child attributes

checks

object[]

A check is a named boolean value that can be used to report possible errors when a workflow instance is in a certain state.

Show child attributes

stateHistory

object[]

A historical record of previous states that the workflow instance was in.

Show child attributes

possibleTransitions

string[]

The transitions that this workflow instance can do from its current state.

lockedDataKeys

string[]

Module data keys that are currently locked.

workflowVersion

string

Version of the workflow that this instance is running.

surfaces

string[]

A set of surfaces that this workflow instance belongs to.

transitionStatus

object

The status of the latest transition for the instance.

Show child attributes

deleteTime

object

Time when the workflow instance was deleted.

labels

object[]

Generic labels for the workflow instance.

Show child attributes

explore

Rollout.ExploreData · object

Rollout.ExploreData: Module data for explore

Show child attributes

exposure

Rollout.ExposureData · object

Rollout.ExposureData: Module data for exposure

Show child attributes

flags

Rollout.FlagsData · object

Rollout.FlagsData: Module data for flags

Show child attributes

metrics

Rollout.MetricsData · object

Rollout.MetricsData: Module data for metrics

Show child attributes

planning

Rollout.PlanningData · object

Rollout.PlanningData: Module data for planning

Show child attributes

reviews

Rollout.ReviewsData · object

Rollout.ReviewsData: Module data for reviews

Show child attributes

rollout

Rollout.RolloutData · object

Rollout.RolloutData: Module data for rollout

Show child attributes

samplesize

Rollout.SampleSizeData · object

Rollout.SampleSizeData: Module data for samplesize

Show child attributes

stats

Rollout.StatsData · object

Rollout.StatsData: Module data for stats

Show child attributes

⌘I

{
  "displayName": "<string>",
  "state": "<string>",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "owner": "<string>",
  "checks": [
    {
      "message": "<string>",
      "persist": true,
      "createTime": {},
      "updateTime": {},
      "creator": "<string>",
      "updater": "<string>",
      "name": "<string>",
      "displayName": "<string>",
      "parent": "<string>",
      "data": {
        "nullValue": "NULL_VALUE",
        "numberValue": 123,
        "stringValue": "<string>",
        "boolValue": true,
        "structValue": {},
        "listValue": {
          "values": [
            {}
          ]
        }
      },
      "labels": [
        {}
      ]
    }
  ],
  "stateHistory": [
    {
      "state": "<string>",
      "enteredTime": {},
      "exitedTime": {},
      "actualEnteredTime": {},
      "actualExitedTime": {},
      "checks": [
        {
          "message": "<string>",
          "persist": true,
          "createTime": {},
          "updateTime": {},
          "creator": "<string>",
          "updater": "<string>",
          "name": "<string>",
          "displayName": "<string>",
          "parent": "<string>",
          "data": {
            "nullValue": "NULL_VALUE",
            "numberValue": 123,
            "stringValue": "<string>",
            "boolValue": true,
            "structValue": {},
            "listValue": {
              "values": [
                {}
              ]
            }
          },
          "labels": [
            {}
          ]
        }
      ]
    }
  ],
  "possibleTransitions": [
    "<string>"
  ],
  "lockedDataKeys": [
    "<string>"
  ],
  "workflowVersion": "<string>",
  "surfaces": [
    "<string>"
  ],
  "deleteTime": {},
  "labels": [
    {}
  ],
  "flags": {
    "audiences": [
      {
        "id": "<string>",
        "displayName": "<string>",
        "intakePaused": true,
        "launchTime": "<string>",
        "materialization": "<string>",
        "rule": "<string>",
        "segment": "<string>",
        "stopTime": "<string>"
      }
    ],
    "flag": "<string>",
    "ignoreTargetingForSticky": true,
    "intakePaused": true,
    "materialization": "<string>",
    "rule": "<string>",
    "segment": "<string>",
    "stickyAssignments": true,
    "targetingKeySelector": "<string>"
  },
  "planning": {
    "actual": {
      "endTime": "<string>",
      "runtime": "<string>",
      "startTime": "<string>"
    },
    "planned": {
      "endTime": "<string>",
      "runtime": "<string>",
      "startTime": "<string>"
    }
  },
  "reviews": {
    "approvalRequired": true,
    "optionalReviews": [
      {
        "responses": [
          {
            "reviewer": "<string>",
            "commentId": "<string>",
            "groups": [
              "<string>"
            ],
            "id": "<string>",
            "stale": true
          }
        ],
        "surface": "<string>"
      }
    ],
    "requiredReviews": [
      {
        "responses": [
          {
            "reviewer": "<string>",
            "commentId": "<string>",
            "groups": [
              "<string>"
            ],
            "id": "<string>",
            "stale": true
          }
        ],
        "surface": "<string>"
      }
    ],
    "reviewId": "<string>"
  },
  "samplesize": {
    "error": "<string>",
    "exposure": {
      "assignmentTable": {
        "assignmentTable": "<string>",
        "customEndTime": "<string>",
        "customStartTime": "<string>",
        "filters": {
          "exposureFilter": "<string>"
        },
        "runtime": "<string>",
        "samplingFactor": 123
      },
      "endTime": "<string>",
      "startTime": "<string>"
    },
    "exposureSource": {
      "assignmentTable": "<string>",
      "customEndTime": "<string>",
      "customStartTime": "<string>",
      "exposureTableSchedule": "<string>",
      "filters": {
        "exposureFilter": "<string>"
      },
      "runtime": "<string>",
      "samplingFactor": 123,
      "workflowInstance": "<string>"
    },
    "hasCustomizedExposureSource": true,
    "metrics": [
      {
        "metric": "<string>",
        "error": "<string>",
        "forecastedData": [
          {
            "dayIndex": 123,
            "expectedSampleSize": 123,
            "requiredSampleSize": 123
          }
        ],
        "observedData": [
          {
            "dayIndex": 123,
            "expectedSampleSize": 123,
            "mean": 123,
            "requiredSampleSize": 123,
            "variance": 123
          }
        ],
        "requiredSampleSize": 123,
        "summaryStats": {
          "count": 123,
          "mean": 123,
          "variance": 123,
          "varianceReductionRate": 123
        }
      }
    ],
    "requiredSampleSize": 123,
    "useScheduledCalculation": true
  },
  "stats": {
    "alpha": 123,
    "analysisResult": "<string>",
    "analysisResults": [
      {
        "analysisResult": "<string>",
        "exposureFilterName": "<string>"
      }
    ],
    "fallbackSampleSize": "<string>",
    "metricInformation": [
      {
        "metricName": "<string>",
        "expectedSampleSize": "<string>"
      }
    ],
    "metricMethods": [
      {
        "metricName": "<string>"
      }
    ],
    "power": 123
  }
}

Get Started

Feature Flags

Metrics

Stats

Experiments

Surfaces

IAM

Connectors