ProjectService
- GETGet v1* iampolicies:batchget
- GETGet v1projects
- POSTPost v1projects
- GETGet v1projects 1
- DELDelete v1projects
- PATCHPatch v1projects
- POSTPost v1projects webhooks :removewebhook
- PATCHPatch v1projects webhooks :updatewebhook
- POSTPost v1projects :addwebhook
- GETGet v1projects :getiampolicy
- POSTPost v1projects :setiampolicy
- POSTPost v1projects :testwebhook
- POSTPost v1projects :undelete
- POSTPost v1projects:batchdelete
- POSTPost v1projects:search
ActuatorService
AuditLogService
AuthService
OrgPolicyService
- GETGet v1environments policies
- POSTPost v1environments policies
- GETGet v1environments policies 1
- DELDelete v1environments policies
- PATCHPatch v1environments policies
- GETGet v1instances databases policies
- POSTPost v1instances databases policies
- GETGet v1instances databases policies 1
- DELDelete v1instances databases policies
- PATCHPatch v1instances databases policies
- GETGet v1instances policies
- POSTPost v1instances policies
- GETGet v1instances policies 1
- DELDelete v1instances policies
- PATCHPatch v1instances policies
- GETGet v1policies
- POSTPost v1policies
- GETGet v1policies 1
- DELDelete v1policies
- PATCHPatch v1policies
- GETGet v1projects policies
- POSTPost v1projects policies
- GETGet v1projects policies 1
- DELDelete v1projects policies
- PATCHPatch v1projects policies
GroupService
IdentityProviderService
InstanceService
- GETGet v1instances
- POSTPost v1instances
- GETGet v1instances 1
- DELDelete v1instances
- PATCHPatch v1instances
- POSTPost v1instances :adddatasource
- POSTPost v1instances :databases
- POSTPost v1instances :removedatasource
- POSTPost v1instances :sync
- POSTPost v1instances :undelete
- PATCHPatch v1instances :updatedatasource
- POSTPost v1instances:batchsync
- POSTPost v1instances:batchupdate
DatabaseService
- GETGet v1instances databases
- GETGet v1instances databases 1
- PATCHPatch v1instances databases
- GETGet v1instances databases changelogs
- GETGet v1instances databases changelogs 1
- POSTPost v1instances databases changelogs :diffschema
- GETGet v1instances databases metadata
- GETGet v1instances databases schema
- GETGet v1instances databases schemastring
- GETGet v1instances databases sdlschema
- POSTPost v1instances databases :diffschema
- POSTPost v1instances databases :sync
- GETGet v1instances databases:batchget
- POSTPost v1instances databases:batchsync
- POSTPost v1instances databases:batchupdate
- GETGet v1projects databases
- GETGet v1projects databases:batchget
- GETGet v1workspaces databases
DatabaseCatalogService
RevisionService
SQLService
InstanceRoleService
DatabaseGroupService
IssueService
- GETGet v1projects issues
- POSTPost v1projects issues
- GETGet v1projects issues 1
- PATCHPatch v1projects issues
- GETGet v1projects issues issuecomments
- POSTPost v1projects issues :approve
- POSTPost v1projects issues :comment
- PATCHPatch v1projects issues :comment
- POSTPost v1projects issues :reject
- POSTPost v1projects issues :request
- POSTPost v1projects issues:batchupdatestatus
- POSTPost v1projects issues:search
PlanService
ReleaseService
RolloutService
- GETGet v1projects rollouts
- POSTPost v1projects rollouts
- GETGet v1projects rollouts 1
- GETGet v1projects rollouts stages tasks taskruns
- GETGet v1projects rollouts stages tasks taskruns 1
- GETGet v1projects rollouts stages tasks taskruns log
- GETGet v1projects rollouts stages tasks taskruns session
- POSTPost v1projects rollouts stages tasks taskruns :previewrollback
- POSTPost v1projects rollouts stages tasks taskruns:batchcancel
- POSTPost v1projects rollouts stages tasks:batchrun
- POSTPost v1projects rollouts stages tasks:batchskip
- POSTPost v1projects :previewrollout
SheetService
ReviewConfigService
SubscriptionService
UserService
WorksheetService
Copy
Ask AI
{
"name": "<string>",
"title": "<string>",
"files": [
{
"id": "<string>",
"path": "<string>",
"type": "TYPE_UNSPECIFIED",
"version": "<string>",
"enableGhost": true,
"sheet": "<string>",
"statement": "<string>",
"sheetSha256": "<string>",
"statementSize": "<string>"
}
],
"vcsSource": {
"vcsType": "VCS_TYPE_UNSPECIFIED",
"url": "<string>"
},
"creator": "<string>",
"createTime": "2023-11-07T05:31:56Z",
"state": "STATE_UNSPECIFIED",
"digest": "<string>"
}ReleaseService
Get v1projects releases 1
Retrieves a release by name. Permissions required: bb.releases.get
GET
/
v1
/
projects
/
{project}
/
releases
/
{release}
Copy
Ask AI
{
"name": "<string>",
"title": "<string>",
"files": [
{
"id": "<string>",
"path": "<string>",
"type": "TYPE_UNSPECIFIED",
"version": "<string>",
"enableGhost": true,
"sheet": "<string>",
"statement": "<string>",
"sheetSha256": "<string>",
"statementSize": "<string>"
}
],
"vcsSource": {
"vcsType": "VCS_TYPE_UNSPECIFIED",
"url": "<string>"
},
"creator": "<string>",
"createTime": "2023-11-07T05:31:56Z",
"state": "STATE_UNSPECIFIED",
"digest": "<string>"
}Response
OK
Format: projects/{project}/releases/{release}
The title of the release.
The SQL files included in the release.
Show child attributes
Show child attributes
The unique identifier for the file.
The path of the file. e.g., 2.2/V0001_create_table.sql.
The type of the file.
Available options:
TYPE_UNSPECIFIED, VERSIONED, DECLARATIVE The version identifier for the file.
Whether to use gh-ost for online schema migration.
For inputs, we must either use sheet or statement.
For outputs, we always use sheet. statement is the preview of the sheet content.
The sheet that holds the content. Format: projects/{project}/sheets/{sheet}
The raw SQL statement content.
The SHA256 hash value of the sheet content or the statement.
The size of the statement in bytes.
Format: users/[email protected]
The lifecycle state of the release.
Available options:
STATE_UNSPECIFIED, ACTIVE, DELETED The digest of the release. The user can provide the digest of the release. It can be used later to retrieve the release in GetRelease. Whether to provide digest and how to generate it is up to the user. If the digest is not empty, it must be unique in the project. Otherwise, an ALREADY_EXISTS error will be returned.
Was this page helpful?