{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-firebase/json-schema/google-firebase-rollout-schema.json",
  "title": "Rollout",
  "description": "A single rollout of a build for a backend.",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-firebase-firebaseapphosting-projects-api-openapi.yml#/components/schemas/Rollout",
  "type": "object",
  "properties": {
    "reconciling": {
      "readOnly": true,
      "type": "boolean",
      "description": "Output only. A field that, if true, indicates that the Rollout currently has an LRO."
    },
    "build": {
      "type": "string",
      "description": "Required. Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic."
    },
    "name": {
      "description": "Identifier. The resource name of the rollout. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/rollouts/{rolloutId}`.",
      "type": "string"
    },
    "uid": {
      "readOnly": true,
      "description": "Output only. System-assigned, unique identifier.",
      "type": "string"
    },
    "updateTime": {
      "description": "Output only. Time at which the rollout was last updated.",
      "format": "google-datetime",
      "readOnly": true,
      "type": "string"
    },
    "displayName": {
      "description": "Optional. Human-readable name. 63 character limit.",
      "type": "string"
    },
    "createTime": {
      "readOnly": true,
      "format": "google-datetime",
      "description": "Output only. Time at which the rollout was created.",
      "type": "string"
    },
    "etag": {
      "type": "string",
      "readOnly": true,
      "description": "Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource."
    },
    "state": {
      "readOnly": true,
      "type": "string",
      "description": "Output only. The state of the rollout.",
      "enum": [
        "STATE_UNSPECIFIED",
        "QUEUED",
        "PENDING_BUILD",
        "PROGRESSING",
        "PAUSED",
        "SUCCEEDED",
        "FAILED",
        "CANCELLED",
        "SKIPPED"
      ]
    },
    "deleteTime": {
      "type": "string",
      "description": "Output only. Time at which the rollout was deleted.",
      "readOnly": true,
      "format": "google-datetime"
    },
    "annotations": {
      "type": "object",
      "description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "labels": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Optional. Unstructured key value map that can be used to organize and categorize objects."
    },
    "error": {
      "$ref": "#/$defs/Status",
      "description": "Output only. A status and (human readable) error message for the rollout, if in a `FAILED` state."
    }
  },
  "$defs": {
    "Status": {
      "properties": {
        "message": {
          "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
          "type": "string"
        },
        "code": {
          "type": "integer",
          "description": "The status code, which should be an enum value of google.rpc.Code.",
          "format": "int32"
        },
        "details": {
          "type": "array",
          "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
          "items": {
            "additionalProperties": {
              "description": "Properties of the object. Contains field @type with type URL."
            },
            "type": "object"
          }
        }
      },
      "type": "object",
      "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)."
    }
  }
}