Get v1projects rollouts 1

{
  "plan": "<string>",
  "name": "<string>",
  "title": "<string>",
  "stages": [
    {
      "name": "<string>",
      "id": "<string>",
      "environment": "<string>",
      "tasks": [
        {
          "name": "<string>",
          "specId": "<string>",
          "status": "STATUS_UNSPECIFIED",
          "skippedReason": "<string>",
          "type": "TYPE_UNSPECIFIED",
          "target": "<string>",
          "databaseCreate": {
            "project": "<string>",
            "database": "<string>",
            "table": "<string>",
            "sheet": "<string>",
            "characterSet": "<string>",
            "collation": "<string>",
            "environment": "<string>"
          },
          "databaseUpdate": {
            "sheet": "<string>",
            "schemaVersion": "<string>",
            "databaseChangeType": "DATABASE_CHANGE_TYPE_UNSPECIFIED"
          },
          "databaseDataExport": {
            "target": "<string>",
            "sheet": "<string>",
            "format": "FORMAT_UNSPECIFIED",
            "password": "<string>"
          },
          "updateTime": "2023-11-07T05:31:56Z",
          "runTime": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "creator": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z",
  "issue": "<string>"
}

GET

projects

{project}

rollouts

{rollout}

{
  "plan": "<string>",
  "name": "<string>",
  "title": "<string>",
  "stages": [
    {
      "name": "<string>",
      "id": "<string>",
      "environment": "<string>",
      "tasks": [
        {
          "name": "<string>",
          "specId": "<string>",
          "status": "STATUS_UNSPECIFIED",
          "skippedReason": "<string>",
          "type": "TYPE_UNSPECIFIED",
          "target": "<string>",
          "databaseCreate": {
            "project": "<string>",
            "database": "<string>",
            "table": "<string>",
            "sheet": "<string>",
            "characterSet": "<string>",
            "collation": "<string>",
            "environment": "<string>"
          },
          "databaseUpdate": {
            "sheet": "<string>",
            "schemaVersion": "<string>",
            "databaseChangeType": "DATABASE_CHANGE_TYPE_UNSPECIFIED"
          },
          "databaseDataExport": {
            "target": "<string>",
            "sheet": "<string>",
            "format": "FORMAT_UNSPECIFIED",
            "password": "<string>"
          },
          "updateTime": "2023-11-07T05:31:56Z",
          "runTime": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "creator": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z",
  "issue": "<string>"
}

Path Parameters

project

string

required

The project id.

rollout

string

required

The rollout id.

Response

plan

string

required

The plan that this rollout is based on. Format: projects/{project}/plans/{plan}

name

string

The resource name of the rollout. Format: projects/{project}/rollouts/{rollout}

title

string

The title of the rollout, inherited from the associated plan. This field is output only and cannot be directly set.

stages

object[]

Stages and thus tasks of the rollout.

Show child attributes

stages.name

string

Format: projects/{project}/rollouts/{rollout}/stages/{stage} Use "-" for {stage} when the stage has no environment or deleted environment.

stages.id

string

id is the environment id of the stage. e.g., "prod". Use "-" when the stage has no environment or deleted environment.

stages.environment

string

environment is the environment of the stage. Format: environments/{environment} for valid environments, or "environments/-" for stages without environment or with deleted environments.

stages.tasks

object[]

The tasks within this stage.

Show child attributes

stages.tasks.name

string

Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}

stages.tasks.specId

string

A UUID4 string that uniquely identifies the Spec. Could be empty if the rollout of the task does not have an associating plan.

stages.tasks.status

enum<string>

Status is the status of the task.

Available options:

STATUS_UNSPECIFIED,

NOT_STARTED,

PENDING,

RUNNING,

DONE,

FAILED,

CANCELED,

SKIPPED

stages.tasks.skippedReason

string

The reason why the task was skipped.

stages.tasks.type

enum<string>

Available options:

TYPE_UNSPECIFIED,

GENERAL,

DATABASE_CREATE,

DATABASE_MIGRATE,

DATABASE_SDL,

DATABASE_EXPORT

stages.tasks.target

string

Format: instances/{instance} if the task is DatabaseCreate. Format: instances/{instance}/databases/{database}

stages.tasks.databaseCreate

object

Payload for creating a new database.

Show child attributes

stages.tasks.databaseCreate.project

string

The project owning the database. Format: projects/{project}

stages.tasks.databaseCreate.database

string

Database name.

stages.tasks.databaseCreate.table

string

Table name.

stages.tasks.databaseCreate.sheet

string

Format: projects/{project}/sheets/{sheet}

stages.tasks.databaseCreate.characterSet

string

The character set for the database.

stages.tasks.databaseCreate.collation

string

The collation for the database.

stages.tasks.databaseCreate.environment

string

The environment the database belongs to.

stages.tasks.databaseUpdate

object

Payload for updating a database schema.

Show child attributes

stages.tasks.databaseUpdate.sheet

string

Format: projects/{project}/sheets/{sheet}

stages.tasks.databaseUpdate.schemaVersion

string

The target schema version after this update.

stages.tasks.databaseUpdate.databaseChangeType

enum<string>

The type of database change (MIGRATE or SDL).

Available options:

DATABASE_CHANGE_TYPE_UNSPECIFIED,

MIGRATE,

SDL

stages.tasks.databaseDataExport

object

Payload for exporting database data.

Show child attributes

stages.tasks.databaseDataExport.target

string

The resource name of the target. Format: instances/{instance-id}/databases/{database-name}

stages.tasks.databaseDataExport.sheet

string

The resource name of the sheet. Format: projects/{project}/sheets/{sheet}

stages.tasks.databaseDataExport.format

enum<string>

The format of the exported file.

Available options:

FORMAT_UNSPECIFIED,

CSV,

JSON,

SQL,

XLSX

stages.tasks.databaseDataExport.password

string

The zip password provided by users. Leave it empty if no needs to encrypt the zip file.

stages.tasks.updateTime

string<date-time>

The update_time is the update time of latest task run. If there are no task runs, it will be empty.

stages.tasks.runTime

string<date-time>

The run_time is the scheduled run time of latest task run. If there are no task runs or the task run is not scheduled, it will be empty.

creator

string

Format: users/[email protected]

createTime

string<date-time>

updateTime

string<date-time>

issue

string

The issue associated with the rollout. Could be empty. Format: projects/{project}/issues/{issue}

Post v1projects rollouts Get v1projects rollouts stages tasks taskruns

ProjectService

ActuatorService

AuditLogService

AuthService

CelService

OrgPolicyService

GroupService

IdentityProviderService

InstanceService

DatabaseService

DatabaseCatalogService

RevisionService

SQLService

InstanceRoleService

DatabaseGroupService

IssueService

PlanService

ReleaseService

RolloutService

SheetService

ReviewConfigService

RoleService

SettingService

SubscriptionService

UserService

WorksheetService

WorkspaceService

Get v1projects rollouts 1

Path Parameters

Response