GET
/
v1
/
projects
/
{project}
/
plans
/
{plan}
/
planCheckRuns
{
  "planCheckRuns": [
    {
      "name": "<string>",
      "type": "TYPE_UNSPECIFIED",
      "status": "STATUS_UNSPECIFIED",
      "target": "<string>",
      "sheet": "<string>",
      "results": [
        {
          "status": "STATUS_UNSPECIFIED",
          "title": "<string>",
          "content": "<string>",
          "code": 123,
          "sqlSummaryReport": {
            "statementTypes": [
              "<string>"
            ],
            "affectedRows": 123,
            "changedResources": {
              "databases": [
                {
                  "name": "<string>",
                  "schemas": [
                    {
                      "name": "<string>",
                      "tables": [
                        {
                          "name": "<string>",
                          "tableRows": "<string>",
                          "ranges": [
                            {
                              "start": 123,
                              "end": 123
                            }
                          ]
                        }
                      ],
                      "views": [
                        {
                          "name": "<string>",
                          "ranges": [
                            {
                              "start": 123,
                              "end": 123
                            }
                          ]
                        }
                      ],
                      "functions": [
                        {
                          "name": "<string>",
                          "ranges": [
                            {
                              "start": 123,
                              "end": 123
                            }
                          ]
                        }
                      ],
                      "procedures": [
                        {
                          "name": "<string>",
                          "ranges": [
                            {
                              "start": 123,
                              "end": 123
                            }
                          ]
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          },
          "sqlReviewReport": {
            "line": 123,
            "column": 123,
            "startPosition": {
              "line": 123,
              "column": 123
            },
            "endPosition": {
              "line": 123,
              "column": 123
            }
          }
        }
      ],
      "error": "<string>",
      "createTime": "2023-11-07T05:31:56Z"
    }
  ],
  "nextPageToken": "<string>"
}

Path Parameters

​
project
string
required

The project id.

​
plan
string
required

The plan id.

Query Parameters

​
pageSize
integer

Not used. The maximum number of plan check runs to return. The service may return fewer than this value. If unspecified, at most 10 plan check runs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

Not used. A page token, received from a previous ListPlanCheckRuns call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListPlanCheckRuns must match the call that provided the page token.

​
latestOnly
boolean

If set to true, only the latest plan check run will be returned.

​
filter
string

Filter is used to filter plan check runs returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec

Supported filters:

  • status: the plan check run status, support "==" and "in" operator, check the Status enum in the PlanCheckRun message for the values.
  • result_status: the plan check run result status, support "==" and "in" operator, check the Result.Status enum in the PlanCheckRun message for the values.

For example: status in ["DONE", "FAILED"] status == "RUNNING" result_status in ["SUCCESS", "ERROR"] result_status == "WARNING"

Response

200
application/json

OK

The response is of type object.

GET
/
v1
/
projects
/
{project}
/
plans
/
{plan}
/
planCheckRuns
{
  "planCheckRuns": [
    {
      "name": "<string>",
      "type": "TYPE_UNSPECIFIED",
      "status": "STATUS_UNSPECIFIED",
      "target": "<string>",
      "sheet": "<string>",
      "results": [
        {
          "status": "STATUS_UNSPECIFIED",
          "title": "<string>",
          "content": "<string>",
          "code": 123,
          "sqlSummaryReport": {
            "statementTypes": [
              "<string>"
            ],
            "affectedRows": 123,
            "changedResources": {
              "databases": [
                {
                  "name": "<string>",
                  "schemas": [
                    {
                      "name": "<string>",
                      "tables": [
                        {
                          "name": "<string>",
                          "tableRows": "<string>",
                          "ranges": [
                            {
                              "start": 123,
                              "end": 123
                            }
                          ]
                        }
                      ],
                      "views": [
                        {
                          "name": "<string>",
                          "ranges": [
                            {
                              "start": 123,
                              "end": 123
                            }
                          ]
                        }
                      ],
                      "functions": [
                        {
                          "name": "<string>",
                          "ranges": [
                            {
                              "start": 123,
                              "end": 123
                            }
                          ]
                        }
                      ],
                      "procedures": [
                        {
                          "name": "<string>",
                          "ranges": [
                            {
                              "start": 123,
                              "end": 123
                            }
                          ]
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          },
          "sqlReviewReport": {
            "line": 123,
            "column": 123,
            "startPosition": {
              "line": 123,
              "column": 123
            },
            "endPosition": {
              "line": 123,
              "column": 123
            }
          }
        }
      ],
      "error": "<string>",
      "createTime": "2023-11-07T05:31:56Z"
    }
  ],
  "nextPageToken": "<string>"
}

Path Parameters

​
project
string
required

The project id.

​
plan
string
required

The plan id.

Query Parameters

​
pageSize
integer

Not used. The maximum number of plan check runs to return. The service may return fewer than this value. If unspecified, at most 10 plan check runs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

Not used. A page token, received from a previous ListPlanCheckRuns call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListPlanCheckRuns must match the call that provided the page token.

​
latestOnly
boolean

If set to true, only the latest plan check run will be returned.

​
filter
string

Filter is used to filter plan check runs returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec

Supported filters:

  • status: the plan check run status, support "==" and "in" operator, check the Status enum in the PlanCheckRun message for the values.
  • result_status: the plan check run result status, support "==" and "in" operator, check the Result.Status enum in the PlanCheckRun message for the values.

For example: status in ["DONE", "FAILED"] status == "RUNNING" result_status in ["SUCCESS", "ERROR"] result_status == "WARNING"

Response

200
application/json

OK

The response is of type object.