{ "batchPath": "batch", "name": "cloudbuild", "protocol": "rest", "id": "cloudbuild:v1", "ownerName": "Google", "mtlsRootUrl": "https://cloudbuild.mtls.googleapis.com/", "rootUrl": "https://cloudbuild.googleapis.com/", "basePath": "", "version": "v1", "description": "Creates and manages builds on Google Cloud Platform.", "version_module": true, "title": "Cloud Build API", "ownerDomain": "google.com", "resources": { "v1": { "methods": { "webhook": { "description": "ReceiveWebhook is called when the API receives a GitHub webhook.", "flatPath": "v1/webhook", "request": { "$ref": "HttpBody" }, "response": { "$ref": "Empty" }, "path": "v1/webhook", "id": "cloudbuild.webhook", "httpMethod": "POST", "parameters": { "webhookKey": { "location": "query", "type": "string", "description": "For GitHub Enterprise webhooks, this key is used to associate the webhook request with the GitHubEnterpriseConfig to use for validation." } }, "parameterOrder": [] } } }, "githubDotComWebhook": { "methods": { "receive": { "request": { "$ref": "HttpBody" }, "response": { "$ref": "Empty" }, "description": "ReceiveGitHubDotComWebhook is called when the API receives a github.com webhook.", "flatPath": "v1/githubDotComWebhook:receive", "id": "cloudbuild.githubDotComWebhook.receive", "httpMethod": "POST", "parameters": { "webhookKey": { "location": "query", "type": "string", "description": "For GitHub Enterprise webhooks, this key is used to associate the webhook request with the GitHubEnterpriseConfig to use for validation." } }, "parameterOrder": [], "path": "v1/githubDotComWebhook:receive" } } }, "locations": { "methods": { "regionalWebhook": { "description": "ReceiveRegionalWebhook is called when the API receives a regional GitHub webhook.", "flatPath": "v1/locations/{locationsId}/regionalWebhook", "request": { "$ref": "HttpBody" }, "response": { "$ref": "Empty" }, "path": "v1/{+location}/regionalWebhook", "parameterOrder": [ "location" ], "id": "cloudbuild.locations.regionalWebhook", "httpMethod": "POST", "parameters": { "location": { "required": true, "pattern": "^locations/[^/]+$", "description": "Required. The location where the webhook should be sent.", "location": "path", "type": "string" }, "webhookKey": { "location": "query", "type": "string", "description": "For GitHub Enterprise webhooks, this key is used to associate the webhook request with the GitHubEnterpriseConfig to use for validation." } } } } }, "operations": { "methods": { "get": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "cloudbuild.operations.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^operations/.*$", "required": true, "location": "path", "type": "string", "description": "The name of the operation resource." } }, "flatPath": "v1/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1/operations/{operationsId}:cancel", "request": { "$ref": "CancelOperationRequest" }, "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:cancel", "parameterOrder": [ "name" ], "id": "cloudbuild.operations.cancel", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", "type": "string", "required": true, "pattern": "^operations/.*$" } } } } }, "projects": { "resources": { "triggers": { "methods": { "delete": { "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectId}/triggers/{triggerId}", "description": "Deletes a `BuildTrigger` by its project ID and trigger ID.", "parameterOrder": [ "projectId", "triggerId" ], "id": "cloudbuild.projects.triggers.delete", "httpMethod": "DELETE", "parameters": { "projectId": { "location": "path", "type": "string", "description": "Required. ID of the project that owns the trigger.", "required": true }, "triggerId": { "required": true, "location": "path", "type": "string", "description": "Required. ID of the `BuildTrigger` to delete." }, "name": { "location": "query", "type": "string", "description": "The name of the `Trigger` to delete. Format: `projects/{project}/locations/{location}/triggers/{trigger}`" } }, "path": "v1/projects/{projectId}/triggers/{triggerId}" }, "webhook": { "request": { "$ref": "HttpBody" }, "response": { "$ref": "ReceiveTriggerWebhookResponse" }, "description": "ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.", "flatPath": "v1/projects/{projectId}/triggers/{trigger}:webhook", "parameterOrder": [ "projectId", "trigger" ], "id": "cloudbuild.projects.triggers.webhook", "httpMethod": "POST", "parameters": { "trigger": { "location": "path", "type": "string", "description": "Name of the trigger to run the payload against", "required": true }, "secret": { "description": "Secret token used for authorization if an OAuth token isn't provided.", "location": "query", "type": "string" }, "projectId": { "location": "path", "type": "string", "description": "Project in which the specified trigger lives", "required": true }, "name": { "location": "query", "type": "string", "description": "The name of the `ReceiveTriggerWebhook` to retrieve. Format: `projects/{project}/locations/{location}/triggers/{trigger}`" } }, "path": "v1/projects/{projectId}/triggers/{trigger}:webhook" }, "run": { "description": "Runs a `BuildTrigger` at a particular source revision. To run a regional or global trigger, use the POST request that includes the location endpoint in the path (ex. v1/projects/{projectId}/locations/{region}/triggers/{triggerId}:run). The POST request that does not include the location endpoint in the path can only be used when running global triggers.", "flatPath": "v1/projects/{projectId}/triggers/{triggerId}:run", "request": { "$ref": "RepoSource" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/projects/{projectId}/triggers/{triggerId}:run", "parameterOrder": [ "projectId", "triggerId" ], "id": "cloudbuild.projects.triggers.run", "httpMethod": "POST", "parameters": { "projectId": { "required": true, "description": "Required. ID of the project.", "location": "path", "type": "string" }, "triggerId": { "description": "Required. ID of the trigger.", "location": "path", "type": "string", "required": true }, "name": { "location": "query", "type": "string", "description": "The name of the `Trigger` to run. Format: `projects/{project}/locations/{location}/triggers/{trigger}`" } } }, "create": { "id": "cloudbuild.projects.triggers.create", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. ID of the project for which to configure automatic builds.", "location": "path", "type": "string", "required": true }, "parent": { "description": "The parent resource where this trigger will be created. Format: `projects/{project}/locations/{location}`", "location": "query", "type": "string" } }, "parameterOrder": [ "projectId" ], "path": "v1/projects/{projectId}/triggers", "request": { "$ref": "BuildTrigger" }, "response": { "$ref": "BuildTrigger" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new `BuildTrigger`.", "flatPath": "v1/projects/{projectId}/triggers" }, "get": { "path": "v1/projects/{projectId}/triggers/{triggerId}", "parameterOrder": [ "projectId", "triggerId" ], "id": "cloudbuild.projects.triggers.get", "httpMethod": "GET", "parameters": { "projectId": { "location": "path", "type": "string", "description": "Required. ID of the project that owns the trigger.", "required": true }, "triggerId": { "required": true, "description": "Required. Identifier (`id` or `name`) of the `BuildTrigger` to get.", "location": "path", "type": "string" }, "name": { "description": "The name of the `Trigger` to retrieve. Format: `projects/{project}/locations/{location}/triggers/{trigger}`", "location": "query", "type": "string" } }, "description": "Returns information about a `BuildTrigger`.", "flatPath": "v1/projects/{projectId}/triggers/{triggerId}", "response": { "$ref": "BuildTrigger" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "path": "v1/projects/{projectId}/triggers", "id": "cloudbuild.projects.triggers.list", "httpMethod": "GET", "parameters": { "pageToken": { "description": "Token to provide to skip to a particular spot in the list.", "location": "query", "type": "string" }, "projectId": { "location": "path", "type": "string", "description": "Required. ID of the project for which to list BuildTriggers.", "required": true }, "parent": { "location": "query", "type": "string", "description": "The parent of the collection of `Triggers`. Format: `projects/{project}/locations/{location}`" }, "pageSize": { "description": "Number of results to return in the list.", "location": "query", "type": "integer", "format": "int32" } }, "parameterOrder": [ "projectId" ], "flatPath": "v1/projects/{projectId}/triggers", "description": "Lists existing `BuildTrigger`s.", "response": { "$ref": "ListBuildTriggersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "request": { "$ref": "BuildTrigger" }, "response": { "$ref": "BuildTrigger" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectId}/triggers/{triggerId}", "description": "Updates a `BuildTrigger` by its project ID and trigger ID.", "id": "cloudbuild.projects.triggers.patch", "httpMethod": "PATCH", "parameters": { "projectId": { "location": "path", "type": "string", "description": "Required. ID of the project that owns the trigger.", "required": true }, "triggerId": { "description": "Required. ID of the `BuildTrigger` to update.", "location": "path", "type": "string", "required": true }, "updateMask": { "format": "google-fieldmask", "description": "Update mask for the resource. If this is set, the server will only update the fields specified in the field mask. Otherwise, a full update of the mutable resource fields will be performed.", "location": "query", "type": "string" } }, "parameterOrder": [ "projectId", "triggerId" ], "path": "v1/projects/{projectId}/triggers/{triggerId}" } } }, "githubEnterpriseConfigs": { "methods": { "create": { "path": "v1/{+parent}/githubEnterpriseConfigs", "id": "cloudbuild.projects.githubEnterpriseConfigs.create", "httpMethod": "POST", "parameters": { "parent": { "description": "Name of the parent project. For example: projects/{$project_number} or projects/{$project_id}", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+$" }, "projectId": { "location": "query", "type": "string", "description": "ID of the project.", "deprecated": true }, "gheConfigId": { "location": "query", "type": "string", "description": "Optional. The ID to use for the GithubEnterpriseConfig, which will become the final component of the GithubEnterpriseConfig's resource name. ghe_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character" } }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/githubEnterpriseConfigs", "description": "Create an association between a GCP project and a GitHub Enterprise server.", "request": { "$ref": "GitHubEnterpriseConfig" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "description": "Update an association between a GCP project and a GitHub Enterprise server.", "flatPath": "v1/projects/{projectsId}/githubEnterpriseConfigs/{githubEnterpriseConfigsId}", "request": { "$ref": "GitHubEnterpriseConfig" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "cloudbuild.projects.githubEnterpriseConfigs.patch", "httpMethod": "PATCH", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/githubEnterpriseConfigs/[^/]+$", "description": "Identifier. The full resource name for the GitHubEnterpriseConfig For example: \"projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}\"", "location": "path", "type": "string" }, "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Update mask for the resource. If this is set, the server will only update the fields specified in the field mask. Otherwise, a full update of the mutable resource fields will be performed." } }, "parameterOrder": [ "name" ] }, "get": { "parameterOrder": [ "name" ], "id": "cloudbuild.projects.githubEnterpriseConfigs.get", "httpMethod": "GET", "parameters": { "configId": { "location": "query", "type": "string", "description": "Unique identifier of the `GitHubEnterpriseConfig`", "deprecated": true }, "name": { "pattern": "^projects/[^/]+/githubEnterpriseConfigs/[^/]+$", "required": true, "location": "path", "type": "string", "description": "This field should contain the name of the enterprise config resource. For example: \"projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}\"" }, "projectId": { "location": "query", "type": "string", "description": "ID of the project", "deprecated": true } }, "path": "v1/{+name}", "response": { "$ref": "GitHubEnterpriseConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/githubEnterpriseConfigs/{githubEnterpriseConfigsId}", "description": "Retrieve a GitHubEnterpriseConfig." }, "list": { "flatPath": "v1/projects/{projectsId}/githubEnterpriseConfigs", "description": "List all GitHubEnterpriseConfigs for a given project.", "response": { "$ref": "ListGithubEnterpriseConfigsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/githubEnterpriseConfigs", "parameterOrder": [ "parent" ], "id": "cloudbuild.projects.githubEnterpriseConfigs.list", "httpMethod": "GET", "parameters": { "parent": { "location": "path", "type": "string", "description": "Name of the parent project. For example: projects/{$project_number} or projects/{$project_id}", "pattern": "^projects/[^/]+$", "required": true }, "projectId": { "description": "ID of the project", "location": "query", "type": "string", "deprecated": true } } }, "delete": { "flatPath": "v1/projects/{projectsId}/githubEnterpriseConfigs/{githubEnterpriseConfigsId}", "description": "Delete an association between a GCP project and a GitHub Enterprise server.", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "cloudbuild.projects.githubEnterpriseConfigs.delete", "httpMethod": "DELETE", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/githubEnterpriseConfigs/[^/]+$", "description": "This field should contain the name of the enterprise config resource. For example: \"projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}\"", "location": "path", "type": "string" }, "projectId": { "deprecated": true, "description": "ID of the project", "location": "query", "type": "string" }, "configId": { "deprecated": true, "description": "Unique identifier of the `GitHubEnterpriseConfig`", "location": "query", "type": "string" } } } } }, "locations": { "methods": { "getDefaultServiceAccount": { "parameterOrder": [ "name" ], "id": "cloudbuild.projects.locations.getDefaultServiceAccount", "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/defaultServiceAccount$", "description": "Required. The name of the `DefaultServiceAccount` to retrieve. Format: `projects/{project}/locations/{location}/defaultServiceAccount`", "location": "path", "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "DefaultServiceAccount" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/defaultServiceAccount", "description": "Returns the `DefaultServiceAccount` used by the project." } }, "resources": { "operations": { "methods": { "get": { "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "id": "cloudbuild.projects.locations.operations.get", "httpMethod": "GET", "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "cancel": { "path": "v1/{+name}:cancel", "parameterOrder": [ "name" ], "id": "cloudbuild.projects.locations.operations.cancel", "httpMethod": "POST", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "location": "path", "type": "string", "description": "The name of the operation resource to be cancelled." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "request": { "$ref": "CancelOperationRequest" }, "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "githubEnterpriseConfigs": { "methods": { "create": { "parameterOrder": [ "parent" ], "id": "cloudbuild.projects.locations.githubEnterpriseConfigs.create", "httpMethod": "POST", "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Name of the parent project. For example: projects/{$project_number} or projects/{$project_id}", "location": "path", "type": "string" }, "projectId": { "location": "query", "type": "string", "description": "ID of the project.", "deprecated": true }, "gheConfigId": { "location": "query", "type": "string", "description": "Optional. The ID to use for the GithubEnterpriseConfig, which will become the final component of the GithubEnterpriseConfig's resource name. ghe_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character" } }, "path": "v1/{+parent}/githubEnterpriseConfigs", "request": { "$ref": "GitHubEnterpriseConfig" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create an association between a GCP project and a GitHub Enterprise server.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/githubEnterpriseConfigs" }, "patch": { "path": "v1/{+name}", "id": "cloudbuild.projects.locations.githubEnterpriseConfigs.patch", "httpMethod": "PATCH", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/githubEnterpriseConfigs/[^/]+$", "description": "Identifier. The full resource name for the GitHubEnterpriseConfig For example: \"projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}\"", "location": "path", "type": "string" }, "updateMask": { "description": "Update mask for the resource. If this is set, the server will only update the fields specified in the field mask. Otherwise, a full update of the mutable resource fields will be performed.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "description": "Update an association between a GCP project and a GitHub Enterprise server.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/githubEnterpriseConfigs/{githubEnterpriseConfigsId}", "request": { "$ref": "GitHubEnterpriseConfig" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "response": { "$ref": "GitHubEnterpriseConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Retrieve a GitHubEnterpriseConfig.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/githubEnterpriseConfigs/{githubEnterpriseConfigsId}", "id": "cloudbuild.projects.locations.githubEnterpriseConfigs.get", "httpMethod": "GET", "parameters": { "name": { "description": "This field should contain the name of the enterprise config resource. For example: \"projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}\"", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/githubEnterpriseConfigs/[^/]+$" }, "projectId": { "deprecated": true, "location": "query", "type": "string", "description": "ID of the project" }, "configId": { "deprecated": true, "description": "Unique identifier of the `GitHubEnterpriseConfig`", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "list": { "path": "v1/{+parent}/githubEnterpriseConfigs", "id": "cloudbuild.projects.locations.githubEnterpriseConfigs.list", "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Name of the parent project. For example: projects/{$project_number} or projects/{$project_id}" }, "projectId": { "location": "query", "type": "string", "description": "ID of the project", "deprecated": true } }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/githubEnterpriseConfigs", "description": "List all GitHubEnterpriseConfigs for a given project.", "response": { "$ref": "ListGithubEnterpriseConfigsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Delete an association between a GCP project and a GitHub Enterprise server.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/githubEnterpriseConfigs/{githubEnterpriseConfigsId}", "id": "cloudbuild.projects.locations.githubEnterpriseConfigs.delete", "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "type": "string", "description": "This field should contain the name of the enterprise config resource. For example: \"projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}\"", "pattern": "^projects/[^/]+/locations/[^/]+/githubEnterpriseConfigs/[^/]+$", "required": true }, "projectId": { "description": "ID of the project", "location": "query", "type": "string", "deprecated": true }, "configId": { "deprecated": true, "location": "query", "type": "string", "description": "Unique identifier of the `GitHubEnterpriseConfig`" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}" } } }, "bitbucketServerConfigs": { "methods": { "delete": { "description": "Delete a `BitbucketServerConfig`. This API is experimental.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bitbucketServerConfigs/{bitbucketServerConfigsId}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "cloudbuild.projects.locations.bitbucketServerConfigs.delete", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The config resource name.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/bitbucketServerConfigs/[^/]+$" } }, "parameterOrder": [ "name" ] }, "removeBitbucketServerConnectedRepository": { "parameterOrder": [ "config" ], "id": "cloudbuild.projects.locations.bitbucketServerConfigs.removeBitbucketServerConnectedRepository", "httpMethod": "POST", "parameters": { "config": { "description": "Required. The name of the `BitbucketServerConfig` to remove a connected repository. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{config}`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/bitbucketServerConfigs/[^/]+$" } }, "path": "v1/{+config}:removeBitbucketServerConnectedRepository", "request": { "$ref": "RemoveBitbucketServerConnectedRepositoryRequest" }, "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bitbucketServerConfigs/{bitbucketServerConfigsId}:removeBitbucketServerConnectedRepository", "description": "Remove a Bitbucket Server repository from a given BitbucketServerConfig's connected repositories. This API is experimental." }, "create": { "id": "cloudbuild.projects.locations.bitbucketServerConfigs.create", "httpMethod": "POST", "parameters": { "bitbucketServerConfigId": { "description": "Optional. The ID to use for the BitbucketServerConfig, which will become the final component of the BitbucketServerConfig's resource name. bitbucket_server_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character.", "location": "query", "type": "string" }, "parent": { "description": "Required. Name of the parent resource.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/bitbucketServerConfigs", "request": { "$ref": "BitbucketServerConfig" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new `BitbucketServerConfig`. This API is experimental.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bitbucketServerConfigs" }, "patch": { "request": { "$ref": "BitbucketServerConfig" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an existing `BitbucketServerConfig`. This API is experimental.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bitbucketServerConfigs/{bitbucketServerConfigsId}", "id": "cloudbuild.projects.locations.bitbucketServerConfigs.patch", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. The resource name for the config.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/bitbucketServerConfigs/[^/]+$" }, "updateMask": { "location": "query", "type": "string", "description": "Update mask for the resource. If this is set, the server will only update the fields specified in the field mask. Otherwise, a full update of the mutable resource fields will be performed.", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "get": { "path": "v1/{+name}", "id": "cloudbuild.projects.locations.bitbucketServerConfigs.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/bitbucketServerConfigs/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. The config resource name." } }, "parameterOrder": [ "name" ], "description": "Retrieve a `BitbucketServerConfig`. This API is experimental.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bitbucketServerConfigs/{bitbucketServerConfigsId}", "response": { "$ref": "BitbucketServerConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameterOrder": [ "parent" ], "id": "cloudbuild.projects.locations.bitbucketServerConfigs.list", "httpMethod": "GET", "parameters": { "pageSize": { "description": "The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 50 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. Name of the parent resource." }, "pageToken": { "location": "query", "type": "string", "description": "A page token, received from a previous `ListBitbucketServerConfigsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBitbucketServerConfigsRequest` must match the call that provided the page token." } }, "path": "v1/{+parent}/bitbucketServerConfigs", "response": { "$ref": "ListBitbucketServerConfigsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List all `BitbucketServerConfigs` for a given project. This API is experimental.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bitbucketServerConfigs" } }, "resources": { "connectedRepositories": { "methods": { "batchCreate": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bitbucketServerConfigs/{bitbucketServerConfigsId}/connectedRepositories:batchCreate", "description": "Batch connecting Bitbucket Server repositories to Cloud Build.", "request": { "$ref": "BatchCreateBitbucketServerConnectedRepositoriesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/connectedRepositories:batchCreate", "parameterOrder": [ "parent" ], "id": "cloudbuild.projects.locations.bitbucketServerConfigs.connectedRepositories.batchCreate", "httpMethod": "POST", "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/bitbucketServerConfigs/[^/]+$", "description": "The name of the `BitbucketServerConfig` that added connected repository. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{config}`", "location": "path", "type": "string" } } } } }, "repos": { "methods": { "list": { "response": { "$ref": "ListBitbucketServerRepositoriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/bitbucketServerConfigs/{bitbucketServerConfigsId}/repos", "description": "List all repositories for a given `BitbucketServerConfig`. This API is experimental.", "id": "cloudbuild.projects.locations.bitbucketServerConfigs.repos.list", "httpMethod": "GET", "parameters": { "pageSize": { "description": "The maximum number of configs to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/bitbucketServerConfigs/[^/]+$", "description": "Required. Name of the parent resource.", "location": "path", "type": "string" }, "pageToken": { "description": "A page token, received from a previous `ListBitbucketServerRepositoriesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBitbucketServerConfigsRequest` must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/repos" } } } } }, "builds": { "methods": { "approve": { "request": { "$ref": "ApproveBuildRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds/{buildsId}:approve", "description": "Approves or rejects a pending build. If approved, the returned long-running operation (LRO) will be analogous to the LRO returned from a CreateBuild call. If rejected, the returned LRO will be immediately done.", "id": "cloudbuild.projects.locations.builds.approve", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the target build. For example: \"projects/{$project_id}/builds/{$build_id}\"", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/builds/[^/]+$" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}:approve" }, "cancel": { "parameterOrder": [ "name" ], "id": "cloudbuild.projects.locations.builds.cancel", "httpMethod": "POST", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/builds/[^/]+$", "description": "The name of the `Build` to cancel. Format: `projects/{project}/locations/{location}/builds/{build}`", "location": "path", "type": "string" } }, "path": "v1/{+name}:cancel", "request": { "$ref": "CancelBuildRequest" }, "response": { "$ref": "Build" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Cancels a build in progress. Note: This method only cancels builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds/{id}:cancel. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:cancel`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds/{buildsId}:cancel" }, "retry": { "path": "v1/{+name}:retry", "id": "cloudbuild.projects.locations.builds.retry", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the `Build` to retry. Format: `projects/{project}/locations/{location}/builds/{build}`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/builds/[^/]+$" } }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds/{buildsId}:retry", "description": "Creates a new build based on the specified build. Note: This method only creates builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds/{id}:retry. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", "request": { "$ref": "RetryBuildRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "id": "cloudbuild.projects.locations.builds.create", "httpMethod": "POST", "parameters": { "parent": { "description": "The parent resource where this build will be created. Format: `projects/{project}/locations/{location}`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "projectId": { "location": "query", "type": "string", "description": "Required. ID of the project." } }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/builds", "request": { "$ref": "Build" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds", "description": "Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds`." }, "get": { "id": "cloudbuild.projects.locations.builds.get", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the `Build` to retrieve. Format: `projects/{project}/locations/{location}/builds/{build}`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/builds/[^/]+$" }, "projectId": { "description": "Required. ID of the project.", "location": "query", "type": "string" }, "id": { "location": "query", "type": "string", "description": "Required. ID of the build." } }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "Build" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds/{buildsId}", "description": "Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only gets builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds/{id}. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}`." }, "list": { "path": "v1/{+parent}/builds", "id": "cloudbuild.projects.locations.builds.list", "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "type": "string", "description": "The parent of the collection of `Builds`. Format: `projects/{project}/locations/{location}`" }, "pageToken": { "location": "query", "type": "string", "description": "The page token for the next page of Builds. If unspecified, the first page of results is returned. If the token is rejected for any reason, INVALID_ARGUMENT will be thrown. In this case, the token should be discarded, and pagination should be restarted from the first page of results. See https://google.aip.dev/158 for more." }, "pageSize": { "location": "query", "type": "integer", "description": "Number of results to return in the list.", "format": "int32" }, "projectId": { "location": "query", "type": "string", "description": "Required. ID of the project." }, "filter": { "description": "The raw filter text to constrain the results.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "description": "Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds", "response": { "$ref": "ListBuildsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "triggers": { "methods": { "create": { "path": "v1/{+parent}/triggers", "parameterOrder": [ "parent" ], "id": "cloudbuild.projects.locations.triggers.create", "httpMethod": "POST", "parameters": { "parent": { "description": "The parent resource where this trigger will be created. Format: `projects/{project}/locations/{location}`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "projectId": { "location": "query", "type": "string", "description": "Required. ID of the project for which to configure automatic builds." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/triggers", "description": "Creates a new `BuildTrigger`.", "request": { "$ref": "BuildTrigger" }, "response": { "$ref": "BuildTrigger" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "cloudbuild.projects.locations.triggers.get", "httpMethod": "GET", "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the `Trigger` to retrieve. Format: `projects/{project}/locations/{location}/triggers/{trigger}`", "pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$", "required": true }, "projectId": { "description": "Required. ID of the project that owns the trigger.", "location": "query", "type": "string" }, "triggerId": { "description": "Required. Identifier (`id` or `name`) of the `BuildTrigger` to get.", "location": "query", "type": "string" } }, "description": "Returns information about a `BuildTrigger`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/triggers/{triggersId}", "response": { "$ref": "BuildTrigger" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "response": { "$ref": "ListBuildTriggersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists existing `BuildTrigger`s.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/triggers", "id": "cloudbuild.projects.locations.triggers.list", "httpMethod": "GET", "parameters": { "pageToken": { "description": "Token to provide to skip to a particular spot in the list.", "location": "query", "type": "string" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "The parent of the collection of `Triggers`. Format: `projects/{project}/locations/{location}`", "location": "path", "type": "string" }, "projectId": { "location": "query", "type": "string", "description": "Required. ID of the project for which to list BuildTriggers." }, "pageSize": { "location": "query", "type": "integer", "description": "Number of results to return in the list.", "format": "int32" } }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/triggers" }, "patch": { "id": "cloudbuild.projects.locations.triggers.patch", "httpMethod": "PATCH", "parameters": { "resourceName": { "description": "The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$" }, "projectId": { "description": "Required. ID of the project that owns the trigger.", "location": "query", "type": "string" }, "triggerId": { "location": "query", "type": "string", "description": "Required. ID of the `BuildTrigger` to update." }, "updateMask": { "description": "Update mask for the resource. If this is set, the server will only update the fields specified in the field mask. Otherwise, a full update of the mutable resource fields will be performed.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "resourceName" ], "path": "v1/{+resourceName}", "request": { "$ref": "BuildTrigger" }, "response": { "$ref": "BuildTrigger" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/triggers/{triggersId}", "description": "Updates a `BuildTrigger` by its project ID and trigger ID." }, "run": { "id": "cloudbuild.projects.locations.triggers.run", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the `Trigger` to run. Format: `projects/{project}/locations/{location}/triggers/{trigger}`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}:run", "request": { "$ref": "RunBuildTriggerRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Runs a `BuildTrigger` at a particular source revision. To run a regional or global trigger, use the POST request that includes the location endpoint in the path (ex. v1/projects/{projectId}/locations/{region}/triggers/{triggerId}:run). The POST request that does not include the location endpoint in the path can only be used when running global triggers.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/triggers/{triggersId}:run" }, "delete": { "path": "v1/{+name}", "id": "cloudbuild.projects.locations.triggers.delete", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the `Trigger` to delete. Format: `projects/{project}/locations/{location}/triggers/{trigger}`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$" }, "projectId": { "description": "Required. ID of the project that owns the trigger.", "location": "query", "type": "string" }, "triggerId": { "location": "query", "type": "string", "description": "Required. ID of the `BuildTrigger` to delete." } }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/triggers/{triggersId}", "description": "Deletes a `BuildTrigger` by its project ID and trigger ID.", "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "webhook": { "path": "v1/{+name}:webhook", "id": "cloudbuild.projects.locations.triggers.webhook", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the `ReceiveTriggerWebhook` to retrieve. Format: `projects/{project}/locations/{location}/triggers/{trigger}`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$" }, "projectId": { "description": "Project in which the specified trigger lives", "location": "query", "type": "string" }, "trigger": { "location": "query", "type": "string", "description": "Name of the trigger to run the payload against" }, "secret": { "description": "Secret token used for authorization if an OAuth token isn't provided.", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/triggers/{triggersId}:webhook", "description": "ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.", "request": { "$ref": "HttpBody" }, "response": { "$ref": "ReceiveTriggerWebhookResponse" } } } }, "workerPools": { "methods": { "delete": { "parameterOrder": [ "name" ], "id": "cloudbuild.projects.locations.workerPools.delete", "httpMethod": "DELETE", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", "description": "Required. The name of the `WorkerPool` to delete. Format: `projects/{project}/locations/{location}/workerPools/{workerPool}`.", "location": "path", "type": "string" }, "etag": { "description": "Optional. If provided, it must match the server's etag on the workerpool for the request to be processed.", "location": "query", "type": "string" }, "allowMissing": { "location": "query", "type": "boolean", "description": "If set to true, and the `WorkerPool` is not found, the request will succeed but no action will be taken on the server." }, "validateOnly": { "location": "query", "type": "boolean", "description": "If set, validate the request and preview the response, but do not actually post it." } }, "path": "v1/{+name}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a `WorkerPool`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}" }, "create": { "path": "v1/{+parent}/workerPools", "id": "cloudbuild.projects.locations.workerPools.create", "httpMethod": "POST", "parameters": { "workerPoolId": { "location": "query", "type": "string", "description": "Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/." }, "parent": { "description": "Required. The parent resource where this worker pool will be created. Format: `projects/{project}/locations/{location}`.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "validateOnly": { "location": "query", "type": "boolean", "description": "If set, validate the request and preview the response, but do not actually post it." } }, "parameterOrder": [ "parent" ], "description": "Creates a `WorkerPool`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workerPools", "request": { "$ref": "WorkerPool" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}", "description": "Returns details of a `WorkerPool`.", "response": { "$ref": "WorkerPool" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "cloudbuild.projects.locations.workerPools.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. The name of the `WorkerPool` to retrieve. Format: `projects/{project}/locations/{location}/workerPools/{workerPool}`." } }, "parameterOrder": [ "name" ] }, "patch": { "request": { "$ref": "WorkerPool" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a `WorkerPool`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}", "id": "cloudbuild.projects.locations.workerPools.patch", "httpMethod": "PATCH", "parameters": { "name": { "description": "Output only. The resource name of the `WorkerPool`, with format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. The value of `{worker_pool}` is provided by `worker_pool_id` in `CreateWorkerPool` request and the value of `{location}` is determined by the endpoint accessed.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$" }, "updateMask": { "description": "Optional. A mask specifying which fields in `worker_pool` to update.", "location": "query", "type": "string", "format": "google-fieldmask" }, "validateOnly": { "location": "query", "type": "boolean", "description": "If set, validate the request and preview the response, but do not actually post it." } }, "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workerPools", "description": "Lists `WorkerPool`s.", "response": { "$ref": "ListWorkerPoolsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/workerPools", "parameterOrder": [ "parent" ], "id": "cloudbuild.projects.locations.workerPools.list", "httpMethod": "GET", "parameters": { "pageToken": { "description": "A page token, received from a previous `ListWorkerPools` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { "location": "path", "type": "string", "description": "Required. The parent of the collection of `WorkerPools`. Format: `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "The maximum number of `WorkerPool`s to return. The service may return fewer than this value. If omitted, the server will use a sensible default." } } } } } } }, "builds": { "methods": { "retry": { "description": "Creates a new build based on the specified build. Note: This method only creates builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds/{id}:retry. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", "flatPath": "v1/projects/{projectId}/builds/{id}:retry", "request": { "$ref": "RetryBuildRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/projects/{projectId}/builds/{id}:retry", "id": "cloudbuild.projects.builds.retry", "httpMethod": "POST", "parameters": { "projectId": { "description": "Required. ID of the project.", "location": "path", "type": "string", "required": true }, "id": { "location": "path", "type": "string", "description": "Required. Build ID of the original build.", "required": true } }, "parameterOrder": [ "projectId", "id" ] }, "create": { "path": "v1/projects/{projectId}/builds", "id": "cloudbuild.projects.builds.create", "httpMethod": "POST", "parameters": { "projectId": { "location": "path", "type": "string", "description": "Required. ID of the project.", "required": true }, "parent": { "description": "The parent resource where this build will be created. Format: `projects/{project}/locations/{location}`", "location": "query", "type": "string" } }, "parameterOrder": [ "projectId" ], "flatPath": "v1/projects/{projectId}/builds", "description": "Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.", "request": { "$ref": "Build" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "path": "v1/projects/{projectId}/builds/{id}", "parameterOrder": [ "projectId", "id" ], "id": "cloudbuild.projects.builds.get", "httpMethod": "GET", "parameters": { "projectId": { "required": true, "description": "Required. ID of the project.", "location": "path", "type": "string" }, "name": { "description": "The name of the `Build` to retrieve. Format: `projects/{project}/locations/{location}/builds/{build}`", "location": "query", "type": "string" }, "id": { "description": "Required. ID of the build.", "location": "path", "type": "string", "required": true } }, "description": "Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only gets builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds/{id}. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}`.", "flatPath": "v1/projects/{projectId}/builds/{id}", "response": { "$ref": "Build" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "id": "cloudbuild.projects.builds.list", "httpMethod": "GET", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "The page token for the next page of Builds. If unspecified, the first page of results is returned. If the token is rejected for any reason, INVALID_ARGUMENT will be thrown. In this case, the token should be discarded, and pagination should be restarted from the first page of results. See https://google.aip.dev/158 for more." }, "parent": { "location": "query", "type": "string", "description": "The parent of the collection of `Builds`. Format: `projects/{project}/locations/{location}`" }, "filter": { "description": "The raw filter text to constrain the results.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Number of results to return in the list." }, "projectId": { "description": "Required. ID of the project.", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "projectId" ], "path": "v1/projects/{projectId}/builds", "response": { "$ref": "ListBuildsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.", "flatPath": "v1/projects/{projectId}/builds" }, "approve": { "description": "Approves or rejects a pending build. If approved, the returned long-running operation (LRO) will be analogous to the LRO returned from a CreateBuild call. If rejected, the returned LRO will be immediately done.", "flatPath": "v1/projects/{projectsId}/builds/{buildsId}:approve", "request": { "$ref": "ApproveBuildRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:approve", "parameterOrder": [ "name" ], "id": "cloudbuild.projects.builds.approve", "httpMethod": "POST", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. Name of the target build. For example: \"projects/{$project_id}/builds/{$build_id}\"", "pattern": "^projects/[^/]+/builds/[^/]+$", "required": true } } }, "cancel": { "path": "v1/projects/{projectId}/builds/{id}:cancel", "parameterOrder": [ "projectId", "id" ], "id": "cloudbuild.projects.builds.cancel", "httpMethod": "POST", "parameters": { "id": { "required": true, "location": "path", "type": "string", "description": "Required. ID of the build." }, "projectId": { "required": true, "location": "path", "type": "string", "description": "Required. ID of the project." } }, "flatPath": "v1/projects/{projectId}/builds/{id}:cancel", "description": "Cancels a build in progress. Note: This method only cancels builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds/{id}:cancel. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:cancel`.", "request": { "$ref": "CancelBuildRequest" }, "response": { "$ref": "Build" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } }, "discoveryVersion": "v1", "kind": "discovery#restDescription", "parameters": { "prettyPrint": { "type": "boolean", "location": "query", "description": "Returns response with indentations and line breaks.", "default": "true" }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." }, "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json", "description": "Data format for response.", "type": "string", "location": "query", "enum": [ "json", "media", "proto" ] }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, "$.xgafv": { "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "location": "query", "description": "V1 error format." }, "key": { "type": "string", "location": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "quotaUser": { "type": "string", "location": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." } }, "canonicalName": "Cloud Build", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "documentationLink": "https://cloud.google.com/cloud-build/docs/", "endpoints": [ { "location": "africa-south1", "endpointUrl": "https://cloudbuild.africa-south1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "asia-east1", "endpointUrl": "https://cloudbuild.asia-east1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://cloudbuild.asia-east2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-east2" }, { "endpointUrl": "https://cloudbuild.asia-northeast1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-northeast1" }, { "location": "asia-northeast2", "endpointUrl": "https://cloudbuild.asia-northeast2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "asia-northeast3", "endpointUrl": "https://cloudbuild.asia-northeast3.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "asia-south1", "endpointUrl": "https://cloudbuild.asia-south1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "asia-south2", "endpointUrl": "https://cloudbuild.asia-south2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "asia-southeast1", "endpointUrl": "https://cloudbuild.asia-southeast1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "asia-southeast2", "endpointUrl": "https://cloudbuild.asia-southeast2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://cloudbuild.asia-southeast3.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-southeast3" }, { "endpointUrl": "https://cloudbuild.australia-southeast1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "australia-southeast1" }, { "location": "australia-southeast2", "endpointUrl": "https://cloudbuild.australia-southeast2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://cloudbuild.europe-central2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-central2" }, { "location": "europe-north1", "endpointUrl": "https://cloudbuild.europe-north1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "europe-north2", "endpointUrl": "https://cloudbuild.europe-north2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "europe-southwest1", "endpointUrl": "https://cloudbuild.europe-southwest1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://cloudbuild.europe-west1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west1" }, { "endpointUrl": "https://cloudbuild.europe-west10.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west10" }, { "endpointUrl": "https://cloudbuild.europe-west12.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west12" }, { "endpointUrl": "https://cloudbuild.europe-west2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west2" }, { "endpointUrl": "https://cloudbuild.europe-west3.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west3" }, { "location": "europe-west4", "endpointUrl": "https://cloudbuild.europe-west4.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://cloudbuild.europe-west6.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west6" }, { "location": "europe-west8", "endpointUrl": "https://cloudbuild.europe-west8.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://cloudbuild.europe-west9.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west9" }, { "endpointUrl": "https://cloudbuild.europe-west15.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west15" }, { "endpointUrl": "https://cloudbuild.me-central1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "me-central1" }, { "endpointUrl": "https://cloudbuild.me-central2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "me-central2" }, { "location": "me-west1", "endpointUrl": "https://cloudbuild.me-west1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "northamerica-northeast1", "endpointUrl": "https://cloudbuild.northamerica-northeast1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://cloudbuild.northamerica-northeast2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "northamerica-northeast2" }, { "location": "northamerica-south1", "endpointUrl": "https://cloudbuild.northamerica-south1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "southamerica-east1", "endpointUrl": "https://cloudbuild.southamerica-east1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://cloudbuild.southamerica-west1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "southamerica-west1" }, { "endpointUrl": "https://cloudbuild.us-central1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-central1" }, { "endpointUrl": "https://cloudbuild.us-central2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-central2" }, { "endpointUrl": "https://cloudbuild.us-east1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-east1" }, { "location": "us-east4", "endpointUrl": "https://cloudbuild.us-east4.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://cloudbuild.us-east5.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-east5" }, { "location": "us-east7", "endpointUrl": "https://cloudbuild.us-east7.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://cloudbuild.us-south1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-south1" }, { "location": "us-west1", "endpointUrl": "https://cloudbuild.us-west1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "us-west2", "endpointUrl": "https://cloudbuild.us-west2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "us-west3", "endpointUrl": "https://cloudbuild.us-west3.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "us-west4", "endpointUrl": "https://cloudbuild.us-west4.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://cloudbuild.us-west8.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-west8" } ], "schemas": { "BatchCreateBitbucketServerConnectedRepositoriesRequest": { "properties": { "requests": { "type": "array", "description": "Required. Requests to connect Bitbucket Server repositories.", "items": { "$ref": "CreateBitbucketServerConnectedRepositoryRequest" } } }, "id": "BatchCreateBitbucketServerConnectedRepositoriesRequest", "description": "RPC request object accepted by BatchCreateBitbucketServerConnectedRepositories RPC method.", "type": "object" }, "ProcessAppManifestCallbackOperationMetadata": { "properties": { "githubEnterpriseConfig": { "type": "string", "description": "The resource name of the GitHubEnterprise to be created. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`." }, "createTime": { "type": "string", "description": "Time the operation was created.", "format": "google-datetime" }, "completeTime": { "format": "google-datetime", "type": "string", "description": "Time the operation was completed." } }, "type": "object", "id": "ProcessAppManifestCallbackOperationMetadata", "description": "Metadata for `ProcessAppManifestCallback` operation." }, "RepoSource": { "type": "object", "id": "RepoSource", "description": "Location of the source in a Google Cloud Source Repository.", "properties": { "repoName": { "description": "Required. Name of the Cloud Source Repository.", "type": "string" }, "tagName": { "description": "Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", "type": "string" }, "commitSha": { "type": "string", "description": "Explicit commit SHA to build." }, "projectId": { "type": "string", "description": "Optional. ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed." }, "substitutions": { "type": "object", "description": "Optional. Substitutions to use in a triggered build. Should only be used with RunBuildTrigger", "additionalProperties": { "type": "string" } }, "dir": { "type": "string", "description": "Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution." }, "branchName": { "description": "Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", "type": "string" }, "invertRegex": { "description": "Optional. Only trigger a build if the revision regex does NOT match the revision regex.", "type": "boolean" } } }, "GitHubEnterpriseSecrets": { "id": "GitHubEnterpriseSecrets", "description": "GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/.", "type": "object", "properties": { "webhookSecretVersionName": { "description": "The resource name for the webhook secret secret version in Secret Manager.", "type": "string" }, "oauthClientIdName": { "type": "string", "description": "The resource name for the OAuth client ID secret in Secret Manager.", "deprecated": true }, "oauthSecretName": { "type": "string", "description": "The resource name for the OAuth secret in Secret Manager.", "deprecated": true }, "privateKeyVersionName": { "description": "The resource name for the private key secret version.", "type": "string" }, "oauthSecretVersionName": { "description": "The resource name for the OAuth secret secret version in Secret Manager.", "type": "string" }, "privateKeyName": { "type": "string", "description": "The resource name for the private key secret.", "deprecated": true }, "webhookSecretName": { "deprecated": true, "type": "string", "description": "The resource name for the webhook secret in Secret Manager." }, "oauthClientIdVersionName": { "type": "string", "description": "The resource name for the OAuth client ID secret version in Secret Manager." } } }, "GoModule": { "id": "GoModule", "description": "Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file.", "type": "object", "properties": { "modulePath": { "type": "string", "description": "Optional. The Go module's \"module path\". e.g. example.com/foo/v2" }, "sourcePath": { "description": "Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage", "type": "string" }, "repositoryProjectId": { "type": "string", "description": "Optional. Project ID of the Artifact Registry repository. Defaults to the build project." }, "repositoryName": { "description": "Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo", "type": "string" }, "moduleVersion": { "description": "Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5", "type": "string" }, "repositoryLocation": { "type": "string", "description": "Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location." } } }, "Secrets": { "properties": { "secretManager": { "items": { "$ref": "SecretManagerSecret" }, "description": "Secrets in Secret Manager and associated secret environment variable.", "type": "array" }, "inline": { "items": { "$ref": "InlineSecret" }, "description": "Secrets encrypted with KMS key and the associated secret environment variable.", "type": "array" } }, "id": "Secrets", "description": "Secrets and secret environment variables.", "type": "object" }, "BuildStep": { "properties": { "secretEnv": { "items": { "type": "string" }, "description": "A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.", "type": "array" }, "status": { "enumDescriptions": [ "Status of the build is unknown.", "Build has been created and is pending execution and queuing. It has not been queued.", "Build or step is queued; work has not yet begun.", "Build or step is being executed.", "Build or step finished successfully.", "Build or step failed to complete successfully.", "Build or step failed due to an internal cause.", "Build or step took longer than was allowed.", "Build or step was canceled by a user.", "Build was enqueued for longer than the value of `queue_ttl`." ], "description": "Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.", "readOnly": true, "type": "string", "enum": [ "STATUS_UNKNOWN", "PENDING", "QUEUED", "WORKING", "SUCCESS", "FAILURE", "INTERNAL_ERROR", "TIMEOUT", "CANCELLED", "EXPIRED" ] }, "entrypoint": { "description": "Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.", "type": "string" }, "allowFailure": { "type": "boolean", "description": "Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failure_detail field." }, "results": { "items": { "$ref": "StepResult" }, "type": "array", "description": "Declaration of results for this build step." }, "pullTiming": { "$ref": "TimeSpan", "description": "Output only. Stores timing information for pulling this build step's builder image only.", "readOnly": true }, "timeout": { "format": "google-duration", "description": "Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.", "type": "string" }, "exitCode": { "type": "integer", "description": "Output only. Return code from running the step.", "readOnly": true, "format": "int32" }, "allowExitCodes": { "description": "Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.", "type": "array", "items": { "type": "integer", "format": "int32" } }, "script": { "type": "string", "description": "A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args." }, "automapSubstitutions": { "description": "Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption.", "type": "boolean" }, "dir": { "description": "Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.", "type": "string" }, "waitFor": { "description": "The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.", "type": "array", "items": { "type": "string" } }, "env": { "items": { "type": "string" }, "description": "A list of environment variable definitions to be used when running a step. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".", "type": "array" }, "volumes": { "items": { "$ref": "Volume" }, "type": "array", "description": "List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration." }, "timing": { "description": "Output only. Stores timing information for executing this build step.", "readOnly": true, "$ref": "TimeSpan" }, "name": { "description": "Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like \"ubuntu\", \"debian\", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.", "type": "string" }, "args": { "items": { "type": "string" }, "type": "array", "description": "A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments." }, "id": { "description": "Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.", "type": "string" } }, "id": "BuildStep", "description": "A step in the build pipeline.", "type": "object" }, "BatchCreateBitbucketServerConnectedRepositoriesResponseMetadata": { "properties": { "createTime": { "format": "google-datetime", "description": "Time the operation was created.", "type": "string" }, "config": { "type": "string", "description": "The name of the `BitbucketServerConfig` that added connected repositories. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{config}`" }, "completeTime": { "type": "string", "description": "Time the operation was completed.", "format": "google-datetime" } }, "id": "BatchCreateBitbucketServerConnectedRepositoriesResponseMetadata", "description": "Metadata for `BatchCreateBitbucketServerConnectedRepositories` operation.", "type": "object" }, "FailureInfo": { "type": "object", "id": "FailureInfo", "description": "A fatal problem encountered during the execution of the build.", "properties": { "type": { "enum": [ "FAILURE_TYPE_UNSPECIFIED", "PUSH_FAILED", "PUSH_IMAGE_NOT_FOUND", "PUSH_NOT_AUTHORIZED", "LOGGING_FAILURE", "USER_BUILD_STEP", "FETCH_SOURCE_FAILED" ], "enumDescriptions": [ "Type unspecified", "Unable to push the image to the repository.", "Final image not found.", "Unauthorized push of the final image.", "Backend logging failures. Should retry.", "A build step has failed.", "The source fetching has failed." ], "type": "string", "description": "The name of the failure." }, "detail": { "description": "Explains the failure issue in more detail using hard-coded text.", "type": "string" } } }, "UploadedGenericArtifact": { "id": "UploadedGenericArtifact", "description": "A generic artifact uploaded to Artifact Registry using the GenericArtifact directive.", "type": "object", "properties": { "artifactRegistryPackage": { "description": "Output only. Path to the artifact in Artifact Registry.", "readOnly": true, "type": "string" }, "artifactFingerprint": { "$ref": "FileHashes", "description": "Output only. The hash of the whole artifact.", "readOnly": true }, "pushTiming": { "$ref": "TimeSpan", "description": "Output only. Stores timing information for pushing the specified artifact.", "readOnly": true }, "uri": { "description": "Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1", "readOnly": true, "type": "string" }, "fileHashes": { "additionalProperties": { "$ref": "FileHashes" }, "type": "object", "description": "Output only. The file hashes that make up the generic artifact.", "readOnly": true } } }, "BuiltImage": { "properties": { "artifactRegistryPackage": { "description": "Output only. Path to the artifact in Artifact Registry.", "readOnly": true, "type": "string" }, "name": { "description": "Name used to push the container image to Google Container Registry, as presented to `docker push`.", "type": "string" }, "digest": { "description": "Docker Registry 2.0 digest.", "type": "string" }, "pushTiming": { "$ref": "TimeSpan", "description": "Output only. Stores timing information for pushing the specified image.", "readOnly": true }, "ociMediaType": { "enum": [ "OCI_MEDIA_TYPE_UNSPECIFIED", "IMAGE_MANIFEST", "IMAGE_INDEX" ], "enumDescriptions": [ "Default value.", "The artifact is an image manifest, which represents a single image with all its layers.", "The artifact is an image index, which can contain a list of image manifests." ], "type": "string", "description": "Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value.", "readOnly": true } }, "type": "object", "id": "BuiltImage", "description": "An image built by the pipeline." }, "CreateWorkerPoolOperationMetadata": { "id": "CreateWorkerPoolOperationMetadata", "description": "Metadata for the `CreateWorkerPool` operation.", "type": "object", "properties": { "workerPool": { "description": "The resource name of the `WorkerPool` to create. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Time the operation was created." }, "completeTime": { "format": "google-datetime", "description": "Time the operation was completed.", "type": "string" } } }, "GitHubEventsConfig": { "properties": { "installationId": { "format": "int64", "deprecated": true, "type": "string", "description": "The installationID that emits the GitHub event." }, "owner": { "type": "string", "description": "Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is \"googlecloudplatform\"." }, "pullRequest": { "description": "filter to match changes in pull requests.", "$ref": "PullRequestFilter" }, "push": { "description": "filter to match changes in refs like branches, tags.", "$ref": "PushFilter" }, "enterpriseConfigResourceName": { "description": "The resource name of the github enterprise config that should be applied to this installation. For example: \"projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}\"", "type": "string" }, "name": { "type": "string", "description": "Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is \"cloud-builders\"." } }, "type": "object", "id": "GitHubEventsConfig", "description": "GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received." }, "ReceiveTriggerWebhookResponse": { "type": "object", "id": "ReceiveTriggerWebhookResponse", "description": "ReceiveTriggerWebhookResponse [Experimental] is the response object for the ReceiveTriggerWebhook method.", "properties": {} }, "ListWorkerPoolsResponse": { "properties": { "workerPools": { "items": { "$ref": "WorkerPool" }, "type": "array", "description": "`WorkerPools` for the specified project." }, "nextPageToken": { "description": "Continuation token used to page through large result sets. Provide this value in a subsequent ListWorkerPoolsRequest to return the next page of results.", "type": "string" } }, "type": "object", "id": "ListWorkerPoolsResponse", "description": "Response containing existing `WorkerPools`." }, "ListBuildTriggersResponse": { "id": "ListBuildTriggersResponse", "description": "Response containing existing `BuildTriggers`.", "type": "object", "properties": { "triggers": { "type": "array", "description": "`BuildTriggers` for the project, sorted by `create_time` descending.", "items": { "$ref": "BuildTrigger" } }, "nextPageToken": { "type": "string", "description": "Token to receive the next page of results." } } }, "Empty": { "properties": {}, "id": "Empty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object" }, "Hash": { "properties": { "type": { "enum": [ "NONE", "SHA256", "MD5", "GO_MODULE_H1", "SHA512", "DIRSUM_SHA256" ], "enumDescriptions": [ "No hash requested.", "Use a sha256 hash.", "Use a md5 hash.", "Dirhash of a Go module's source code which is then hex-encoded.", "Use a sha512 hash.", "Use a dirsum_sha256 hash." ], "type": "string", "description": "The type of hash that was performed." }, "value": { "type": "string", "description": "The hash value.", "format": "byte" } }, "id": "Hash", "description": "Container message for hash values.", "type": "object" }, "BuildApproval": { "properties": { "state": { "description": "Output only. The state of this build's approval.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default enum type. This should not be used.", "Build approval is pending.", "Build approval has been approved.", "Build approval has been rejected.", "Build was cancelled while it was still pending approval." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "APPROVED", "REJECTED", "CANCELLED" ] }, "result": { "description": "Output only. Result of manual approval for this Build.", "readOnly": true, "$ref": "ApprovalResult" }, "config": { "description": "Output only. Configuration for manual approval of this build.", "readOnly": true, "$ref": "ApprovalConfig" } }, "type": "object", "id": "BuildApproval", "description": "BuildApproval describes a build's approval configuration, state, and result." }, "WorkerPool": { "properties": { "privatePoolV1Config": { "$ref": "PrivatePoolV1Config", "description": "Private Pool configuration." }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. Time at which the request to update the `WorkerPool` was received.", "readOnly": true }, "name": { "type": "string", "description": "Output only. The resource name of the `WorkerPool`, with format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. The value of `{worker_pool}` is provided by `worker_pool_id` in `CreateWorkerPool` request and the value of `{location}` is determined by the endpoint accessed.", "readOnly": true }, "uid": { "description": "Output only. A unique identifier for the `WorkerPool`.", "readOnly": true, "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. Time at which the request to create the `WorkerPool` was received.", "readOnly": true, "type": "string" }, "etag": { "description": "Output only. Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding.", "readOnly": true, "type": "string" }, "annotations": { "description": "User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.", "type": "object", "additionalProperties": { "type": "string" } }, "displayName": { "type": "string", "description": "A user-specified, human-readable name for the `WorkerPool`. If provided, this value must be 1-63 characters." }, "deleteTime": { "description": "Output only. Time at which the request to delete the `WorkerPool` was received.", "readOnly": true, "type": "string", "format": "google-datetime" }, "state": { "description": "Output only. `WorkerPool` state.", "readOnly": true, "type": "string", "enumDescriptions": [ "State of the `WorkerPool` is unknown.", "`WorkerPool` is being created.", "`WorkerPool` is running.", "`WorkerPool` is being deleted: cancelling builds and draining workers.", "`WorkerPool` is deleted.", "`WorkerPool` is being updated; new builds cannot be run." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "RUNNING", "DELETING", "DELETED", "UPDATING" ] } }, "id": "WorkerPool", "description": "Configuration for a `WorkerPool`. Cloud Build owns and maintains a pool of workers for general use and have no access to a project's private network. By default, builds submitted to Cloud Build will use a worker from this pool. If your build needs access to resources on a private network, create and use a `WorkerPool` to run your builds. Private `WorkerPool`s give your builds access to any single VPC network that you administer, including any on-prem resources connected to that VPC network. For an overview of private pools, see [Private pools overview](https://cloud.google.com/build/docs/private-pools/private-pools-overview).", "type": "object" }, "BuildStepResults": { "type": "object", "id": "BuildStepResults", "description": "Results for a build step.", "properties": { "results": { "type": "object", "description": "Results for a build step.", "additionalProperties": { "type": "string" } } } }, "ArtifactObjects": { "properties": { "paths": { "items": { "type": "string" }, "type": "array", "description": "Path globs used to match files in the build's workspace." }, "location": { "description": "Cloud Storage bucket and optional object path, in the form \"gs://bucket/path/to/somewhere/\". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.", "type": "string" }, "timing": { "description": "Output only. Stores timing information for pushing all artifact objects.", "readOnly": true, "$ref": "TimeSpan" } }, "type": "object", "id": "ArtifactObjects", "description": "Files in the workspace to upload to Cloud Storage upon successful completion of all build steps." }, "ApprovalConfig": { "properties": { "approvalRequired": { "description": "Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start.", "type": "boolean" } }, "type": "object", "id": "ApprovalConfig", "description": "ApprovalConfig describes configuration for manual approval of a build." }, "Status": { "id": "Status", "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).", "type": "object", "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": { "format": "int32", "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code." }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "DeveloperConnectEventConfig": { "properties": { "pullRequest": { "description": "Filter to match changes in pull requests.", "$ref": "PullRequestFilter" }, "push": { "$ref": "PushFilter", "description": "Filter to match changes in refs like branches and tags." }, "gitRepositoryLink": { "description": "Required. The Developer Connect Git repository link, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`.", "type": "string" }, "gitRepositoryLinkType": { "enum": [ "GIT_REPOSITORY_LINK_TYPE_UNSPECIFIED", "GITHUB", "GITHUB_ENTERPRISE", "GITLAB", "GITLAB_ENTERPRISE", "BITBUCKET_DATA_CENTER", "BITBUCKET_CLOUD" ], "description": "Output only. The type of DeveloperConnect GitRepositoryLink.", "readOnly": true, "type": "string", "enumDescriptions": [ "If unspecified, GitRepositoryLinkType defaults to GITHUB.", "The SCM repo is GITHUB.", "The SCM repo is GITHUB_ENTERPRISE.", "The SCM repo is GITLAB.", "The SCM repo is GITLAB_ENTERPRISE.", "The SCM repo is BITBUCKET_DATA_CENTER.", "The SCM repo is BITBUCKET_CLOUD." ] } }, "id": "DeveloperConnectEventConfig", "description": "The configuration of a trigger that creates a build whenever an event from the DeveloperConnect API is received.", "type": "object" }, "UploadedPythonPackage": { "id": "UploadedPythonPackage", "description": "Artifact uploaded using the PythonPackage directive.", "type": "object", "properties": { "pushTiming": { "$ref": "TimeSpan", "description": "Output only. Stores timing information for pushing the specified artifact.", "readOnly": true }, "artifactRegistryPackage": { "description": "Output only. Path to the artifact in Artifact Registry.", "readOnly": true, "type": "string" }, "uri": { "description": "URI of the uploaded artifact.", "type": "string" }, "fileHashes": { "description": "Hash types and values of the Python Artifact.", "$ref": "FileHashes" } } }, "DefaultServiceAccount": { "type": "object", "id": "DefaultServiceAccount", "description": "The default service account used for `Builds`.", "properties": { "serviceAccountEmail": { "type": "string", "description": "Output only. The email address of the service account identity that will be used for a build by default. This is returned in the format `projects/{project}/serviceAccounts/{service_account}` where `{service_account}` could be the legacy Cloud Build SA, in the format [PROJECT_NUMBER]@cloudbuild.gserviceaccount.com or the Compute SA, in the format [PROJECT_NUMBER]-compute@developer.gserviceaccount.com. If no service account will be used by default, this will be empty.", "readOnly": true }, "name": { "type": "string", "description": "Identifier. Format: `projects/{project}/locations/{location}/defaultServiceAccount`." } } }, "Oci": { "properties": { "file": { "type": "string", "description": "Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar" }, "tags": { "type": "array", "description": "Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0", "items": { "type": "string" } }, "registryPath": { "type": "string", "description": "Required. Registry path to upload the container to. e.g. us-east1-docker.pkg.dev/my-project/my-repo/my-image" } }, "type": "object", "id": "Oci", "description": "OCI image to upload to Artifact Registry upon successful completion of all build steps." }, "Build": { "properties": { "status": { "enum": [ "STATUS_UNKNOWN", "PENDING", "QUEUED", "WORKING", "SUCCESS", "FAILURE", "INTERNAL_ERROR", "TIMEOUT", "CANCELLED", "EXPIRED" ], "description": "Output only. Status of the build.", "readOnly": true, "type": "string", "enumDescriptions": [ "Status of the build is unknown.", "Build has been created and is pending execution and queuing. It has not been queued.", "Build or step is queued; work has not yet begun.", "Build or step is being executed.", "Build or step finished successfully.", "Build or step failed to complete successfully.", "Build or step failed due to an internal cause.", "Build or step took longer than was allowed.", "Build or step was canceled by a user.", "Build was enqueued for longer than the value of `queue_ttl`." ] }, "artifacts": { "$ref": "Artifacts", "description": "Artifacts produced by the build that should be uploaded upon successful completion of all build steps." }, "failureInfo": { "description": "Output only. Contains information about the build when status=FAILURE.", "readOnly": true, "$ref": "FailureInfo" }, "startTime": { "description": "Output only. Time at which execution of the build was started.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "type": "string", "description": "Output only. Time at which the request to create the build was received.", "readOnly": true, "format": "google-datetime" }, "logsBucket": { "description": "Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.", "type": "string" }, "secrets": { "items": { "$ref": "Secret" }, "description": "Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use `available_secrets` to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets", "type": "array" }, "buildTriggerId": { "description": "Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.", "readOnly": true, "type": "string" }, "timing": { "type": "object", "description": "Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included.", "readOnly": true, "additionalProperties": { "$ref": "TimeSpan" } }, "serviceAccount": { "description": "IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. ", "type": "string" }, "options": { "$ref": "BuildOptions", "description": "Special options for this build." }, "statusDetail": { "type": "string", "description": "Output only. Customer-readable message about the current status.", "readOnly": true }, "tags": { "items": { "type": "string" }, "description": "Tags for annotation of a `Build`. These are not docker tags.", "type": "array" }, "approval": { "description": "Output only. Describes this build's approval configuration, status, and result.", "readOnly": true, "$ref": "BuildApproval" }, "results": { "description": "Output only. Results of the build.", "readOnly": true, "$ref": "Results" }, "substitutions": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Substitutions data for `Build` resource." }, "source": { "description": "Optional. The location of the source files to build.", "$ref": "Source" }, "timeout": { "type": "string", "description": "Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is 60 minutes.", "format": "google-duration" }, "warnings": { "type": "array", "description": "Output only. Non-fatal problems encountered during the execution of the build.", "readOnly": true, "items": { "$ref": "Warning" } }, "finishTime": { "type": "string", "description": "Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.", "readOnly": true, "format": "google-datetime" }, "projectId": { "type": "string", "description": "Output only. ID of the project.", "readOnly": true }, "gitConfig": { "$ref": "GitConfig", "description": "Optional. Configuration for git operations." }, "logUrl": { "description": "Output only. URL to logs for this build in Google Cloud Console.", "readOnly": true, "type": "string" }, "steps": { "type": "array", "description": "Required. The operations to be performed on the workspace.", "items": { "$ref": "BuildStep" } }, "images": { "items": { "type": "string" }, "description": "A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`.", "type": "array" }, "name": { "type": "string", "description": "Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service.", "readOnly": true }, "sourceProvenance": { "description": "Output only. A permanent fixed identifier for source.", "readOnly": true, "$ref": "SourceProvenance" }, "availableSecrets": { "description": "Secrets and secret environment variables.", "$ref": "Secrets" }, "id": { "type": "string", "description": "Output only. Unique identifier of the build.", "readOnly": true }, "queueTtl": { "format": "google-duration", "type": "string", "description": "TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time." }, "dependencies": { "type": "array", "description": "Optional. Dependencies that the Cloud Build worker will fetch before executing user steps.", "items": { "$ref": "Dependency" } } }, "id": "Build", "description": "A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.", "type": "object" }, "NetworkConfig": { "id": "NetworkConfig", "description": "Defines the network configuration for the pool.", "type": "object", "properties": { "egressOption": { "description": "Option to configure network egress for the workers.", "type": "string", "enumDescriptions": [ "If set, defaults to PUBLIC_EGRESS.", "If set, workers are created without any public address, which prevents network egress to public IPs unless a network proxy is configured.", "If set, workers are created with a public address which allows for public internet egress." ], "enum": [ "EGRESS_OPTION_UNSPECIFIED", "NO_PUBLIC_EGRESS", "PUBLIC_EGRESS" ] }, "peeredNetwork": { "description": "Required. Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to `WorkerPool.project_id` on the service producer network. Must be in the format `projects/{project}/global/networks/{network}`, where `{project}` is a project number, such as `12345`, and `{network}` is the name of a VPC network in the project. See [Understanding network configuration options](https://cloud.google.com/build/docs/private-pools/set-up-private-pool-environment)", "type": "string" }, "peeredNetworkIpRange": { "type": "string", "description": "Immutable. Subnet IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a prefix size of 29 bits. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used." } } }, "WorkerConfig": { "type": "object", "id": "WorkerConfig", "description": "Defines the configuration to be used for creating workers in the pool.", "properties": { "diskSizeGb": { "format": "int64", "type": "string", "description": "Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 4000. If `0` is specified, Cloud Build will use a standard disk size." }, "enableNestedVirtualization": { "type": "boolean", "description": "Optional. Enable nested virtualization on the worker, if supported by the machine type. By default, nested virtualization is disabled." }, "machineType": { "type": "string", "description": "Optional. Machine type of a worker, such as `e2-medium`. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). If left blank, Cloud Build will use a sensible default." } } }, "GitSourceDependency": { "properties": { "fetchTags": { "type": "boolean", "description": "Optional. True if remote tags should be fetched too (default false). Note: when depth is 1 (default), git fetch only retrieves tags pointing to commits within the shallow boundary. Set depth to -1 to fetch all historical tags." }, "recurseSubmodules": { "description": "Optional. True if submodules should be fetched too (default false).", "type": "boolean" }, "destPath": { "type": "string", "description": "Required. Where should the files be placed on the worker." }, "repository": { "$ref": "GitSourceRepository", "description": "Required. The kind of repo (url or dev connect)." }, "depth": { "description": "Optional. How much history should be fetched for the build (default 1, -1 for all history).", "type": "string", "format": "int64" }, "revision": { "description": "Required. The revision that we will fetch the repo at.", "type": "string" } }, "id": "GitSourceDependency", "description": "Represents a git repository as a build dependency.", "type": "object" }, "ListBuildsResponse": { "properties": { "builds": { "items": { "$ref": "Build" }, "description": "Builds will be sorted by `create_time`, descending.", "type": "array" }, "nextPageToken": { "description": "Token to receive the next page of results. This will be absent if the end of the response list has been reached.", "type": "string" } }, "type": "object", "id": "ListBuildsResponse", "description": "Response including listed builds." }, "SourceProvenance": { "properties": { "resolvedConnectedRepository": { "description": "Output only. A copy of the build's `source.connected_repository`, if exists, with any revisions resolved.", "readOnly": true, "$ref": "ConnectedRepository" }, "fileHashes": { "description": "Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file.", "readOnly": true, "type": "object", "additionalProperties": { "$ref": "FileHashes" } }, "resolvedStorageSource": { "$ref": "StorageSource", "description": "A copy of the build's `source.storage_source`, if exists, with any generations resolved." }, "resolvedRepoSource": { "description": "A copy of the build's `source.repo_source`, if exists, with any revisions resolved.", "$ref": "RepoSource" }, "resolvedGitSource": { "$ref": "GitSource", "description": "Output only. A copy of the build's `source.git_source`, if exists, with any revisions resolved.", "readOnly": true }, "resolvedStorageSourceManifest": { "description": "A copy of the build's `source.storage_source_manifest`, if exists, with any revisions resolved. This feature is in Preview.", "$ref": "StorageSourceManifest" } }, "type": "object", "id": "SourceProvenance", "description": "Provenance of the source. Ways to find the original source, or verify that some source was used for this build." }, "StepResult": { "properties": { "attestationContent": { "description": "Optional. The content of the attestation to be generated.", "type": "string" }, "attestationType": { "type": "string", "description": "Optional. The type of attestation to be generated." }, "name": { "type": "string", "description": "Required. The name of the result." } }, "id": "StepResult", "description": "StepResult is the declaration of a result for a build step.", "type": "object" }, "DeleteGitHubEnterpriseConfigOperationMetadata": { "properties": { "createTime": { "format": "google-datetime", "description": "Time the operation was created.", "type": "string" }, "githubEnterpriseConfig": { "type": "string", "description": "The resource name of the GitHubEnterprise to be deleted. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`." }, "completeTime": { "format": "google-datetime", "description": "Time the operation was completed.", "type": "string" } }, "id": "DeleteGitHubEnterpriseConfigOperationMetadata", "description": "Metadata for `DeleteGitHubEnterpriseConfig` operation.", "type": "object" }, "DeleteWorkerPoolOperationMetadata": { "properties": { "completeTime": { "type": "string", "description": "Time the operation was completed.", "format": "google-datetime" }, "workerPool": { "description": "The resource name of the `WorkerPool` being deleted. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`.", "type": "string" }, "createTime": { "description": "Time the operation was created.", "type": "string", "format": "google-datetime" } }, "type": "object", "id": "DeleteWorkerPoolOperationMetadata", "description": "Metadata for the `DeleteWorkerPool` operation." }, "BitbucketServerConfig": { "properties": { "webhookKey": { "description": "Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config.", "readOnly": true, "type": "string" }, "name": { "type": "string", "description": "Identifier. The resource name for the config." }, "hostUri": { "description": "Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Time when the config was created." }, "username": { "description": "Username of the account Cloud Build will use on Bitbucket Server.", "type": "string" }, "apiKey": { "description": "Required. Immutable. API Key that will be attached to webhook. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig.", "type": "string" }, "peeredNetwork": { "description": "Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project.", "type": "string" }, "sslCa": { "type": "string", "description": "Optional. SSL certificate to use for requests to Bitbucket Server. The format should be PEM format but the extension can be one of .pem, .cer, or .crt." }, "peeredNetworkIpRange": { "type": "string", "description": "Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set." }, "secrets": { "description": "Required. Secret Manager secrets needed by the config.", "$ref": "BitbucketServerSecrets" }, "connectedRepositories": { "type": "array", "description": "Output only. Connected Bitbucket Server repositories for this config.", "readOnly": true, "items": { "$ref": "BitbucketServerRepositoryId" } } }, "id": "BitbucketServerConfig", "description": "BitbucketServerConfig represents the configuration for a Bitbucket Server.", "type": "object" }, "Artifacts": { "type": "object", "id": "Artifacts", "description": "Artifacts produced by a build that should be uploaded upon successful completion of all build steps.", "properties": { "objects": { "$ref": "ArtifactObjects", "description": "A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE." }, "npmPackages": { "type": "array", "description": "A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE.", "items": { "$ref": "NpmPackage" } }, "images": { "type": "array", "description": "A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.", "items": { "type": "string" } }, "goModules": { "items": { "$ref": "GoModule" }, "type": "array", "description": "Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE." }, "oci": { "items": { "$ref": "Oci" }, "description": "Optional. A list of OCI images to be uploaded to Artifact Registry upon successful completion of all build steps. OCI images in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any images fail to be pushed, the build is marked FAILURE.", "type": "array" }, "mavenArtifacts": { "type": "array", "description": "A list of Maven artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. Artifacts in the workspace matching specified paths globs will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any artifacts fail to be pushed, the build is marked FAILURE.", "items": { "$ref": "MavenArtifact" } }, "pythonPackages": { "type": "array", "description": "A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE.", "items": { "$ref": "PythonPackage" } }, "genericArtifacts": { "items": { "$ref": "GenericArtifact" }, "description": "Optional. A list of generic artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. If any artifacts fail to be pushed, the build is marked FAILURE.", "type": "array" } } }, "UpdateWorkerPoolOperationMetadata": { "id": "UpdateWorkerPoolOperationMetadata", "description": "Metadata for the `UpdateWorkerPool` operation.", "type": "object", "properties": { "workerPool": { "description": "The resource name of the `WorkerPool` being updated. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Time the operation was created." }, "completeTime": { "type": "string", "description": "Time the operation was completed.", "format": "google-datetime" } } }, "InlineSecret": { "id": "InlineSecret", "description": "Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.", "type": "object", "properties": { "kmsKeyName": { "description": "Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/*", "type": "string" }, "envMap": { "type": "object", "description": "Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.", "additionalProperties": { "type": "string", "format": "byte" } } } }, "PrivateServiceConnect": { "properties": { "networkAttachment": { "description": "Required. Immutable. The network attachment that the worker network interface is peered to. Must be in the format `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. The region of network attachment must be the same as the worker pool. See [Network Attachments](https://cloud.google.com/vpc/docs/about-network-attachments)", "type": "string" }, "publicIpAddressDisabled": { "description": "Required. Immutable. Disable public IP on the primary network interface. If true, workers are created without any public address, which prevents network egress to public IPs unless a network proxy is configured. If false, workers are created with a public address which allows for public internet egress. The public address only applies to traffic through the primary network interface. If `route_all_traffic` is set to true, all traffic will go through the non-primary network interface, this boolean has no effect.", "type": "boolean" }, "routeAllTraffic": { "description": "Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route RFC 1918 (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16) and RFC 6598 (100.64.0.0/10) through PSC interface.", "type": "boolean" } }, "id": "PrivateServiceConnect", "description": "Defines the Private Service Connect network configuration for the pool.", "type": "object" }, "OperationMetadata": { "properties": { "verb": { "type": "string", "description": "Output only. Name of the verb executed by the operation.", "readOnly": true }, "apiVersion": { "description": "Output only. API version used to start the operation.", "readOnly": true, "type": "string" }, "endTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running.", "readOnly": true }, "cancelRequested": { "type": "boolean", "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "readOnly": true }, "statusDetail": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "target": { "type": "string", "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true } }, "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation.", "type": "object" }, "BitbucketServerRepository": { "properties": { "description": { "description": "Description of the repository.", "type": "string" }, "browseUri": { "type": "string", "description": "Link to the browse repo page on the Bitbucket Server instance." }, "name": { "type": "string", "description": "The resource name of the repository." }, "repoId": { "$ref": "BitbucketServerRepositoryId", "description": "Identifier for a repository hosted on a Bitbucket Server." }, "displayName": { "type": "string", "description": "Display name of the repository." } }, "type": "object", "id": "BitbucketServerRepository", "description": "BitbucketServerRepository represents a repository hosted on a Bitbucket Server." }, "Warning": { "type": "object", "id": "Warning", "description": "A non-fatal problem encountered during the execution of the build.", "properties": { "text": { "description": "Explanation of the warning generated.", "type": "string" }, "priority": { "description": "The priority for this warning.", "type": "string", "enumDescriptions": [ "Should not be used.", "e.g. deprecation warnings and alternative feature highlights.", "e.g. automated detection of possible issues with the build.", "e.g. alerts that a feature used in the build is pending removal" ], "enum": [ "PRIORITY_UNSPECIFIED", "INFO", "WARNING", "ALERT" ] } } }, "StorageSource": { "type": "object", "id": "StorageSource", "description": "Location of the source in an archive file in Cloud Storage.", "properties": { "object": { "description": "Required. Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.", "type": "string" }, "generation": { "format": "int64", "type": "string", "description": "Optional. Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used." }, "bucket": { "description": "Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", "type": "string" }, "sourceFetcher": { "type": "string", "description": "Optional. Option to specify the tool to fetch the source file for the build.", "enum": [ "SOURCE_FETCHER_UNSPECIFIED", "GSUTIL", "GCS_FETCHER" ], "enumDescriptions": [ "Unspecified defaults to GSUTIL.", "Use the \"gsutil\" tool to download the source file.", "Use the Cloud Storage Fetcher tool to download the source file." ] } } }, "Secret": { "properties": { "kmsKeyName": { "type": "string", "description": "Cloud KMS key name to use to decrypt these envs." }, "secretEnv": { "type": "object", "description": "Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.", "additionalProperties": { "type": "string", "format": "byte" } } }, "id": "Secret", "description": "Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with `secret`. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.", "type": "object" }, "ListBitbucketServerRepositoriesResponse": { "properties": { "bitbucketServerRepositories": { "description": "List of Bitbucket Server repositories.", "type": "array", "items": { "$ref": "BitbucketServerRepository" } }, "nextPageToken": { "type": "string", "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "id": "ListBitbucketServerRepositoriesResponse", "description": "RPC response object returned by the ListBitbucketServerRepositories RPC method.", "type": "object" }, "UploadedNpmPackage": { "id": "UploadedNpmPackage", "description": "An npm package uploaded to Artifact Registry using the NpmPackage directive.", "type": "object", "properties": { "uri": { "description": "URI of the uploaded npm package.", "type": "string" }, "fileHashes": { "description": "Hash types and values of the npm package.", "$ref": "FileHashes" }, "pushTiming": { "description": "Output only. Stores timing information for pushing the specified artifact.", "readOnly": true, "$ref": "TimeSpan" }, "artifactRegistryPackage": { "type": "string", "description": "Output only. Path to the artifact in Artifact Registry.", "readOnly": true } } }, "Volume": { "id": "Volume", "description": "Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.", "type": "object", "properties": { "name": { "description": "Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.", "type": "string" }, "path": { "description": "Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.", "type": "string" } } }, "GitFileSource": { "type": "object", "id": "GitFileSource", "description": "GitFileSource describes a file within a (possibly remote) code repository.", "properties": { "bitbucketServerConfig": { "type": "string", "description": "The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`." }, "path": { "description": "The path of the file, with the repo root as the root of the path.", "type": "string" }, "uri": { "description": "The URI of the repo. Either uri or repository can be specified. If unspecified, the repo from which the trigger invocation originated is assumed to be the repo from which to read the specified path.", "type": "string" }, "githubEnterpriseConfig": { "type": "string", "description": "The full resource name of the github enterprise config. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`. `projects/{project}/githubEnterpriseConfigs/{id}`." }, "repoType": { "type": "string", "description": "See RepoType above.", "enum": [ "UNKNOWN", "CLOUD_SOURCE_REPOSITORIES", "GITHUB", "BITBUCKET_SERVER", "GITLAB", "BITBUCKET_CLOUD" ], "enumDescriptions": [ "The default, unknown repo type. Don't use it, instead use one of the other repo types.", "A Google Cloud Source Repositories-hosted repo.", "A GitHub-hosted repo not necessarily on \"github.com\" (i.e. GitHub Enterprise).", "A Bitbucket Server-hosted repo.", "A GitLab-hosted repo.", "A Bitbucket Cloud-hosted repo." ] }, "revision": { "description": "The branch, tag, arbitrary ref, or SHA version of the repo to use when resolving the filename (optional). This field respects the same syntax/resolution as described here: https://git-scm.com/docs/gitrevisions If unspecified, the revision from which the trigger invocation originated is assumed to be the revision from which to read the specified path.", "type": "string" }, "repository": { "description": "The fully qualified resource name of the Repos API repository. Either URI or repository can be specified. If unspecified, the repo from which the trigger invocation originated is assumed to be the repo from which to read the specified path.", "type": "string" } } }, "Dependency": { "properties": { "empty": { "type": "boolean", "description": "If set to true disable all dependency fetching (ignoring the default source as well)." }, "genericArtifact": { "$ref": "GenericArtifactDependency", "description": "Represents a generic artifact as a build dependency." }, "gitSource": { "$ref": "GitSourceDependency", "description": "Represents a git repository as a build dependency." } }, "id": "Dependency", "description": "A dependency that the Cloud Build worker will fetch before executing user steps.", "type": "object" }, "MavenArtifact": { "type": "object", "id": "MavenArtifact", "description": "A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.", "properties": { "artifactId": { "description": "Maven `artifactId` value used when uploading the artifact to Artifact Registry.", "type": "string" }, "deployFolder": { "description": "Optional. Path to a folder containing the files to upload to Artifact Registry. This can be either an absolute path, e.g. `/workspace/my-app/target/`, or a relative path from /workspace, e.g. `my-app/target/`. This field is mutually exclusive with the `path` field.", "type": "string" }, "groupId": { "type": "string", "description": "Maven `groupId` value used when uploading the artifact to Artifact Registry." }, "path": { "type": "string", "description": "Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar." }, "version": { "description": "Maven `version` value used when uploading the artifact to Artifact Registry.", "type": "string" }, "repository": { "description": "Artifact Registry repository, in the form \"https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY\" Artifact in the workspace specified by path will be uploaded to Artifact Registry with this location as a prefix.", "type": "string" } } }, "ApproveBuildRequest": { "type": "object", "id": "ApproveBuildRequest", "description": "Request to approve or reject a pending build.", "properties": { "approvalResult": { "description": "Approval decision and metadata.", "$ref": "ApprovalResult" } } }, "ApprovalResult": { "id": "ApprovalResult", "description": "ApprovalResult describes the decision and associated metadata of a manual approval of a build.", "type": "object", "properties": { "approverAccount": { "type": "string", "description": "Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.", "readOnly": true }, "comment": { "description": "Optional. An optional comment for this manual approval result.", "type": "string" }, "url": { "type": "string", "description": "Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build." }, "decision": { "enum": [ "DECISION_UNSPECIFIED", "APPROVED", "REJECTED" ], "enumDescriptions": [ "Default enum type. This should not be used.", "Build is approved.", "Build is rejected." ], "type": "string", "description": "Required. The decision of this manual approval." }, "approvalTime": { "type": "string", "description": "Output only. The time when the approval decision was made.", "readOnly": true, "format": "google-datetime" } } }, "PushFilter": { "properties": { "branch": { "type": "string", "description": "Regexes matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax" }, "tag": { "description": "Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", "type": "string" }, "invertRegex": { "description": "When true, only trigger a build if the revision regex does NOT match the git_ref regex.", "type": "boolean" } }, "id": "PushFilter", "description": "Push contains filter properties for matching GitHub git pushes.", "type": "object" }, "CreateBitbucketServerConnectedRepositoryRequest": { "properties": { "parent": { "type": "string", "description": "Required. The name of the `BitbucketServerConfig` that added connected repository. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{config}`" }, "bitbucketServerConnectedRepository": { "$ref": "BitbucketServerConnectedRepository", "description": "Required. The Bitbucket Server repository to connect." } }, "id": "CreateBitbucketServerConnectedRepositoryRequest", "description": "Request to connect a repository from a connected Bitbucket Server host.", "type": "object" }, "ConnectedRepository": { "properties": { "revision": { "type": "string", "description": "Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref." }, "repository": { "type": "string", "description": "Required. Name of the Google Cloud Build repository, formatted as `projects/*/locations/*/connections/*/repositories/*`." }, "dir": { "description": "Optional. Directory, relative to the source root, in which to run the build.", "type": "string" } }, "type": "object", "id": "ConnectedRepository", "description": "Location of the source in a 2nd-gen Google Cloud Build repository resource." }, "PullRequestFilter": { "type": "object", "id": "PullRequestFilter", "description": "PullRequestFilter contains filter properties for matching GitHub Pull Requests.", "properties": { "commentControl": { "enum": [ "COMMENTS_DISABLED", "COMMENTS_ENABLED", "COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY" ], "enumDescriptions": [ "Do not require `/gcbrun` comments from a user with repository write permission or above on pull requests before builds are triggered. Comments that contain `/gcbrun` will still fire builds so this should be thought of as comments not required.", "Builds will only fire in response to pull requests if: 1. The pull request author has repository write permission or above and `/gcbrun` is in the PR description. 2. A user with repository writer permissions or above comments `/gcbrun` on a pull request authored by any user.", "Builds will only fire in response to pull requests if: 1. The pull request author is a repository writer or above. 2. If the author does not have write permissions, a user with write permissions or above must comment `/gcbrun` in order to fire a build." ], "type": "string", "description": "If CommentControl is enabled, depending on the setting, builds may not fire until a repository writer comments `/gcbrun` on a pull request or `/gcbrun` is in the pull request description. Only PR comments that contain `/gcbrun` will trigger builds. If CommentControl is set to disabled, comments with `/gcbrun` from a user with repository write permission or above will still trigger builds to run." }, "invertRegex": { "description": "If true, branches that do NOT match the git_ref will trigger a build.", "type": "boolean" }, "branch": { "description": "Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", "type": "string" } } }, "GitHubEnterpriseConfig": { "properties": { "appId": { "type": "string", "description": "Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.", "format": "int64" }, "secrets": { "description": "Optional. Names of secrets in Secret Manager.", "$ref": "GitHubEnterpriseSecrets" }, "hostUrl": { "description": "The URL of the github enterprise host the configuration is for.", "type": "string" }, "displayName": { "type": "string", "description": "Optional. Name to display for this config." }, "name": { "type": "string", "description": "Identifier. The full resource name for the GitHubEnterpriseConfig For example: \"projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}\"" }, "createTime": { "type": "string", "description": "Output only. Time when the installation was associated with the project.", "readOnly": true, "format": "google-datetime" }, "webhookKey": { "type": "string", "description": "The key that should be attached to webhook calls to the ReceiveWebhook endpoint." }, "sslCa": { "description": "Optional. SSL certificate to use for requests to GitHub Enterprise.", "type": "string" }, "peeredNetwork": { "type": "string", "description": "Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project." } }, "type": "object", "id": "GitHubEnterpriseConfig", "description": "GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise server." }, "NpmPackage": { "properties": { "repository": { "description": "Artifact Registry repository, in the form \"https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY\" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix.", "type": "string" }, "packagePath": { "type": "string", "description": "Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified." } }, "type": "object", "id": "NpmPackage", "description": "Npm package to upload to Artifact Registry upon successful completion of all build steps." }, "BuildOptions": { "type": "object", "id": "BuildOptions", "description": "Optional arguments to enable specific features of builds.", "properties": { "logging": { "enum": [ "LOGGING_UNSPECIFIED", "LEGACY", "GCS_ONLY", "STACKDRIVER_ONLY", "CLOUD_LOGGING_ONLY", "NONE" ], "type": "string", "description": "Option to specify the logging mode, which determines if and where build logs are stored.", "enumDeprecated": [ false, false, false, true, false, false ], "enumDescriptions": [ "The service determines the logging mode. The default is `LEGACY`. Do not rely on the default logging behavior as it may change in the future.", "Build logs are stored in Cloud Logging and Cloud Storage.", "Build logs are stored in Cloud Storage.", "This option is the same as CLOUD_LOGGING_ONLY.", "Build logs are stored in Cloud Logging. Selecting this option will not allow [logs streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).", "Turn off all logging. No build logs will be captured." ] }, "logStreamingOption": { "type": "string", "description": "Option to define build log streaming behavior to Cloud Storage.", "enum": [ "STREAM_DEFAULT", "STREAM_ON", "STREAM_OFF" ], "enumDescriptions": [ "Service may automatically determine build log streaming behavior.", "Build logs should be streamed to Cloud Storage.", "Build logs should not be streamed to Cloud Storage; they will be written when the build is completed." ] }, "workerPool": { "deprecated": true, "type": "string", "description": "This field deprecated; please use `pool.name` instead." }, "secretEnv": { "description": "A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build.", "type": "array", "items": { "type": "string" } }, "requestedVerifyOption": { "type": "string", "description": "Requested verifiability options.", "enum": [ "NOT_VERIFIED", "VERIFIED" ], "enumDescriptions": [ "Not a verifiable build (the default).", "Build must be verified." ] }, "dynamicSubstitutions": { "type": "boolean", "description": "Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file." }, "automapSubstitutions": { "description": "Option to include built-in and custom substitutions as env variables for all build steps.", "type": "boolean" }, "diskSizeGb": { "format": "int64", "description": "Requested disk size for the VM that runs the build. Note that this is *NOT* \"disk free\"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error.", "type": "string" }, "sourceProvenanceHash": { "items": { "enumDescriptions": [ "No hash requested.", "Use a sha256 hash.", "Use a md5 hash.", "Dirhash of a Go module's source code which is then hex-encoded.", "Use a sha512 hash.", "Use a dirsum_sha256 hash." ], "enum": [ "NONE", "SHA256", "MD5", "GO_MODULE_H1", "SHA512", "DIRSUM_SHA256" ], "type": "string" }, "type": "array", "description": "Requested hash for SourceProvenance." }, "volumes": { "items": { "$ref": "Volume" }, "description": "Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.", "type": "array" }, "defaultLogsBucketBehavior": { "enum": [ "DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED", "REGIONAL_USER_OWNED_BUCKET", "LEGACY_BUCKET" ], "enumDescriptions": [ "Unspecified.", "Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project.", "Bucket is located in a Google-owned project and is not regionalized." ], "type": "string", "description": "Optional. Option to specify how default logs buckets are setup." }, "pubsubTopic": { "description": "Optional. Option to specify the Pub/Sub topic to receive build status updates.", "type": "string" }, "env": { "type": "array", "description": "A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".", "items": { "type": "string" } }, "enableStructuredLogging": { "description": "Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.", "type": "boolean" }, "machineType": { "enumDescriptions": [ "Standard machine type.", "Highcpu machine with 8 CPUs.", "Highcpu machine with 32 CPUs.", "Highcpu e2 machine with 8 CPUs.", "Highcpu e2 machine with 32 CPUs.", "E2 machine with 1 CPU.", "E2 machine with 2 CPUs." ], "enumDeprecated": [ false, true, true, false, false, false, false ], "description": "Compute Engine machine type on which to run the build.", "type": "string", "enum": [ "UNSPECIFIED", "N1_HIGHCPU_8", "N1_HIGHCPU_32", "E2_HIGHCPU_8", "E2_HIGHCPU_32", "E2_MEDIUM", "E2_STANDARD_2" ] }, "pool": { "$ref": "PoolOption", "description": "Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information." }, "substitutionOption": { "type": "string", "description": "Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file.", "enum": [ "MUST_MATCH", "ALLOW_LOOSE" ], "enumDescriptions": [ "Fails the build if error in substitutions checks, like missing a substitution in the template or in the map.", "Do not fail the build if error in substitutions checks." ] } } }, "ListBitbucketServerConfigsResponse": { "properties": { "nextPageToken": { "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "bitbucketServerConfigs": { "items": { "$ref": "BitbucketServerConfig" }, "description": "A list of BitbucketServerConfigs", "type": "array" } }, "id": "ListBitbucketServerConfigsResponse", "description": "RPC response object returned by ListBitbucketServerConfigs RPC method.", "type": "object" }, "HttpBody": { "id": "HttpBody", "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", "type": "object", "properties": { "data": { "format": "byte", "type": "string", "description": "The HTTP request/response body as raw binary." }, "extensions": { "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "type": "array", "description": "Application specific response metadata. Must be set in the first response for streaming APIs." }, "contentType": { "type": "string", "description": "The HTTP Content-Type header value specifying the content type of the body." } } }, "TimeSpan": { "id": "TimeSpan", "description": "Start and end times for a build execution phase.", "type": "object", "properties": { "startTime": { "description": "Start of time span.", "type": "string", "format": "google-datetime" }, "endTime": { "format": "google-datetime", "description": "End of time span.", "type": "string" } } }, "Results": { "id": "Results", "description": "Artifacts created by the build pipeline.", "type": "object", "properties": { "images": { "type": "array", "description": "Container images that were built as a part of the build.", "items": { "$ref": "BuiltImage" } }, "artifactManifest": { "description": "Path to the artifact manifest for non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.", "type": "string" }, "numArtifacts": { "description": "Number of non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.", "type": "string", "format": "int64" }, "npmPackages": { "description": "Npm packages uploaded to Artifact Registry at the end of the build.", "type": "array", "items": { "$ref": "UploadedNpmPackage" } }, "mavenArtifacts": { "type": "array", "description": "Maven artifacts uploaded to Artifact Registry at the end of the build.", "items": { "$ref": "UploadedMavenArtifact" } }, "genericArtifacts": { "type": "array", "description": "Output only. Generic artifacts uploaded to Artifact Registry at the end of the build.", "readOnly": true, "items": { "$ref": "UploadedGenericArtifact" } }, "goModules": { "items": { "$ref": "UploadedGoModule" }, "type": "array", "description": "Optional. Go module artifacts uploaded to Artifact Registry at the end of the build." }, "buildStepOutputs": { "type": "array", "description": "List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted.", "items": { "type": "string", "format": "byte" } }, "buildStepResults": { "additionalProperties": { "$ref": "BuildStepResults" }, "type": "object", "description": "Results for build steps. step_id -\u003e " }, "buildStepImages": { "type": "array", "description": "List of build step digests, in the order corresponding to build step indices.", "items": { "type": "string" } }, "artifactTiming": { "description": "Time to push all non-container artifacts to Cloud Storage.", "$ref": "TimeSpan" }, "pythonPackages": { "items": { "$ref": "UploadedPythonPackage" }, "type": "array", "description": "Python artifacts uploaded to Artifact Registry at the end of the build." } } }, "WebhookConfig": { "id": "WebhookConfig", "description": "WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL.", "type": "object", "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "OK", "SECRET_DELETED" ], "enumDescriptions": [ "The webhook auth configuration not been checked.", "The auth configuration is properly setup.", "The secret provided in auth_method has been deleted." ], "type": "string", "description": "Potential issues with the underlying Pub/Sub subscription configuration. Only populated on get requests." }, "secret": { "type": "string", "description": "Required. Resource name for the secret required as a URL parameter." } } }, "GitRepoSource": { "properties": { "repository": { "type": "string", "description": "The connected repository resource name, in the format `projects/*/locations/*/connections/*/repositories/*`. Either `uri` or `repository` can be specified and is required." }, "uri": { "type": "string", "description": "The URI of the repo (e.g. https://github.com/user/repo.git). Either `uri` or `repository` can be specified and is required." }, "githubEnterpriseConfig": { "type": "string", "description": "The full resource name of the github enterprise config. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`. `projects/{project}/githubEnterpriseConfigs/{id}`." }, "repoType": { "description": "See RepoType below.", "type": "string", "enumDescriptions": [ "The default, unknown repo type. Don't use it, instead use one of the other repo types.", "A Google Cloud Source Repositories-hosted repo.", "A GitHub-hosted repo not necessarily on \"github.com\" (i.e. GitHub Enterprise).", "A Bitbucket Server-hosted repo.", "A GitLab-hosted repo.", "A Bitbucket Cloud-hosted repo." ], "enum": [ "UNKNOWN", "CLOUD_SOURCE_REPOSITORIES", "GITHUB", "BITBUCKET_SERVER", "GITLAB", "BITBUCKET_CLOUD" ] }, "ref": { "description": "The branch or tag to use. Must start with \"refs/\" (required).", "type": "string" }, "bitbucketServerConfig": { "type": "string", "description": "The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`." } }, "id": "GitRepoSource", "description": "GitRepoSource describes a repo and ref of a code repository.", "type": "object" }, "ListGithubEnterpriseConfigsResponse": { "properties": { "configs": { "type": "array", "description": "A list of GitHubEnterpriseConfigs", "items": { "$ref": "GitHubEnterpriseConfig" } } }, "id": "ListGithubEnterpriseConfigsResponse", "description": "RPC response object returned by ListGithubEnterpriseConfigs RPC method.", "type": "object" }, "CreateBitbucketServerConfigOperationMetadata": { "id": "CreateBitbucketServerConfigOperationMetadata", "description": "Metadata for `CreateBitbucketServerConfig` operation.", "type": "object", "properties": { "bitbucketServerConfig": { "type": "string", "description": "The resource name of the BitbucketServerConfig to be created. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`." }, "createTime": { "format": "google-datetime", "type": "string", "description": "Time the operation was created." }, "completeTime": { "type": "string", "description": "Time the operation was completed.", "format": "google-datetime" } } }, "GenericArtifactDependency": { "type": "object", "id": "GenericArtifactDependency", "description": "Represents a generic artifact as a build dependency.", "properties": { "destPath": { "description": "Required. Where the artifact files should be placed on the worker.", "type": "string" }, "resource": { "type": "string", "description": "Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1" } } }, "PubsubConfig": { "properties": { "serviceAccountEmail": { "type": "string", "description": "Service account that will make the push request." }, "topic": { "type": "string", "description": "Optional. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`." }, "subscription": { "type": "string", "description": "Output only. Name of the subscription. Format is `projects/{project}/subscriptions/{subscription}`.", "readOnly": true }, "state": { "type": "string", "description": "Potential issues with the underlying Pub/Sub subscription configuration. Only populated on get requests.", "enum": [ "STATE_UNSPECIFIED", "OK", "SUBSCRIPTION_DELETED", "TOPIC_DELETED", "SUBSCRIPTION_MISCONFIGURED" ], "enumDescriptions": [ "The subscription configuration has not been checked.", "The Pub/Sub subscription is properly configured.", "The subscription has been deleted.", "The topic has been deleted.", "Some of the subscription's field are misconfigured." ] } }, "type": "object", "id": "PubsubConfig", "description": "PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published." }, "HttpConfig": { "properties": { "proxySecretVersionName": { "type": "string", "description": "SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`." } }, "type": "object", "id": "HttpConfig", "description": "HttpConfig is a configuration for HTTP related git operations." }, "DeleteBitbucketServerConfigOperationMetadata": { "properties": { "bitbucketServerConfig": { "description": "The resource name of the BitbucketServerConfig to be deleted. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`.", "type": "string" }, "createTime": { "type": "string", "description": "Time the operation was created.", "format": "google-datetime" }, "completeTime": { "description": "Time the operation was completed.", "type": "string", "format": "google-datetime" } }, "id": "DeleteBitbucketServerConfigOperationMetadata", "description": "Metadata for `DeleteBitbucketServerConfig` operation.", "type": "object" }, "BitbucketServerSecrets": { "type": "object", "id": "BitbucketServerSecrets", "description": "BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server.", "properties": { "webhookSecretVersionName": { "description": "Required. Immutable. The resource name for the webhook secret's secret version. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig.", "type": "string" }, "adminAccessTokenVersionName": { "type": "string", "description": "Required. The resource name for the admin access token's secret version." }, "readAccessTokenVersionName": { "description": "Required. The resource name for the read access token's secret version.", "type": "string" } } }, "GitSourceRepository": { "id": "GitSourceRepository", "description": "A repository for a git source.", "type": "object", "properties": { "url": { "description": "Location of the Git repository.", "type": "string" }, "developerConnect": { "type": "string", "description": "The Developer Connect Git repository link formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`" } } }, "CancelBuildRequest": { "type": "object", "id": "CancelBuildRequest", "description": "Request to cancel an ongoing build.", "properties": { "id": { "description": "Required. ID of the build.", "type": "string" }, "name": { "type": "string", "description": "The name of the `Build` to cancel. Format: `projects/{project}/locations/{location}/builds/{build}`" }, "projectId": { "description": "Required. ID of the project.", "type": "string" } } }, "StorageSourceManifest": { "properties": { "object": { "description": "Required. Cloud Storage object containing the source manifest. This object must be a JSON file.", "type": "string" }, "generation": { "format": "int64", "type": "string", "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used." }, "bucket": { "type": "string", "description": "Required. Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements))." } }, "id": "StorageSourceManifest", "description": "Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).", "type": "object" }, "CreateGitHubEnterpriseConfigOperationMetadata": { "properties": { "completeTime": { "description": "Time the operation was completed.", "type": "string", "format": "google-datetime" }, "githubEnterpriseConfig": { "description": "The resource name of the GitHubEnterprise to be created. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Time the operation was created." } }, "type": "object", "id": "CreateGitHubEnterpriseConfigOperationMetadata", "description": "Metadata for `CreateGithubEnterpriseConfig` operation." }, "UpdateGitHubEnterpriseConfigOperationMetadata": { "id": "UpdateGitHubEnterpriseConfigOperationMetadata", "description": "Metadata for `UpdateGitHubEnterpriseConfig` operation.", "type": "object", "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Time the operation was created." }, "githubEnterpriseConfig": { "description": "The resource name of the GitHubEnterprise to be updated. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`.", "type": "string" }, "completeTime": { "format": "google-datetime", "type": "string", "description": "Time the operation was completed." } } }, "ArtifactResult": { "type": "object", "id": "ArtifactResult", "description": "An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file.", "properties": { "location": { "description": "The path of an artifact in a Cloud Storage bucket, with the generation number. For example, `gs://mybucket/path/to/output.jar#generation`.", "type": "string" }, "fileHash": { "description": "The file hash of the artifact.", "type": "array", "items": { "$ref": "FileHashes" } } } }, "GitConfig": { "properties": { "http": { "$ref": "HttpConfig", "description": "Configuration for HTTP related git operations." } }, "type": "object", "id": "GitConfig", "description": "GitConfig is a configuration for git operations." }, "FileHashes": { "id": "FileHashes", "description": "Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.", "type": "object", "properties": { "fileHash": { "items": { "$ref": "Hash" }, "type": "array", "description": "Collection of file hashes." } } }, "PrivatePoolV1Config": { "properties": { "networkConfig": { "description": "Network configuration for the pool.", "$ref": "NetworkConfig" }, "privateServiceConnect": { "description": "Immutable. Private Service Connect(PSC) Network configuration for the pool.", "$ref": "PrivateServiceConnect" }, "workerConfig": { "$ref": "WorkerConfig", "description": "Machine configuration for the workers in the pool." } }, "type": "object", "id": "PrivatePoolV1Config", "description": "Configuration for a V1 `PrivatePool`." }, "Operation": { "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "metadata": { "type": "object", "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "name": { "type": "string", "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`." }, "response": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object", "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`." }, "done": { "type": "boolean", "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available." }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" } } }, "RetryBuildRequest": { "properties": { "name": { "type": "string", "description": "The name of the `Build` to retry. Format: `projects/{project}/locations/{location}/builds/{build}`" }, "projectId": { "type": "string", "description": "Required. ID of the project." }, "id": { "description": "Required. Build ID of the original build.", "type": "string" } }, "id": "RetryBuildRequest", "description": "Specifies a build to retry.", "type": "object" }, "SecretManagerSecret": { "id": "SecretManagerSecret", "description": "Pairs a secret environment variable with a SecretVersion in Secret Manager.", "type": "object", "properties": { "versionName": { "type": "string", "description": "Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*" }, "env": { "description": "Environment variable name to associate with the secret. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step.", "type": "string" } } }, "PoolOption": { "type": "object", "id": "PoolOption", "description": "Details about how a build should be executed on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information.", "properties": { "name": { "type": "string", "description": "The `WorkerPool` resource to execute the build on. You must have `cloudbuild.workerpools.use` on the project hosting the WorkerPool. Format projects/{project}/locations/{location}/workerPools/{workerPoolId}" } } }, "GitSource": { "properties": { "revision": { "type": "string", "description": "Optional. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git fetch` to fetch the revision from the Git repository; therefore make sure that the string you provide for `revision` is parsable by the command. For information on string values accepted by `git fetch`, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on `git fetch`, see https://git-scm.com/docs/git-fetch." }, "dir": { "type": "string", "description": "Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution." }, "url": { "description": "Required. Location of the Git repo to build. This will be used as a `git remote`, see https://git-scm.com/docs/git-remote.", "type": "string" } }, "id": "GitSource", "description": "Location of the source in any accessible Git repository.", "type": "object" }, "BuildTrigger": { "properties": { "name": { "description": "User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character.", "type": "string" }, "includedFiles": { "description": "If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build.", "type": "array", "items": { "type": "string" } }, "ignoredFiles": { "type": "array", "description": "ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for \"**\". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build.", "items": { "type": "string" } }, "filter": { "type": "string", "description": "A Common Expression Language string." }, "id": { "type": "string", "description": "Output only. Unique identifier of the trigger.", "readOnly": true }, "bitbucketServerTriggerConfig": { "$ref": "BitbucketServerTriggerConfig", "description": "BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received." }, "developerConnectEventConfig": { "$ref": "DeveloperConnectEventConfig", "description": "Optional. The configuration of a trigger that creates a build whenever an event from the DeveloperConnect API is received." }, "autodetect": { "type": "boolean", "description": "Autodetect build configuration. The following precedence is used (case insensitive): 1. cloudbuild.yaml 2. cloudbuild.yml 3. cloudbuild.json 4. Dockerfile Currently only available for GitHub App Triggers." }, "gitFileSource": { "$ref": "GitFileSource", "description": "The file source describing the local or remote Build template." }, "pubsubConfig": { "$ref": "PubsubConfig", "description": "PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published." }, "resourceName": { "description": "The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service.", "type": "string" }, "tags": { "items": { "type": "string" }, "description": "Tags for annotation of a `BuildTrigger`", "type": "array" }, "eventType": { "enum": [ "EVENT_TYPE_UNSPECIFIED", "REPO", "WEBHOOK", "PUBSUB", "MANUAL" ], "enumDescriptions": [ "EVENT_TYPE_UNSPECIFIED event_types are ignored.", "REPO corresponds to the supported VCS integrations.", "WEBHOOK corresponds to webhook triggers.", "PUBSUB corresponds to pubsub triggers.", "MANUAL corresponds to manual-only invoked triggers." ], "type": "string", "description": "EventType allows the user to explicitly set the type of event to which this BuildTrigger should respond. This field will be validated against the rest of the configuration if it is set." }, "substitutions": { "additionalProperties": { "type": "string" }, "description": "Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`.", "type": "object" }, "sourceToBuild": { "$ref": "GitRepoSource", "description": "The repo and ref of the repository from which to build. This field is used only for those triggers that do not respond to SCM events. Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers." }, "includeBuildLogs": { "enumDescriptions": [ "Build logs will not be shown on GitHub.", "Build logs will be shown on GitHub." ], "enum": [ "INCLUDE_BUILD_LOGS_UNSPECIFIED", "INCLUDE_BUILD_LOGS_WITH_STATUS" ], "description": "If set to INCLUDE_BUILD_LOGS_WITH_STATUS, log url will be shown on GitHub page when build status is final. Setting this field to INCLUDE_BUILD_LOGS_WITH_STATUS for non GitHub triggers results in INVALID_ARGUMENT error.", "type": "string" }, "triggerTemplate": { "$ref": "RepoSource", "description": "Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. Mutually exclusive with `github`." }, "description": { "description": "Human-readable description of this trigger.", "type": "string" }, "webhookConfig": { "$ref": "WebhookConfig", "description": "WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL." }, "disabled": { "type": "boolean", "description": "If true, the trigger will never automatically execute a build." }, "serviceAccount": { "description": "The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}`", "type": "string" }, "filename": { "description": "Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml).", "type": "string" }, "createTime": { "description": "Output only. Time when the trigger was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "approvalConfig": { "description": "Configuration for manual approval to start a build invocation of this BuildTrigger.", "$ref": "ApprovalConfig" }, "build": { "$ref": "Build", "description": "Contents of the build template." }, "github": { "$ref": "GitHubEventsConfig", "description": "GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`." }, "repositoryEventConfig": { "$ref": "RepositoryEventConfig", "description": "The configuration of a trigger that creates a build whenever an event from Repo API is received." } }, "type": "object", "id": "BuildTrigger", "description": "Configuration for an automated build in response to source repository changes." }, "RemoveBitbucketServerConnectedRepositoryRequest": { "properties": { "connectedRepository": { "description": "The connected repository to remove.", "$ref": "BitbucketServerRepositoryId" } }, "id": "RemoveBitbucketServerConnectedRepositoryRequest", "description": "RPC request object accepted by RemoveBitbucketServerConnectedRepository RPC method.", "type": "object" }, "BatchCreateBitbucketServerConnectedRepositoriesResponse": { "properties": { "bitbucketServerConnectedRepositories": { "items": { "$ref": "BitbucketServerConnectedRepository" }, "type": "array", "description": "The connected Bitbucket Server repositories." } }, "type": "object", "id": "BatchCreateBitbucketServerConnectedRepositoriesResponse", "description": "Response of BatchCreateBitbucketServerConnectedRepositories RPC method including all successfully connected Bitbucket Server repositories." }, "PythonPackage": { "properties": { "repository": { "description": "Artifact Registry repository, in the form \"https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY\" Files in the workspace matching any path pattern will be uploaded to Artifact Registry with this location as a prefix.", "type": "string" }, "paths": { "items": { "type": "string" }, "description": "Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file.", "type": "array" } }, "id": "PythonPackage", "description": "Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository.", "type": "object" }, "BitbucketServerTriggerConfig": { "properties": { "repoSlug": { "type": "string", "description": "Required. Slug of the repository. A repository slug is a URL-friendly version of a repository name, automatically generated by Bitbucket for use in the URL. For example, if the repository name is 'test repo', in the URL it would become 'test-repo' as in https://mybitbucket.server/projects/TEST/repos/test-repo." }, "pullRequest": { "$ref": "PullRequestFilter", "description": "Filter to match changes in pull requests." }, "push": { "description": "Filter to match changes in refs like branches, tags.", "$ref": "PushFilter" }, "bitbucketServerConfigResource": { "description": "Required. The Bitbucket server config resource that this trigger config maps to.", "type": "string" }, "projectKey": { "type": "string", "description": "Required. Key of the project that the repo is in. For example: The key for https://mybitbucket.server/projects/TEST/repos/test-repo is \"TEST\"." }, "bitbucketServerConfig": { "$ref": "BitbucketServerConfig", "description": "Output only. The BitbucketServerConfig specified in the bitbucket_server_config_resource field.", "readOnly": true } }, "id": "BitbucketServerTriggerConfig", "description": "BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received.", "type": "object" }, "RepositoryEventConfig": { "properties": { "repository": { "description": "The resource name of the Repo API resource.", "type": "string" }, "repositoryType": { "enumDescriptions": [ "If unspecified, RepositoryType defaults to GITHUB.", "The SCM repo is GITHUB.", "The SCM repo is GITHUB Enterprise.", "The SCM repo is GITLAB Enterprise.", "The SCM repo is BITBUCKET Data Center.", "The SCM repo is BITBUCKET Cloud." ], "description": "Output only. The type of the SCM vendor the repository points to.", "readOnly": true, "type": "string", "enum": [ "REPOSITORY_TYPE_UNSPECIFIED", "GITHUB", "GITHUB_ENTERPRISE", "GITLAB_ENTERPRISE", "BITBUCKET_DATA_CENTER", "BITBUCKET_CLOUD" ] }, "pullRequest": { "description": "Filter to match changes in pull requests.", "$ref": "PullRequestFilter" }, "push": { "$ref": "PushFilter", "description": "Filter to match changes in refs like branches, tags." } }, "type": "object", "id": "RepositoryEventConfig", "description": "The configuration of a trigger that creates a build whenever an event from Repo API is received." }, "Source": { "id": "Source", "description": "Location of the source in a supported storage service.", "type": "object", "properties": { "gitSource": { "$ref": "GitSource", "description": "If provided, get the source from this Git repository." }, "developerConnectConfig": { "description": "If provided, get the source from this Developer Connect config.", "$ref": "DeveloperConnectConfig" }, "repoSource": { "description": "If provided, get the source from this location in a Cloud Source Repository.", "$ref": "RepoSource" }, "connectedRepository": { "$ref": "ConnectedRepository", "description": "Optional. If provided, get the source from this 2nd-gen Google Cloud Build repository resource." }, "storageSource": { "$ref": "StorageSource", "description": "If provided, get the source from this location in Cloud Storage." }, "storageSourceManifest": { "description": "If provided, get the source from this manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).", "$ref": "StorageSourceManifest" } } }, "GenericArtifact": { "properties": { "registryPath": { "description": "Required. Registry path to upload the generic artifact to, in the form projects/$PROJECT/locations/$LOCATION/repositories/$REPO/packages/$PACKAGE/versions/$VERSION", "type": "string" }, "folder": { "description": "Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry.", "type": "string" } }, "type": "object", "id": "GenericArtifact", "description": "Generic artifact to upload to Artifact Registry upon successful completion of all build steps." }, "BitbucketServerRepositoryId": { "properties": { "repoSlug": { "description": "Required. Identifier for the repository.", "type": "string" }, "projectKey": { "type": "string", "description": "Required. Identifier for the project storing the repository." }, "webhookId": { "format": "int32", "description": "Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.", "readOnly": true, "type": "integer" } }, "id": "BitbucketServerRepositoryId", "description": "BitbucketServerRepositoryId identifies a specific repository hosted on a Bitbucket Server.", "type": "object" }, "UploadedGoModule": { "properties": { "pushTiming": { "description": "Output only. Stores timing information for pushing the specified artifact.", "readOnly": true, "$ref": "TimeSpan" }, "artifactRegistryPackage": { "type": "string", "description": "Output only. Path to the artifact in Artifact Registry.", "readOnly": true }, "uri": { "description": "URI of the uploaded artifact.", "type": "string" }, "fileHashes": { "description": "Hash types and values of the Go Module Artifact.", "$ref": "FileHashes" } }, "id": "UploadedGoModule", "description": "A Go module artifact uploaded to Artifact Registry using the GoModule directive.", "type": "object" }, "UploadedMavenArtifact": { "type": "object", "id": "UploadedMavenArtifact", "description": "A Maven artifact uploaded using the MavenArtifact directive.", "properties": { "pushTiming": { "$ref": "TimeSpan", "description": "Output only. Stores timing information for pushing the specified artifact.", "readOnly": true }, "artifactRegistryPackage": { "description": "Output only. Path to the artifact in Artifact Registry.", "readOnly": true, "type": "string" }, "uri": { "description": "URI of the uploaded artifact.", "type": "string" }, "fileHashes": { "$ref": "FileHashes", "description": "Hash types and values of the Maven Artifact." } } }, "RunBuildTriggerRequest": { "properties": { "source": { "description": "Source to build against this trigger. Branch and tag names cannot consist of regular expressions.", "$ref": "RepoSource" }, "projectId": { "type": "string", "description": "Required. ID of the project." }, "triggerId": { "description": "Required. ID of the trigger.", "type": "string" } }, "type": "object", "id": "RunBuildTriggerRequest", "description": "Specifies a build trigger to run and the source to use." }, "UpdateBitbucketServerConfigOperationMetadata": { "id": "UpdateBitbucketServerConfigOperationMetadata", "description": "Metadata for `UpdateBitbucketServerConfig` operation.", "type": "object", "properties": { "completeTime": { "format": "google-datetime", "description": "Time the operation was completed.", "type": "string" }, "bitbucketServerConfig": { "description": "The resource name of the BitbucketServerConfig to be updated. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Time the operation was created.", "type": "string" } } }, "CancelOperationRequest": { "properties": {}, "id": "CancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "type": "object" }, "DeveloperConnectConfig": { "type": "object", "id": "DeveloperConnectConfig", "description": "This config defines the location of a source through Developer Connect.", "properties": { "revision": { "type": "string", "description": "Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref." }, "gitRepositoryLink": { "description": "Required. The Developer Connect Git repository link, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`.", "type": "string" }, "dir": { "description": "Required. Directory, relative to the source root, in which to run the build.", "type": "string" } } }, "BitbucketServerConnectedRepository": { "properties": { "status": { "description": "Output only. The status of the repo connection request.", "readOnly": true, "$ref": "Status" }, "parent": { "type": "string", "description": "The name of the `BitbucketServerConfig` that added connected repository. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{config}`" }, "repo": { "description": "The Bitbucket Server repositories to connect.", "$ref": "BitbucketServerRepositoryId" } }, "type": "object", "id": "BitbucketServerConnectedRepository", "description": "/ BitbucketServerConnectedRepository represents a connected Bitbucket Server / repository." }, "BuildOperationMetadata": { "type": "object", "id": "BuildOperationMetadata", "description": "Metadata for build operations.", "properties": { "build": { "description": "The build that the operation is tracking.", "$ref": "Build" } } } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "fullyEncodeReservedExpansion": true, "revision": "20260814", "baseUrl": "https://cloudbuild.googleapis.com/", "servicePath": "" }