{ "discoveryVersion": "v1", "kind": "discovery#restDescription", "servicePath": "", "basePath": "", "description": "Deploy and manage user provided container images that scale automatically based on incoming requests. The Cloud Run Admin API v1 follows the Knative Serving API specification, while v2 is aligned with Google Cloud AIP-based API standards, as described in https://google.aip.dev/.", "ownerDomain": "google.com", "protocol": "rest", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "version": "v2", "rootUrl": "https://run.googleapis.com/", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/run": { "description": "See, edit, configure, and delete your Google Cloud Run data and see the email address for your Google Account" }, "https://www.googleapis.com/auth/run.readonly": { "description": "See your Google Cloud Run data and the email address of your Google Account" }, "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." } } } }, "resources": { "projects": { "resources": { "locations": { "methods": { "exportImage": { "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the resource of which image metadata should be exported. Format: `projects/{project_id_or_number}/locations/{location}/services/{service}/revisions/{revision}` for Revision `projects/{project_id_or_number}/locations/{location}/jobs/{job}/executions/{execution}` for Execution", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/.*$" } }, "response": { "$ref": "GoogleCloudRunV2ExportImageResponse" }, "description": "Export image for a given resource.", "httpMethod": "POST", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRunV2ExportImageRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "id": "run.projects.locations.exportImage", "path": "v2/{+name}:exportImage", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/{locationsId1}:exportImage" }, "exportMetadata": { "id": "run.projects.locations.exportMetadata", "parameterOrder": [ "name" ], "path": "v2/{+name}:exportMetadata", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/{locationsId1}:exportMetadata", "description": "Export generated customer metadata for a given resource.", "httpMethod": "GET", "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/.*$", "description": "Required. The name of the resource of which metadata should be exported. Format: `projects/{project_id_or_number}/locations/{location}/services/{service}` for Service `projects/{project_id_or_number}/locations/{location}/services/{service}/revisions/{revision}` for Revision `projects/{project_id_or_number}/locations/{location}/jobs/{job}/executions/{execution}` for Execution {project_id_or_number} may contains domain-scoped project IDs" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "response": { "$ref": "GoogleCloudRunV2Metadata" } }, "exportImageMetadata": { "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "Export image metadata for a given resource.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "path": "v2/{+name}:exportImageMetadata", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/.*$", "location": "path", "description": "Required. The name of the resource of which image metadata should be exported. Format: `projects/{project_id_or_number}/locations/{location}/services/{service}/revisions/{revision}` for Revision `projects/{project_id_or_number}/locations/{location}/jobs/{job}/executions/{execution}` for Execution", "required": true, "type": "string" } }, "response": { "$ref": "GoogleCloudRunV2Metadata" }, "id": "run.projects.locations.exportImageMetadata", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/{locationsId1}:exportImageMetadata" }, "exportProjectMetadata": { "id": "run.projects.locations.exportProjectMetadata", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}:exportProjectMetadata", "parameters": { "name": { "type": "string", "description": "Required. The name of the project of which metadata should be exported. Format: `projects/{project_id_or_number}/locations/{location}` for Project in a given location.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "parameterOrder": [ "name" ], "path": "v2/{+name}:exportProjectMetadata", "description": "Export generated customer metadata for a given project.", "response": { "$ref": "GoogleCloudRunV2Metadata" } } }, "resources": { "operations": { "methods": { "list": { "parameters": { "pageSize": { "format": "int32", "location": "query", "description": "The maximum number of records that should be returned. Requested page size cannot exceed 100. If not set or set to less than or equal to 0, the default page size is 100. .", "type": "integer" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "name": { "location": "path", "required": true, "type": "string", "description": "Required. To query for all of the operations for a project.", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "location": "query", "description": "Optional. A filter for matching the completed or in-progress operations. The supported formats of *filter* are: To query for only completed operations: done:true To query for only ongoing operations: done:false Must be empty to query for all of the latest operations for the given parent project.", "type": "string" }, "pageToken": { "description": "Token identifying which result to start with, which is returned by a previous list call.", "type": "string", "location": "query" } }, "path": "v2/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "run.projects.locations.operations.list", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ] }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource to be deleted." } }, "httpMethod": "DELETE", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "run.projects.locations.operations.delete", "path": "v2/{+name}", "parameterOrder": [ "name" ] }, "wait": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "path": "v2/{+name}:wait", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "request": { "$ref": "GoogleLongrunningWaitOperationRequest" }, "id": "run.projects.locations.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." }, "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "required": true, "location": "path", "type": "string", "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "run.projects.locations.operations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "path": "v2/{+name}", "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." } } }, "sourceUploads": { "methods": { "upload": { "request": { "$ref": "GoogleCloudRunV2UploadSourceRequest" }, "response": { "$ref": "GoogleCloudRunV2UploadSourceResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "description": "Uploads a source archive to a Google Cloud Storage bucket through Cloud Run. The uploaded source object should be used for Cloud Run resource deployments. User is responsible for managing the lifecycle of the uploaded object. If uploading through the Cloud Run API to Cloud Storage is not desired, you can use the IAM Deny Policy to deny the `run.locations.uploadSource` permission for all principals.", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "description": "Required. The project and location in which the source archive should be uploaded to, specified in the format `projects/*/locations/*`.", "required": true } }, "mediaUpload": { "protocols": { "simple": { "multipart": true, "path": "/upload/v2/{+parent}:uploadSource" } }, "accept": [ "*/*" ], "maxSize": "262144000" }, "path": "v2/{+parent}:uploadSource", "id": "run.projects.locations.sourceUploads.upload", "parameterOrder": [ "parent" ], "supportsMediaUpload": true, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}:uploadSource" } } }, "jobs": { "methods": { "patch": { "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "validateOnly": { "type": "boolean", "description": "Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.", "location": "query" }, "allowMissing": { "description": "Optional. If set to true, and if the Job does not exist, it will create a new one. Caller must have both create and update permissions for this call if this is set to true.", "location": "query", "type": "boolean" }, "name": { "type": "string", "required": true, "description": "The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRunV2Job" }, "id": "run.projects.locations.jobs.patch", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "description": "Updates a Job.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}", "path": "v2/{+name}" }, "get": { "parameterOrder": [ "name" ], "path": "v2/{+name}", "response": { "$ref": "GoogleCloudRunV2Job" }, "description": "Gets information about a Job.", "id": "run.projects.locations.jobs.get", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}", "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.", "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ] }, "testIamPermissions": { "id": "run.projects.locations.jobs.testIamPermissions", "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:testIamPermissions", "httpMethod": "POST", "description": "Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.", "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "path": "v2/{+resource}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "parameterOrder": [ "resource" ], "parameters": { "resource": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", "required": true, "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string" } } }, "list": { "response": { "$ref": "GoogleCloudRunV2ListJobsResponse" }, "id": "run.projects.locations.jobs.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "parameters": { "parent": { "description": "Required. The location and project to list resources on. Format: projects/{project}/locations/{location}, where {project} can be project id or number.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "pageToken": { "location": "query", "description": "A page token received from a previous call to ListJobs. All other parameters must match.", "type": "string" }, "pageSize": { "description": "Maximum number of Jobs to return in this call.", "format": "int32", "location": "query", "type": "integer" }, "showDeleted": { "type": "boolean", "description": "If true, returns deleted (but unexpired) resources along with active ones.", "location": "query" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "description": "Lists Jobs. Results are sorted by creation time, descending.", "path": "v2/{+parent}/jobs", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs" }, "delete": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "description": "Deletes a Job.", "path": "v2/{+name}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", "type": "string", "description": "Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.", "required": true }, "validateOnly": { "location": "query", "type": "boolean", "description": "Indicates that the request should be validated without actually deleting any resources." }, "etag": { "description": "A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", "location": "query", "type": "string" } }, "httpMethod": "DELETE", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}", "id": "run.projects.locations.jobs.delete" }, "run": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:run", "request": { "$ref": "GoogleCloudRunV2RunJobRequest" }, "description": "Triggers creation of a new Execution of this Job.", "httpMethod": "POST", "path": "v2/{+name}:run", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "id": "run.projects.locations.jobs.run", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", "type": "string", "description": "Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.", "required": true, "location": "path" } } }, "getIamPolicy": { "parameters": { "options.requestedPolicyVersion": { "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "location": "query" }, "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", "location": "path", "type": "string", "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "response": { "$ref": "GoogleIamV1Policy" }, "httpMethod": "GET", "path": "v2/{+resource}:getIamPolicy", "description": "Gets the IAM Access Control policy currently in effect for the given Job. This result does not include any inherited policies.", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "id": "run.projects.locations.jobs.getIamPolicy", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:getIamPolicy" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "httpMethod": "POST", "description": "Creates a Job.", "path": "v2/{+parent}/jobs", "parameters": { "jobId": { "description": "Optional. The unique identifier for the Job. The name of the job becomes {parent}/jobs/{job_id}. If not provided, the server will generate a unique `job_id`.", "type": "string", "location": "query" }, "validateOnly": { "type": "boolean", "description": "Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.", "location": "query" }, "parent": { "description": "Required. The location and project in which this Job should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudRunV2Job" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs", "id": "run.projects.locations.jobs.create", "parameterOrder": [ "parent" ] }, "setIamPolicy": { "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "parameterOrder": [ "resource" ], "description": "Sets the IAM Access control policy for the specified Job. Overwrites any existing policy.", "response": { "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "path": "v2/{+resource}:setIamPolicy", "httpMethod": "POST", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:setIamPolicy", "id": "run.projects.locations.jobs.setIamPolicy", "parameters": { "resource": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } } } }, "resources": { "executions": { "methods": { "exportStatus": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}/{executionsId1}:exportStatus", "path": "v2/{+name}/{+operationId}:exportStatus", "description": "Read the status of an image export operation.", "httpMethod": "GET", "id": "run.projects.locations.jobs.executions.exportStatus", "response": { "$ref": "GoogleCloudRunV2ExportStatusResponse" }, "parameterOrder": [ "name", "operationId" ], "parameters": { "operationId": { "type": "string", "pattern": "^[^/]+$", "description": "Required. The operation id returned from ExportImage.", "required": true, "location": "path" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+/executions/[^/]+$", "required": true, "description": "Required. The name of the resource of which image export operation status has to be fetched. Format: `projects/{project_id_or_number}/locations/{location}/services/{service}/revisions/{revision}` for Revision `projects/{project_id_or_number}/locations/{location}/jobs/{job}/executions/{execution}` for Execution", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ] }, "delete": { "id": "run.projects.locations.jobs.executions.delete", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the Execution to delete. Format: `projects/{project}/locations/{location}/jobs/{job}/executions/{execution}`, where `{project}` can be project id or number.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+/executions/[^/]+$" }, "validateOnly": { "type": "boolean", "location": "query", "description": "Indicates that the request should be validated without actually deleting any resources." }, "etag": { "type": "string", "description": "A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates.", "location": "query" } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "description": "Deletes an Execution.", "httpMethod": "DELETE", "path": "v2/{+name}" }, "list": { "path": "v2/{+parent}/executions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "id": "run.projects.locations.jobs.executions.list", "response": { "$ref": "GoogleCloudRunV2ListExecutionsResponse" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", "description": "Required. The Execution from which the Executions should be listed. To list all Executions across Jobs, use \"-\" instead of Job name. Format: `projects/{project}/locations/{location}/jobs/{job}`, where `{project}` can be project id or number.", "required": true, "type": "string" }, "pageToken": { "description": "A page token received from a previous call to ListExecutions. All other parameters must match.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "description": "Maximum number of Executions to return in this call.", "location": "query", "format": "int32" }, "showDeleted": { "description": "If true, returns deleted (but unexpired) resources along with active ones.", "location": "query", "type": "boolean" } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions", "description": "Lists Executions from a Job. Results are sorted by creation time, descending.", "httpMethod": "GET" }, "cancel": { "parameterOrder": [ "name" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "id": "run.projects.locations.jobs.executions.cancel", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v2/{+name}:cancel", "request": { "$ref": "GoogleCloudRunV2CancelExecutionRequest" }, "parameters": { "name": { "required": true, "description": "Required. The name of the Execution to cancel. Format: `projects/{project}/locations/{location}/jobs/{job}/executions/{execution}`, where `{project}` can be project id or number.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+/executions/[^/]+$", "type": "string" } }, "description": "Cancels an Execution." }, "get": { "id": "run.projects.locations.jobs.executions.get", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "response": { "$ref": "GoogleCloudRunV2Execution" }, "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Required. The full name of the Execution. Format: `projects/{project}/locations/{location}/jobs/{job}/executions/{execution}`, where `{project}` can be project id or number.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+/executions/[^/]+$" } }, "path": "v2/{+name}", "parameterOrder": [ "name" ], "description": "Gets information about an Execution." } }, "resources": { "tasks": { "methods": { "get": { "httpMethod": "GET", "id": "run.projects.locations.jobs.executions.tasks.get", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "required": true, "description": "Required. The full name of the Task. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}/tasks/{task}", "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+/executions/[^/]+/tasks/[^/]+$", "location": "path" } }, "response": { "$ref": "GoogleCloudRunV2Task" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}/tasks/{tasksId}", "description": "Gets information about a Task.", "path": "v2/{+name}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "response": { "$ref": "GoogleCloudRunV2ListTasksResponse" }, "path": "v2/{+parent}/tasks", "description": "Lists Tasks from an Execution of a Job.", "httpMethod": "GET", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}/tasks", "parameters": { "pageToken": { "type": "string", "description": "A page token received from a previous call to ListTasks. All other parameters must match.", "location": "query" }, "showDeleted": { "description": "If true, returns deleted (but unexpired) resources along with active ones.", "type": "boolean", "location": "query" }, "parent": { "location": "path", "description": "Required. The Execution from which the Tasks should be listed. To list all Tasks across Executions of a Job, use \"-\" instead of Execution name. To list all Tasks across Jobs, use \"-\" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+/executions/[^/]+$", "required": true }, "pageSize": { "format": "int32", "description": "Maximum number of Tasks to return in this call.", "location": "query", "type": "integer" } }, "id": "run.projects.locations.jobs.executions.tasks.list", "parameterOrder": [ "parent" ] } } } } } } }, "instances": { "methods": { "stop": { "parameterOrder": [ "name" ], "description": "Stops an Instance.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "httpMethod": "POST", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:stop", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the Instance to stop." } }, "path": "v2/{+name}:stop", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudRunV2StopInstanceRequest" }, "id": "run.projects.locations.instances.stop" }, "start": { "id": "run.projects.locations.instances.start", "path": "v2/{+name}:start", "parameterOrder": [ "name" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:start", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudRunV2StartInstanceRequest" }, "description": "Starts an Instance.", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the Instance to start.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "type": "string", "location": "path", "required": true } } }, "setIamPolicy": { "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "response": { "$ref": "GoogleIamV1Policy" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy", "id": "run.projects.locations.instances.setIamPolicy", "httpMethod": "POST", "path": "v2/{+resource}:setIamPolicy", "parameterOrder": [ "resource" ], "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, "location": "path", "type": "string", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "description": "Sets the IAM Access control policy for the specified Instance. Overwrites any existing policy." }, "patch": { "id": "run.projects.locations.instances.patch", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "path": "v2/{+name}", "request": { "$ref": "GoogleCloudRunV2Instance" }, "httpMethod": "PATCH", "description": "Updates an Instance.", "parameters": { "validateOnly": { "type": "boolean", "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.", "location": "query" }, "allowMissing": { "description": "Optional. If set to `true`, and if the Instance does not exist, it will create a new one. The caller must have `run.instances.create` permissions if this is set to `true` and the Instance does not exist.", "location": "query", "type": "boolean" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "type": "string", "required": true, "description": "The fully qualified name of this Instance. In `CreateInstanceRequest`, this field is ignored, and instead composed from `CreateInstanceRequest.parent` and `CreateInstanceRequest.instance_id`." }, "updateMask": { "type": "string", "description": "Optional. The list of fields to be updated.", "format": "google-fieldmask", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ] }, "delete": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "httpMethod": "DELETE", "parameters": { "validateOnly": { "type": "boolean", "description": "Optional. Indicates that the request should be validated without actually deleting any resources.", "location": "query" }, "name": { "type": "string", "required": true, "location": "path", "description": "Required. The name of the Instance to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$" }, "etag": { "description": "Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", "type": "string", "location": "query" } }, "description": "Deletes an Instance", "path": "v2/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "parameterOrder": [ "name" ], "id": "run.projects.locations.instances.delete", "response": { "$ref": "GoogleLongrunningOperation" } }, "testIamPermissions": { "path": "v2/{+resource}:testIamPermissions", "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" }, "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "description": "Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.", "parameterOrder": [ "resource" ], "id": "run.projects.locations.instances.testIamPermissions", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "parameters": { "resource": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions" }, "getIamPolicy": { "id": "run.projects.locations.instances.getIamPolicy", "response": { "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "description": "Gets the IAM Access Control policy currently in effect for the given Instance. This result does not include any inherited policies.", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path" }, "options.requestedPolicyVersion": { "format": "int32", "type": "integer", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "location": "query" } }, "parameterOrder": [ "resource" ], "path": "v2/{+resource}:getIamPolicy", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy", "httpMethod": "GET" }, "create": { "request": { "$ref": "GoogleCloudRunV2Instance" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "description": "Required. The location and project in which this Instance should be created.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "instanceId": { "location": "query", "type": "string", "description": "Optional. The unique identifier for the Instance. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the instance becomes {parent}/instances/{instance_id}. If not provided, the server will generate a unique `instance_id`." }, "validateOnly": { "type": "boolean", "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.", "location": "query" } }, "id": "run.projects.locations.instances.create", "description": "Creates an Instance.", "httpMethod": "POST", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v2/{+parent}/instances" }, "get": { "path": "v2/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "response": { "$ref": "GoogleCloudRunV2Instance" }, "id": "run.projects.locations.instances.get", "description": "Gets an Instance", "parameters": { "name": { "type": "string", "description": "Required. The name of the Instance to retrieve.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, "location": "path" } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "parameterOrder": [ "name" ], "httpMethod": "GET" }, "list": { "response": { "$ref": "GoogleCloudRunV2ListInstancesResponse" }, "description": "Lists Instances. Results are sorted by creation time, descending.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "Optional. Maximum number of Instances to return in this call.", "format": "int32" }, "parent": { "required": true, "description": "Required. The location and project to list resources on.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "showDeleted": { "type": "boolean", "location": "query", "description": "Optional. If true, returns deleted (but unexpired) resources along with active ones." }, "pageToken": { "description": "Optional. A page token received from a previous call to ListInstances. All other parameters must match.", "location": "query", "type": "string" } }, "id": "run.projects.locations.instances.list", "httpMethod": "GET", "path": "v2/{+parent}/instances", "parameterOrder": [ "parent" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances" } } }, "workerPools": { "methods": { "delete": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", "description": "Required. The full name of the WorkerPool. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`, where `{project}` can be project id or number.", "location": "path", "type": "string", "required": true }, "validateOnly": { "type": "boolean", "location": "query", "description": "Optional. Indicates that the request should be validated without actually deleting any resources." }, "etag": { "type": "string", "description": "A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", "location": "query" } }, "path": "v2/{+name}", "description": "Deletes a WorkerPool.", "httpMethod": "DELETE", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}", "id": "run.projects.locations.workerPools.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ] }, "patch": { "parameterOrder": [ "name" ], "id": "run.projects.locations.workerPools.patch", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Updates a WorkerPool.", "parameters": { "validateOnly": { "type": "boolean", "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.", "location": "query" }, "allowMissing": { "location": "query", "type": "boolean", "description": "Optional. If set to true, and if the WorkerPool does not exist, it will create a new one. The caller must have 'run.workerpools.create' permissions if this is set to true and the WorkerPool does not exist." }, "forceNewRevision": { "location": "query", "description": "Optional. If set to true, a new revision will be created from the template even if the system doesn't detect any changes from the previously deployed revision. This may be useful for cases where the underlying resources need to be recreated or reinitialized. For example if the image is specified by label, but the underlying image digest has changed) or if the container performs deployment initialization work that needs to be performed again.", "type": "boolean" }, "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Optional. The list of fields to be updated." }, "name": { "location": "path", "required": true, "description": "The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: `projects/{project}/locations/{location}/workerPools/{worker_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", "type": "string" } }, "path": "v2/{+name}", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudRunV2WorkerPool" } }, "testIamPermissions": { "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "description": "Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.", "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "parameterOrder": [ "resource" ], "parameters": { "resource": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", "location": "path", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}:testIamPermissions", "path": "v2/{+resource}:testIamPermissions", "id": "run.projects.locations.workerPools.testIamPermissions", "httpMethod": "POST" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "parameters": { "validateOnly": { "type": "boolean", "location": "query", "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources." }, "workerPoolId": { "description": "Optional. The unique identifier for the WorkerPool. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the worker pool becomes `{parent}/workerPools/{worker_pool_id}`. If not provided, the server will generate a unique `worker_pool_id`.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The location and project in which this worker pool should be created. Format: `projects/{project}/locations/{location}`, where `{project}` can be project id or number. Only lowercase characters, digits, and hyphens.", "location": "path", "required": true } }, "httpMethod": "POST", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools", "description": "Creates a new WorkerPool in a given project and location.", "path": "v2/{+parent}/workerPools", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudRunV2WorkerPool" }, "id": "run.projects.locations.workerPools.create" }, "getIamPolicy": { "path": "v2/{+resource}:getIamPolicy", "httpMethod": "GET", "parameters": { "options.requestedPolicyVersion": { "type": "integer", "location": "query", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32" }, "resource": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string" } }, "response": { "$ref": "GoogleIamV1Policy" }, "parameterOrder": [ "resource" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "description": "Gets the IAM Access Control policy currently in effect for the given Cloud Run WorkerPool. This result does not include any inherited policies.", "id": "run.projects.locations.workerPools.getIamPolicy" }, "setIamPolicy": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}:setIamPolicy", "parameters": { "resource": { "type": "string", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", "location": "path" } }, "description": "Sets the IAM Access control policy for the specified WorkerPool. Overwrites any existing policy.", "httpMethod": "POST", "id": "run.projects.locations.workerPools.setIamPolicy", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "response": { "$ref": "GoogleIamV1Policy" }, "path": "v2/{+resource}:setIamPolicy" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "response": { "$ref": "GoogleCloudRunV2ListWorkerPoolsResponse" }, "path": "v2/{+parent}/workerPools", "parameters": { "showDeleted": { "location": "query", "description": "If true, returns deleted (but unexpired) resources along with active ones.", "type": "boolean" }, "pageSize": { "description": "Maximum number of WorkerPools to return in this call.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { "description": "A page token received from a previous call to ListWorkerPools. All other parameters must match.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The location and project to list resources on. Location must be a valid Google Cloud region, and cannot be the \"-\" wildcard. Format: `projects/{project}/locations/{location}`, where `{project}` can be project id or number.", "location": "path", "required": true, "type": "string" } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools", "id": "run.projects.locations.workerPools.list", "description": "Lists WorkerPools. Results are sorted by creation time, descending.", "httpMethod": "GET", "parameterOrder": [ "parent" ] }, "get": { "id": "run.projects.locations.workerPools.get", "path": "v2/{+name}", "response": { "$ref": "GoogleCloudRunV2WorkerPool" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", "type": "string", "location": "path", "description": "Required. The full name of the WorkerPool. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`, where `{project}` can be project id or number.", "required": true } }, "description": "Gets information about a WorkerPool.", "parameterOrder": [ "name" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}" } }, "resources": { "revisions": { "methods": { "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudRunV2Revision" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "parameters": { "name": { "type": "string", "description": "Required. The full name of the Revision. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision}", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+/revisions/[^/]+$", "location": "path" } }, "path": "v2/{+name}", "description": "Gets information about a Revision.", "id": "run.projects.locations.workerPools.revisions.get", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}/revisions/{revisionsId}" }, "list": { "response": { "$ref": "GoogleCloudRunV2ListRevisionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "httpMethod": "GET", "parameters": { "pageToken": { "description": "A page token received from a previous call to ListRevisions. All other parameters must match.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", "required": true, "location": "path", "description": "Required. The Service from which the Revisions should be listed. To list all Revisions across Services, use \"-\" instead of Service name. Format: projects/{project}/locations/{location}/services/{service}", "type": "string" }, "showDeleted": { "type": "boolean", "description": "If true, returns deleted (but unexpired) resources along with active ones.", "location": "query" }, "pageSize": { "location": "query", "description": "Maximum number of revisions to return in this call.", "type": "integer", "format": "int32" } }, "parameterOrder": [ "parent" ], "path": "v2/{+parent}/revisions", "id": "run.projects.locations.workerPools.revisions.list", "description": "Lists Revisions from a given Service, or from a given location. Results are sorted by creation time, descending.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}/revisions" }, "delete": { "parameterOrder": [ "name" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}/revisions/{revisionsId}", "parameters": { "etag": { "type": "string", "location": "query", "description": "A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates." }, "validateOnly": { "type": "boolean", "location": "query", "description": "Indicates that the request should be validated without actually deleting any resources." }, "name": { "type": "string", "description": "Required. The name of the Revision to delete. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision}", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+/revisions/[^/]+$", "location": "path" } }, "path": "v2/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "run.projects.locations.workerPools.revisions.delete", "description": "Deletes a Revision.", "httpMethod": "DELETE" } } } } }, "builds": { "methods": { "submit": { "id": "run.projects.locations.builds.submit", "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The project and location to build in. Location must be a region, e.g., 'us-central1' or 'global' if the global builder is to be used. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "request": { "$ref": "GoogleCloudRunV2SubmitBuildRequest" }, "httpMethod": "POST", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/builds:submit", "path": "v2/{+parent}/builds:submit", "response": { "$ref": "GoogleCloudRunV2SubmitBuildResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "description": "Submits a build in a given project.", "parameterOrder": [ "parent" ] } } }, "services": { "methods": { "testIamPermissions": { "description": "Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.", "parameters": { "resource": { "location": "path", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "required": true } }, "path": "v2/{+resource}:testIamPermissions", "id": "run.projects.locations.services.testIamPermissions", "parameterOrder": [ "resource" ], "httpMethod": "POST", "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:testIamPermissions", "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ] }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudRunV2Service" }, "parameters": { "validateOnly": { "description": "Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.", "location": "query", "type": "boolean" }, "serviceId": { "type": "string", "location": "query", "description": "Optional. The unique identifier for the Service. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the service becomes {parent}/services/{service_id}. If not provided, the server will generate a unique `service_id`." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The location and project in which this service should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Only lowercase characters, digits, and hyphens." } }, "id": "run.projects.locations.services.create", "path": "v2/{+parent}/services", "parameterOrder": [ "parent" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/services", "description": "Creates a new Service in a given project and location." }, "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v2/{+name}", "parameters": { "etag": { "description": "A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", "location": "query", "type": "string" }, "name": { "required": true, "type": "string", "location": "path", "description": "Required. The full name of the Service. Format: projects/{project}/locations/{location}/services/{service}, where {project} can be project id or number.", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$" }, "validateOnly": { "location": "query", "description": "Indicates that the request should be validated without actually deleting any resources.", "type": "boolean" } }, "parameterOrder": [ "name" ], "id": "run.projects.locations.services.delete", "description": "Deletes a Service. This will cause the Service to stop serving traffic and will delete all revisions.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ] }, "getIamPolicy": { "path": "v2/{+resource}:getIamPolicy", "parameterOrder": [ "resource" ], "description": "Gets the IAM Access Control policy currently in effect for the given Cloud Run Service. This result does not include any inherited policies.", "response": { "$ref": "GoogleIamV1Policy" }, "parameters": { "options.requestedPolicyVersion": { "format": "int32", "location": "query", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" }, "resource": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string" } }, "id": "run.projects.locations.services.getIamPolicy", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "httpMethod": "GET" }, "setIamPolicy": { "response": { "$ref": "GoogleIamV1Policy" }, "id": "run.projects.locations.services.setIamPolicy", "parameterOrder": [ "resource" ], "description": "Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "path": "v2/{+resource}:setIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "httpMethod": "POST", "parameters": { "resource": { "required": true, "location": "path", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "type": "string" } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:setIamPolicy" }, "list": { "parameterOrder": [ "parent" ], "description": "Lists Services. Results are sorted by creation time, descending.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/services", "response": { "$ref": "GoogleCloudRunV2ListServicesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "id": "run.projects.locations.services.list", "httpMethod": "GET", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "A page token received from a previous call to ListServices. All other parameters must match." }, "parent": { "description": "Required. The location and project to list resources on. Location must be a valid Google Cloud region, and cannot be the \"-\" wildcard. Format: projects/{project}/locations/{location}, where {project} can be project id or number.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "showDeleted": { "location": "query", "description": "If true, returns deleted (but unexpired) resources along with active ones.", "type": "boolean" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Maximum number of Services to return in this call." } }, "path": "v2/{+parent}/services" }, "patch": { "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v2/{+name}", "id": "run.projects.locations.services.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "description": "Updates a Service.", "parameterOrder": [ "name" ], "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudRunV2Service" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", "parameters": { "validateOnly": { "location": "query", "type": "boolean", "description": "Indicates that the request should be validated and default values populated, without persisting the request or updating any resources." }, "allowMissing": { "location": "query", "type": "boolean", "description": "Optional. If set to true, and if the Service does not exist, it will create a new one. The caller must have 'run.services.create' permissions if this is set to true and the Service does not exist." }, "updateMask": { "format": "google-fieldmask", "description": "Optional. The list of fields to be updated.", "location": "query", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "type": "string", "description": "Identifier. The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id}", "location": "path", "required": true }, "forceNewRevision": { "type": "boolean", "location": "query", "description": "Optional. If set to true, a new revision will be created from the template even if the system doesn't detect any changes from the previously deployed revision. This may be useful for cases where the underlying resources need to be recreated or reinitialized. For example if the image is specified by label, but the underlying image digest has changed) or if the container performs deployment initialization work that needs to be performed again." } } }, "get": { "description": "Gets information about a Service.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "type": "string", "location": "path", "description": "Required. The full name of the Service. Format: projects/{project}/locations/{location}/services/{service}, where {project} can be project id or number.", "required": true } }, "response": { "$ref": "GoogleCloudRunV2Service" }, "id": "run.projects.locations.services.get", "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "path": "v2/{+name}", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}" } }, "resources": { "revisions": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/revisions/{revisionsId}", "parameterOrder": [ "name" ], "httpMethod": "GET", "path": "v2/{+name}", "description": "Gets information about a Revision.", "response": { "$ref": "GoogleCloudRunV2Revision" }, "id": "run.projects.locations.services.revisions.get", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/revisions/[^/]+$", "type": "string", "description": "Required. The full name of the Revision. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision}", "required": true } } }, "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run", "https://www.googleapis.com/auth/run.readonly" ], "id": "run.projects.locations.services.revisions.list", "description": "Lists Revisions from a given Service, or from a given location. Results are sorted by creation time, descending.", "parameters": { "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Maximum number of revisions to return in this call." }, "pageToken": { "type": "string", "location": "query", "description": "A page token received from a previous call to ListRevisions. All other parameters must match." }, "showDeleted": { "description": "If true, returns deleted (but unexpired) resources along with active ones.", "location": "query", "type": "boolean" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "description": "Required. The Service from which the Revisions should be listed. To list all Revisions across Services, use \"-\" instead of Service name. Format: projects/{project}/locations/{location}/services/{service}", "location": "path", "required": true } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/revisions", "path": "v2/{+parent}/revisions", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudRunV2ListRevisionsResponse" } }, "delete": { "description": "Deletes a Revision.", "path": "v2/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "parameters": { "validateOnly": { "description": "Indicates that the request should be validated without actually deleting any resources.", "location": "query", "type": "boolean" }, "etag": { "location": "query", "type": "string", "description": "A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates." }, "name": { "required": true, "description": "Required. The name of the Revision to delete. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision}", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/revisions/[^/]+$", "type": "string", "location": "path" } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/revisions/{revisionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "id": "run.projects.locations.services.revisions.delete", "httpMethod": "DELETE" }, "exportStatus": { "path": "v2/{+name}/{+operationId}:exportStatus", "response": { "$ref": "GoogleCloudRunV2ExportStatusResponse" }, "httpMethod": "GET", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/revisions/{revisionsId}/{revisionsId1}:exportStatus", "parameterOrder": [ "name", "operationId" ], "parameters": { "name": { "required": true, "description": "Required. The name of the resource of which image export operation status has to be fetched. Format: `projects/{project_id_or_number}/locations/{location}/services/{service}/revisions/{revision}` for Revision `projects/{project_id_or_number}/locations/{location}/jobs/{job}/executions/{execution}` for Execution", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/revisions/[^/]+$" }, "operationId": { "type": "string", "description": "Required. The operation id returned from ExportImage.", "required": true, "location": "path", "pattern": "^[^/]+$" } }, "id": "run.projects.locations.services.revisions.exportStatus", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/run" ], "description": "Read the status of an image export operation." } } } } } } } } } }, "revision": "20261009", "parameters": { "alt": { "default": "json", "enum": [ "json", "media", "proto" ], "type": "string", "description": "Data format for response.", "location": "query", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ] }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, "quotaUser": { "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.", "type": "string", "location": "query" }, "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "$.xgafv": { "description": "V1 error format.", "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "enum": [ "1", "2" ] }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "key": { "location": "query", "type": "string", "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." }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "type": "boolean", "location": "query", "default": "true" } }, "canonicalName": "Cloud Run", "documentationLink": "https://cloud.google.com/run/", "ownerName": "Google", "baseUrl": "https://run.googleapis.com/", "mtlsRootUrl": "https://run.mtls.googleapis.com/", "id": "run:v2", "fullyEncodeReservedExpansion": true, "batchPath": "batch", "title": "Cloud Run Admin API", "version_module": true, "schemas": { "GoogleCloudRunV2Overrides": { "id": "GoogleCloudRunV2Overrides", "type": "object", "description": "RunJob Overrides that contains Execution fields to be overridden.", "properties": { "delayExecution": { "type": "boolean", "description": "Optional. If true, the system will start the execution within the next 12 hours depending on available capacity." }, "taskCount": { "type": "integer", "description": "Optional. The desired number of tasks the execution should run. Will replace existing task_count value.", "format": "int32" }, "containerOverrides": { "type": "array", "items": { "$ref": "GoogleCloudRunV2ContainerOverride" }, "description": "Per container override specification." }, "timeout": { "description": "Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. Will replace existing timeout_seconds value.", "format": "google-duration", "type": "string" } } }, "GoogleCloudRunV2EnvVarSource": { "type": "object", "description": "EnvVarSource represents a source for the value of an EnvVar.", "id": "GoogleCloudRunV2EnvVarSource", "properties": { "secretKeyRef": { "description": "Selects a secret and a specific version from Cloud Secret Manager.", "$ref": "GoogleCloudRunV2SecretKeySelector" } } }, "GoogleDevtoolsCloudbuildV1GenericArtifact": { "id": "GoogleDevtoolsCloudbuildV1GenericArtifact", "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", "description": "Generic artifact to upload to Artifact Registry upon successful completion of all build steps." }, "GoogleCloudRunV2ContainerPort": { "type": "object", "description": "ContainerPort represents a network port in a single container.", "properties": { "name": { "description": "If specified, used to specify which protocol to use. Allowed values are \"http1\" and \"h2c\".", "type": "string" }, "containerPort": { "type": "integer", "format": "int32", "description": "Port number the container listens on. This must be a valid TCP port number, 0 \u003c container_port \u003c 65536." } }, "id": "GoogleCloudRunV2ContainerPort" }, "GoogleCloudRunV2NetworkInterface": { "type": "object", "id": "GoogleCloudRunV2NetworkInterface", "properties": { "tags": { "items": { "type": "string" }, "type": "array", "description": "Optional. Network tags applied to this Cloud Run resource." }, "network": { "description": "Optional. The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork.", "type": "string" }, "subnetwork": { "description": "Optional. The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.", "type": "string" } }, "description": "Direct VPC egress settings." }, "GoogleDevtoolsCloudbuildV1MavenArtifact": { "type": "object", "description": "A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.", "id": "GoogleDevtoolsCloudbuildV1MavenArtifact", "properties": { "artifactId": { "type": "string", "description": "Maven `artifactId` value used when uploading the artifact to Artifact Registry." }, "groupId": { "description": "Maven `groupId` value used when uploading the artifact to Artifact Registry.", "type": "string" }, "path": { "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.", "type": "string" }, "deployFolder": { "type": "string", "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." }, "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" }, "version": { "type": "string", "description": "Maven `version` value used when uploading the artifact to Artifact Registry." } } }, "GoogleIamV1AuditLogConfig": { "id": "GoogleIamV1AuditLogConfig", "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", "properties": { "logType": { "description": "The log type that this config enables.", "type": "string", "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ" ], "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", "Data writes. Example: CloudSQL Users create", "Data reads. Example: CloudSQL Users list" ] }, "exemptedMembers": { "items": { "type": "string" }, "type": "array", "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members." } }, "type": "object" }, "GoogleIamV1Policy": { "type": "object", "properties": { "auditConfigs": { "type": "array", "description": "Specifies cloud audit logging configuration for this policy.", "items": { "$ref": "GoogleIamV1AuditConfig" } }, "bindings": { "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "type": "array", "items": { "$ref": "GoogleIamV1Binding" } }, "version": { "format": "int32", "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" }, "etag": { "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "format": "byte", "type": "string" } }, "id": "GoogleIamV1Policy", "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/)." }, "GoogleDevtoolsCloudbuildV1UploadedMavenArtifact": { "properties": { "fileHashes": { "description": "Hash types and values of the Maven Artifact.", "$ref": "GoogleDevtoolsCloudbuildV1FileHashes" }, "pushTiming": { "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", "readOnly": true, "description": "Output only. Stores timing information for pushing the specified artifact." }, "uri": { "description": "URI of the uploaded artifact.", "type": "string" }, "artifactRegistryPackage": { "readOnly": true, "description": "Output only. Path to the artifact in Artifact Registry.", "type": "string" } }, "type": "object", "description": "A Maven artifact uploaded using the MavenArtifact directive.", "id": "GoogleDevtoolsCloudbuildV1UploadedMavenArtifact" }, "GoogleCloudRunV2MultiRegionSettings": { "description": "Settings for multi-region deployment.", "properties": { "regions": { "items": { "type": "string" }, "description": "Required. List of regions to deploy to, including primary region.", "type": "array" }, "multiRegionId": { "type": "string", "description": "Optional. System-generated unique id for the multi-region Service." } }, "type": "object", "id": "GoogleCloudRunV2MultiRegionSettings" }, "GoogleDevtoolsCloudbuildV1UploadedPythonPackage": { "id": "GoogleDevtoolsCloudbuildV1UploadedPythonPackage", "properties": { "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 Python Artifact.", "$ref": "GoogleDevtoolsCloudbuildV1FileHashes" }, "pushTiming": { "readOnly": true, "description": "Output only. Stores timing information for pushing the specified artifact.", "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan" } }, "description": "Artifact uploaded using the PythonPackage directive.", "type": "object" }, "GoogleCloudRunV2RevisionScalingStatus": { "description": "Effective settings for the current revision", "properties": { "desiredMinInstanceCount": { "type": "integer", "description": "The current number of min instances provisioned for this revision.", "format": "int32" } }, "type": "object", "id": "GoogleCloudRunV2RevisionScalingStatus" }, "GoogleDevtoolsCloudbuildV1Secret": { "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.", "properties": { "kmsKeyName": { "type": "string", "description": "Cloud KMS key name to use to decrypt these envs." }, "secretEnv": { "additionalProperties": { "type": "string", "format": "byte" }, "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." } }, "id": "GoogleDevtoolsCloudbuildV1Secret", "type": "object" }, "GoogleCloudRunV2InstanceSplitStatus": { "id": "GoogleCloudRunV2InstanceSplitStatus", "type": "object", "properties": { "revision": { "type": "string", "description": "Revision to which this instance split is assigned." }, "percent": { "description": "Specifies percent of the instance split to this Revision.", "format": "int32", "type": "integer" }, "type": { "description": "The allocation type for this instance split.", "enumDescriptions": [ "Unspecified instance allocation type.", "Allocates instances to the Service's latest ready Revision.", "Allocates instances to a Revision by name." ], "type": "string", "enum": [ "INSTANCE_SPLIT_ALLOCATION_TYPE_UNSPECIFIED", "INSTANCE_SPLIT_ALLOCATION_TYPE_LATEST", "INSTANCE_SPLIT_ALLOCATION_TYPE_REVISION" ] } }, "description": "Represents the observed state of a single `InstanceSplit` entry." }, "GoogleCloudRunV2Execution": { "properties": { "clientVersion": { "type": "string", "description": "Output only. Arbitrary version identifier for the API client.", "readOnly": true }, "labels": { "description": "Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels", "readOnly": true, "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string", "description": "Output only. The unique name of this Execution.", "readOnly": true }, "launchStage": { "enumDescriptions": [ "Do not use this default value.", "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the \"Deprecation Policy\" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." ], "description": "The least stable launch stage needed to create this resource, as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are used, this field will be BETA.", "type": "string", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", "UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED" ] }, "client": { "description": "Output only. Arbitrary identifier for the API client.", "type": "string", "readOnly": true }, "job": { "readOnly": true, "type": "string", "description": "Output only. The name of the parent Job." }, "runningCount": { "description": "Output only. The number of actively running tasks.", "format": "int32", "type": "integer", "readOnly": true }, "reconciling": { "description": "Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run.", "readOnly": true, "type": "boolean" }, "conditions": { "type": "array", "description": "Output only. The Condition of this Execution, containing its readiness status, and detailed error information in case it did not reach the desired state.", "readOnly": true, "items": { "$ref": "GoogleCloudRunV2Condition" } }, "observedGeneration": { "readOnly": true, "description": "Output only. The generation of this Execution. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", "type": "string", "format": "int64" }, "etag": { "type": "string", "readOnly": true, "description": "Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates." }, "expireTime": { "type": "string", "format": "google-datetime", "description": "Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.", "readOnly": true }, "template": { "readOnly": true, "$ref": "GoogleCloudRunV2TaskTemplate", "description": "Output only. The template used to create tasks for this execution." }, "retriedCount": { "format": "int32", "type": "integer", "description": "Output only. The number of tasks which have retried at least once.", "readOnly": true }, "creator": { "description": "Output only. Email address of the authenticated creator.", "type": "string", "readOnly": true }, "failedCount": { "type": "integer", "format": "int32", "readOnly": true, "description": "Output only. The number of tasks which reached phase Failed." }, "deleteTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.", "type": "string" }, "updateTime": { "type": "string", "description": "Output only. The last-modified time.", "format": "google-datetime", "readOnly": true }, "cancelledCount": { "readOnly": true, "format": "int32", "type": "integer", "description": "Output only. The number of tasks which reached phase Cancelled." }, "completionTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Represents time when the execution was completed. It is not guaranteed to be set in happens-before order across separate operations.", "type": "string" }, "satisfiesPzs": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "annotations": { "type": "object", "description": "Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "readOnly": true, "additionalProperties": { "type": "string" } }, "startTime": { "readOnly": true, "description": "Output only. Represents time when the execution started to run. It is not guaranteed to be set in happens-before order across separate operations.", "type": "string", "format": "google-datetime" }, "logUri": { "readOnly": true, "description": "Output only. URI where logs for this execution can be found in Cloud Console.", "type": "string" }, "succeededCount": { "format": "int32", "type": "integer", "readOnly": true, "description": "Output only. The number of tasks which reached phase Succeeded." }, "generation": { "description": "Output only. A number that monotonically increases every time the user modifies the desired state.", "type": "string", "readOnly": true, "format": "int64" }, "taskCount": { "description": "Output only. Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution.", "readOnly": true, "format": "int32", "type": "integer" }, "uid": { "type": "string", "description": "Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.", "readOnly": true }, "parallelism": { "type": "integer", "readOnly": true, "description": "Output only. Specifies the maximum desired number of tasks the execution should run at any given time. Must be \u003c= task_count. The actual number of tasks running in steady state will be less than this number when ((.spec.task_count - .status.successful) \u003c .spec.parallelism), i.e. when the work left to do is less than max parallelism.", "format": "int32" }, "createTime": { "description": "Output only. Represents time when the execution was acknowledged by the execution controller. It is not guaranteed to be set in happens-before order across separate operations.", "type": "string", "format": "google-datetime", "readOnly": true } }, "id": "GoogleCloudRunV2Execution", "type": "object", "description": "Execution represents the configuration of a single execution. A execution an immutable resource that references a container image which is run to completion." }, "UtilStatusProto": { "type": "object", "properties": { "canonicalCode": { "format": "int32", "description": "copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;", "type": "integer" }, "message": { "type": "string", "description": "Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3;" }, "space": { "description": "copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs", "type": "string" }, "messageSet": { "description": "message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5;", "$ref": "Proto2BridgeMessageSet" }, "code": { "type": "integer", "description": "Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1;", "format": "int32" } }, "description": "Wire-format for a Status object", "id": "UtilStatusProto" }, "GoogleCloudRunV2InstanceSplit": { "id": "GoogleCloudRunV2InstanceSplit", "type": "object", "properties": { "percent": { "description": "Specifies percent of the instance split to this Revision. This defaults to zero if unspecified.", "type": "integer", "format": "int32" }, "revision": { "type": "string", "description": "Revision to which to assign this portion of instances, if split allocation is by revision." }, "type": { "enumDescriptions": [ "Unspecified instance allocation type.", "Allocates instances to the Service's latest ready Revision.", "Allocates instances to a Revision by name." ], "type": "string", "enum": [ "INSTANCE_SPLIT_ALLOCATION_TYPE_UNSPECIFIED", "INSTANCE_SPLIT_ALLOCATION_TYPE_LATEST", "INSTANCE_SPLIT_ALLOCATION_TYPE_REVISION" ], "description": "The allocation type for this instance split." } }, "description": "Holds a single instance split entry for the Worker. Allocations can be done to a specific Revision name, or pointing to the latest Ready Revision." }, "GoogleCloudRunV2ListExecutionsResponse": { "description": "Response message containing a list of Executions.", "type": "object", "id": "GoogleCloudRunV2ListExecutionsResponse", "properties": { "executions": { "description": "The resulting list of Executions.", "items": { "$ref": "GoogleCloudRunV2Execution" }, "type": "array" }, "nextPageToken": { "description": "A token indicating there are more items than page_size. Use it in the next ListExecutions request to continue.", "type": "string" } } }, "GoogleDevtoolsCloudbuildV1FailureInfo": { "description": "A fatal problem encountered during the execution of the build.", "properties": { "detail": { "description": "Explains the failure issue in more detail using hard-coded text.", "type": "string" }, "type": { "description": "The name of the failure.", "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", "enum": [ "FAILURE_TYPE_UNSPECIFIED", "PUSH_FAILED", "PUSH_IMAGE_NOT_FOUND", "PUSH_NOT_AUTHORIZED", "LOGGING_FAILURE", "USER_BUILD_STEP", "FETCH_SOURCE_FAILED" ] } }, "type": "object", "id": "GoogleDevtoolsCloudbuildV1FailureInfo" }, "GoogleCloudRunV2ExportStatusResponse": { "properties": { "imageExportStatuses": { "type": "array", "items": { "$ref": "GoogleCloudRunV2ImageExportStatus" }, "description": "The status of each image export job." }, "operationState": { "enum": [ "OPERATION_STATE_UNSPECIFIED", "IN_PROGRESS", "FINISHED" ], "enumDescriptions": [ "State unspecified.", "Operation still in progress.", "Operation finished." ], "type": "string", "description": "Output only. The state of the overall export operation.", "readOnly": true }, "operationId": { "description": "The operation id.", "type": "string" } }, "description": "ExportStatusResponse contains the status of image export operation, with the status of each image export job.", "id": "GoogleCloudRunV2ExportStatusResponse", "type": "object" }, "GoogleDevtoolsCloudbuildV1TimeSpan": { "type": "object", "properties": { "endTime": { "format": "google-datetime", "description": "End of time span.", "type": "string" }, "startTime": { "type": "string", "description": "Start of time span.", "format": "google-datetime" } }, "id": "GoogleDevtoolsCloudbuildV1TimeSpan", "description": "Start and end times for a build execution phase." }, "GoogleDevtoolsCloudbuildV1BuildResourceUsage": { "properties": { "totalCpuDuration": { "readOnly": true, "description": "Output only. Total CPU execution time consumed across all cores during build execution.", "type": "string", "format": "google-duration" }, "peakMemoryUtilization": { "type": "number", "description": "Output only. The highest memory utilization ratio observed over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", "readOnly": true, "format": "float" }, "peakCpuUtilization": { "type": "number", "description": "Output only. The highest CPU utilization ratio across all vCPUs observed over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", "format": "float", "readOnly": true }, "averageCpuUtilization": { "description": "Output only. The average CPU utilization ratio across all vCPUs over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", "readOnly": true, "format": "float", "type": "number" }, "averageMemoryUtilization": { "format": "float", "type": "number", "description": "Output only. The average memory utilization ratio over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", "readOnly": true } }, "description": "Aggregated/summary metrics over the entire build lifecycle.", "id": "GoogleDevtoolsCloudbuildV1BuildResourceUsage", "type": "object" }, "GoogleDevtoolsCloudbuildV1SourceProvenance": { "description": "Provenance of the source. Ways to find the original source, or verify that some source was used for this build.", "type": "object", "id": "GoogleDevtoolsCloudbuildV1SourceProvenance", "properties": { "resolvedStorageSource": { "description": "A copy of the build's `source.storage_source`, if exists, with any generations resolved.", "$ref": "GoogleDevtoolsCloudbuildV1StorageSource" }, "resolvedConnectedRepository": { "$ref": "GoogleDevtoolsCloudbuildV1ConnectedRepository", "description": "Output only. A copy of the build's `source.connected_repository`, if exists, with any revisions resolved.", "readOnly": true }, "fileHashes": { "type": "object", "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.", "additionalProperties": { "$ref": "GoogleDevtoolsCloudbuildV1FileHashes" }, "readOnly": true }, "resolvedStorageSourceManifest": { "$ref": "GoogleDevtoolsCloudbuildV1StorageSourceManifest", "description": "A copy of the build's `source.storage_source_manifest`, if exists, with any revisions resolved. This feature is in Preview." }, "resolvedGitSource": { "readOnly": true, "description": "Output only. A copy of the build's `source.git_source`, if exists, with any revisions resolved.", "$ref": "GoogleDevtoolsCloudbuildV1GitSource" }, "resolvedRepoSource": { "description": "A copy of the build's `source.repo_source`, if exists, with any revisions resolved.", "$ref": "GoogleDevtoolsCloudbuildV1RepoSource" } } }, "GoogleCloudRunV2BinaryAuthorization": { "type": "object", "description": "Settings for Binary Authorization feature.", "id": "GoogleCloudRunV2BinaryAuthorization", "properties": { "useDefault": { "type": "boolean", "description": "Optional. If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled." }, "breakglassJustification": { "description": "Optional. If present, indicates to use Breakglass using this justification. If use_default is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass", "type": "string" }, "policy": { "description": "Optional. The path to a binary authorization policy. Format: `projects/{project}/platforms/cloudRun/{policy-name}`", "type": "string" } } }, "GoogleCloudRunV2TCPSocketAction": { "id": "GoogleCloudRunV2TCPSocketAction", "description": "TCPSocketAction describes an action based on opening a socket", "type": "object", "properties": { "port": { "type": "integer", "format": "int32", "description": "Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort." } } }, "GoogleDevtoolsCloudbuildV1ApprovalConfig": { "id": "GoogleDevtoolsCloudbuildV1ApprovalConfig", "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" } }, "description": "ApprovalConfig describes configuration for manual approval of a build.", "type": "object" }, "GoogleCloudRunV2WorkerPool": { "id": "GoogleCloudRunV2WorkerPool", "type": "object", "properties": { "annotations": { "type": "object", "description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool. This field follows Kubernetes annotations' namespacing, limits, and rules.", "additionalProperties": { "type": "string" } }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Reserved for future use.", "type": "boolean" }, "customAudiences": { "description": "Deprecated: Not supported, and ignored by Cloud Run.", "deprecated": true, "type": "array", "items": { "type": "string" } }, "deleteTime": { "readOnly": true, "type": "string", "description": "Output only. The deletion time. It is only populated as a response to a Delete request.", "format": "google-datetime" }, "scaling": { "description": "Optional. Specifies worker-pool-level scaling settings", "$ref": "GoogleCloudRunV2WorkerPoolScaling" }, "threatDetectionEnabled": { "description": "Output only. Indicates whether Cloud Run Threat Detection monitoring is enabled for the parent project of this worker pool.", "readOnly": true, "type": "boolean" }, "instanceSplitStatuses": { "readOnly": true, "description": "Output only. Detailed status information for corresponding instance splits. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", "type": "array", "items": { "$ref": "GoogleCloudRunV2InstanceSplitStatus" } }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool.", "type": "object" }, "client": { "type": "string", "description": "Arbitrary identifier for the API client." }, "updateTime": { "type": "string", "description": "Output only. The last-modified time.", "format": "google-datetime", "readOnly": true }, "description": { "description": "User-provided description of the WorkerPool. This field currently has a 512-character limit.", "type": "string" }, "template": { "$ref": "GoogleCloudRunV2WorkerPoolRevisionTemplate", "description": "Required. The template used to create revisions for this WorkerPool." }, "terminalCondition": { "readOnly": true, "description": "Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", "$ref": "GoogleCloudRunV2Condition" }, "creator": { "description": "Output only. Email address of the authenticated creator.", "type": "string", "readOnly": true }, "generation": { "description": "Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.", "readOnly": true, "format": "int64", "type": "string" }, "createTime": { "description": "Output only. The creation time.", "readOnly": true, "format": "google-datetime", "type": "string" }, "instanceSplits": { "type": "array", "items": { "$ref": "GoogleCloudRunV2InstanceSplit" }, "description": "Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest `Ready` Revision." }, "lastModifier": { "description": "Output only. Email address of the last authenticated modifier.", "type": "string", "readOnly": true }, "latestReadyRevision": { "readOnly": true, "description": "Output only. Name of the latest revision that is serving workloads. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", "type": "string" }, "etag": { "description": "Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", "type": "string" }, "binaryAuthorization": { "description": "Optional. Settings for the Binary Authorization feature.", "$ref": "GoogleCloudRunV2BinaryAuthorization" }, "observedGeneration": { "type": "string", "description": "Output only. The generation of this WorkerPool currently serving workloads. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.", "format": "int64", "readOnly": true }, "name": { "description": "The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: `projects/{project}/locations/{location}/workerPools/{worker_id}`", "type": "string" }, "uid": { "readOnly": true, "type": "string", "description": "Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted." }, "conditions": { "description": "Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudRunV2Condition" } }, "launchStage": { "description": "Optional. The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.", "enumDescriptions": [ "Do not use this default value.", "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the \"Deprecation Policy\" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." ], "type": "string", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", "UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED" ] }, "expireTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. For a deleted resource, the time after which it will be permamently deleted." }, "clientVersion": { "description": "Arbitrary version identifier for the API client.", "type": "string" }, "reconciling": { "readOnly": true, "type": "boolean", "description": "Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `instance_split_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `instance_splits` and `instance_split_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `instance_split_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`." }, "latestCreatedRevision": { "description": "Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", "type": "string", "readOnly": true } }, "description": "WorkerPool acts as a top-level container that manages a set of configurations and revision templates which implement a pull-based workload. WorkerPool exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership." }, "GoogleLongrunningOperation": { "type": "object", "id": "GoogleLongrunningOperation", "properties": { "name": { "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}`.", "type": "string" }, "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." }, "response": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "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`." }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "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.", "type": "object" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" } }, "description": "This resource represents a long-running operation that is the result of a network API call." }, "GoogleCloudRunV2Service": { "type": "object", "properties": { "trafficStatuses": { "type": "array", "description": "Output only. Detailed status information for corresponding traffic targets. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", "readOnly": true, "items": { "$ref": "GoogleCloudRunV2TrafficTargetStatus" } }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. The last-modified time.", "format": "google-datetime" }, "iapEnabled": { "description": "Optional. IAP settings on the Service.", "type": "boolean" }, "buildConfig": { "description": "Optional. Configuration for building a Cloud Run function.", "$ref": "GoogleCloudRunV2BuildConfig" }, "deleteTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The deletion time. It is only populated as a response to a Delete request." }, "generation": { "type": "string", "description": "Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.", "readOnly": true, "format": "int64" }, "description": { "description": "User-provided description of the Service. This field currently has a 512-character limit.", "type": "string" }, "lastModifier": { "readOnly": true, "description": "Output only. Email address of the last authenticated modifier.", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The creation time.", "format": "google-datetime", "type": "string" }, "clientVersion": { "type": "string", "description": "Arbitrary version identifier for the API client." }, "terminalCondition": { "readOnly": true, "$ref": "GoogleCloudRunV2Condition", "description": "Output only. The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run." }, "uri": { "readOnly": true, "type": "string", "description": "Output only. The main URI in which this Service is serving traffic." }, "sshEnabled": { "type": "boolean", "description": "Optional. Enables SSH access to the Service." }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 Service. This field follows Kubernetes annotations' namespacing, limits, and rules." }, "urls": { "type": "array", "readOnly": true, "items": { "type": "string" }, "description": "Output only. All URLs serving traffic for this Service." }, "defaultUriDisabled": { "description": "Optional. Disables public resolution of the default URI of this service.", "type": "boolean" }, "customAudiences": { "description": "One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.", "items": { "type": "string" }, "type": "array" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service." }, "client": { "type": "string", "description": "Arbitrary identifier for the API client." }, "traffic": { "description": "Optional. Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest `Ready` Revision.", "type": "array", "items": { "$ref": "GoogleCloudRunV2TrafficTarget" } }, "latestReadyRevision": { "type": "string", "readOnly": true, "description": "Output only. Name of the latest revision that is serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run." }, "scaling": { "description": "Optional. Specifies service-level scaling settings", "$ref": "GoogleCloudRunV2ServiceScaling" }, "reconciling": { "description": "Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revision`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in `terminal_condition` and `conditions`.", "readOnly": true, "type": "boolean" }, "name": { "description": "Identifier. The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id}", "type": "string" }, "binaryAuthorization": { "description": "Optional. Settings for the Binary Authorization feature.", "$ref": "GoogleCloudRunV2BinaryAuthorization" }, "uid": { "description": "Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.", "readOnly": true, "type": "string" }, "invokerIamDisabled": { "type": "boolean", "description": "Optional. Disables IAM permission check for run.routes.invoke for callers of this service. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check." }, "observedGeneration": { "type": "string", "format": "int64", "description": "Output only. The generation of this Service currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.", "readOnly": true }, "ingress": { "enumDescriptions": [ "Unspecified", "All inbound traffic is allowed.", "Only internal traffic is allowed.", "Both internal and Google Cloud Load Balancer traffic is allowed.", "No ingress traffic is allowed." ], "type": "string", "enum": [ "INGRESS_TRAFFIC_UNSPECIFIED", "INGRESS_TRAFFIC_ALL", "INGRESS_TRAFFIC_INTERNAL_ONLY", "INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER", "INGRESS_TRAFFIC_NONE" ], "description": "Optional. Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active." }, "threatDetectionEnabled": { "readOnly": true, "type": "boolean", "description": "Output only. True if Cloud Run Threat Detection monitoring is enabled for the parent project of this Service." }, "launchStage": { "enumDescriptions": [ "Do not use this default value.", "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the \"Deprecation Policy\" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." ], "type": "string", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", "UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED" ], "description": "Optional. The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output." }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "etag": { "description": "Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", "type": "string" }, "functionalType": { "enumDescriptions": [ "Specifies that the functional type is unspecified.", "Represents an AGENT functional type.", "Represents an MCP_SERVER functional type." ], "description": "Optional. The functional type of the Service.", "type": "string", "enum": [ "FUNCTIONAL_TYPE_UNSPECIFIED", "FUNCTIONAL_TYPE_AGENT", "FUNCTIONAL_TYPE_MCP_SERVER" ] }, "conditions": { "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudRunV2Condition" }, "description": "Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run." }, "latestCreatedRevision": { "readOnly": true, "type": "string", "description": "Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run." }, "multiRegionSettings": { "$ref": "GoogleCloudRunV2MultiRegionSettings", "description": "Optional. Settings for multi-region deployment." }, "expireTime": { "format": "google-datetime", "description": "Output only. For a deleted resource, the time after which it will be permanently deleted.", "readOnly": true, "type": "string" }, "template": { "description": "Required. The template used to create revisions for this Service.", "$ref": "GoogleCloudRunV2RevisionTemplate" }, "creator": { "description": "Output only. Email address of the authenticated creator.", "type": "string", "readOnly": true } }, "description": "Service acts as a top-level container that manages a set of configurations and revision templates which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.", "id": "GoogleCloudRunV2Service" }, "GoogleDevtoolsCloudbuildV1BuildOptions": { "id": "GoogleDevtoolsCloudbuildV1BuildOptions", "type": "object", "properties": { "substitutionOption": { "type": "string", "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." ], "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." }, "pool": { "$ref": "GoogleDevtoolsCloudbuildV1PoolOption", "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." }, "workerPool": { "type": "string", "description": "This field deprecated; please use `pool.name` instead.", "deprecated": true }, "env": { "items": { "type": "string" }, "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\".", "type": "array" }, "secretEnv": { "items": { "type": "string" }, "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" }, "diskSizeGb": { "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.", "format": "int64", "type": "string" }, "requestedVerifyOption": { "enumDescriptions": [ "Not a verifiable build (the default).", "Build must be verified.", "Build verification is best effort. If provenance generation fails, the build will still succeed." ], "type": "string", "enum": [ "NOT_VERIFIED", "VERIFIED", "BEST_EFFORT" ], "description": "Requested verifiability options." }, "logging": { "enumDeprecated": [ false, false, false, true, false, false ], "enum": [ "LOGGING_UNSPECIFIED", "LEGACY", "GCS_ONLY", "STACKDRIVER_ONLY", "CLOUD_LOGGING_ONLY", "NONE" ], "type": "string", "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." ], "description": "Option to specify the logging mode, which determines if and where build logs are stored." }, "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." }, "volumes": { "type": "array", "items": { "$ref": "GoogleDevtoolsCloudbuildV1Volume" }, "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." }, "defaultLogsBucketBehavior": { "type": "string", "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." ], "description": "Optional. Option to specify how default logs buckets are setup." }, "resolvedWorkerRelease": { "readOnly": true, "description": "Output only. Worker release resolved from the release channel.", "type": "string" }, "logStreamingOption": { "type": "string", "enum": [ "STREAM_DEFAULT", "STREAM_ON", "STREAM_OFF" ], "description": "Option to define build log streaming behavior to Cloud Storage.", "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." ] }, "workerRelease": { "description": "Optional. Option to specify which release or release channel (rapid|regular|stable) to use to run this build.", "type": "string" }, "machineType": { "description": "Compute Engine machine type on which to run the build.", "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." ], "type": "string", "enumDeprecated": [ false, true, true, false, false, false, false ], "enum": [ "UNSPECIFIED", "N1_HIGHCPU_8", "N1_HIGHCPU_32", "E2_HIGHCPU_8", "E2_HIGHCPU_32", "E2_MEDIUM", "E2_STANDARD_2" ] }, "pubsubTopic": { "description": "Optional. Option to specify the Pub/Sub topic to receive build status updates.", "type": "string" }, "sourceProvenanceHash": { "type": "array", "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." ], "type": "string", "enum": [ "NONE", "SHA256", "MD5", "GO_MODULE_H1", "SHA512", "DIRSUM_SHA256" ] }, "description": "Requested hash for SourceProvenance." }, "automapSubstitutions": { "type": "boolean", "description": "Option to include built-in and custom substitutions as env variables for all build steps." }, "enableStructuredLogging": { "type": "boolean", "description": "Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs." } }, "description": "Optional arguments to enable specific features of builds." }, "GoogleDevtoolsCloudbuildV1Results": { "type": "object", "id": "GoogleDevtoolsCloudbuildV1Results", "properties": { "goModules": { "items": { "$ref": "GoogleDevtoolsCloudbuildV1UploadedGoModule" }, "type": "array", "description": "Optional. Go module artifacts uploaded to Artifact Registry at the end of the build." }, "npmPackages": { "items": { "$ref": "GoogleDevtoolsCloudbuildV1UploadedNpmPackage" }, "description": "Npm packages uploaded to Artifact Registry at the end of the build.", "type": "array" }, "images": { "items": { "$ref": "GoogleDevtoolsCloudbuildV1BuiltImage" }, "description": "Container images that were built as a part of the build.", "type": "array" }, "genericArtifacts": { "type": "array", "readOnly": true, "description": "Output only. Generic artifacts uploaded to Artifact Registry at the end of the build.", "items": { "$ref": "GoogleDevtoolsCloudbuildV1UploadedGenericArtifact" } }, "mavenArtifacts": { "description": "Maven artifacts uploaded to Artifact Registry at the end of the build.", "type": "array", "items": { "$ref": "GoogleDevtoolsCloudbuildV1UploadedMavenArtifact" } }, "buildStepOutputs": { "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.", "type": "array", "items": { "format": "byte", "type": "string" } }, "artifactManifest": { "type": "string", "description": "Path to the artifact manifest for non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage." }, "buildStepImages": { "description": "List of build step digests, in the order corresponding to build step indices.", "type": "array", "items": { "type": "string" } }, "numArtifacts": { "description": "Number of non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.", "format": "int64", "type": "string" }, "buildStepResults": { "additionalProperties": { "$ref": "GoogleDevtoolsCloudbuildV1BuildStepResults" }, "description": "Results for build steps. step_id -\u003e ", "type": "object" }, "artifactTiming": { "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", "description": "Time to push all non-container artifacts to Cloud Storage." }, "pythonPackages": { "description": "Python artifacts uploaded to Artifact Registry at the end of the build.", "type": "array", "items": { "$ref": "GoogleDevtoolsCloudbuildV1UploadedPythonPackage" } }, "resourceUsage": { "$ref": "GoogleDevtoolsCloudbuildV1BuildResourceUsage", "description": "Output only. Aggregated metrics for the build.", "readOnly": true } }, "description": "Artifacts created by the build pipeline." }, "GoogleCloudRunV2EnvVar": { "id": "GoogleCloudRunV2EnvVar", "properties": { "value": { "type": "string", "description": "Literal value of the environment variable. Defaults to \"\", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run." }, "valueSource": { "description": "Source for the environment variable's value.", "$ref": "GoogleCloudRunV2EnvVarSource" }, "name": { "type": "string", "description": "Required. Name of the environment variable. Must not exceed 32768 characters." } }, "description": "EnvVar represents an environment variable present in a Container.", "type": "object" }, "GoogleCloudRunV2ImageExportStatus": { "type": "object", "description": "The status of an image export job.", "properties": { "exportJobState": { "description": "Output only. Has the image export job finished (regardless of successful or failure).", "type": "string", "readOnly": true, "enum": [ "EXPORT_JOB_STATE_UNSPECIFIED", "IN_PROGRESS", "FINISHED" ], "enumDescriptions": [ "State unspecified.", "Job still in progress.", "Job finished." ] }, "status": { "description": "The status of the export task if done.", "$ref": "UtilStatusProto" }, "exportedImageDigest": { "description": "The exported image ID as it will appear in Artifact Registry.", "type": "string" }, "tag": { "type": "string", "description": "The image tag as it will appear in Artifact Registry." } }, "id": "GoogleCloudRunV2ImageExportStatus" }, "GoogleDevtoolsCloudbuildV1GitSourceDependency": { "id": "GoogleDevtoolsCloudbuildV1GitSourceDependency", "properties": { "repository": { "description": "Required. The kind of repo (url or dev connect).", "$ref": "GoogleDevtoolsCloudbuildV1GitSourceRepository" }, "recurseSubmodules": { "type": "boolean", "description": "Optional. True if submodules should be fetched too (default false)." }, "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." }, "destPath": { "description": "Required. Where should the files be placed on the worker.", "type": "string" }, "depth": { "type": "string", "description": "Optional. How much history should be fetched for the build (default 1, -1 for all history).", "format": "int64" }, "revision": { "description": "Required. The revision that we will fetch the repo at.", "type": "string" } }, "description": "Represents a git repository as a build dependency.", "type": "object" }, "GoogleIamV1TestIamPermissionsRequest": { "type": "object", "properties": { "permissions": { "items": { "type": "string" }, "type": "array", "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)." } }, "description": "Request message for `TestIamPermissions` method.", "id": "GoogleIamV1TestIamPermissionsRequest" }, "GoogleDevtoolsCloudbuildV1GitConfig": { "properties": { "http": { "description": "Configuration for HTTP related git operations.", "$ref": "GoogleDevtoolsCloudbuildV1HttpConfig" } }, "id": "GoogleDevtoolsCloudbuildV1GitConfig", "type": "object", "description": "GitConfig is a configuration for git operations." }, "GoogleCloudRunV2Task": { "id": "GoogleCloudRunV2Task", "type": "object", "description": "Task represents a single run of a container to completion.", "properties": { "deleteTime": { "format": "google-datetime", "type": "string", "description": "Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.", "readOnly": true }, "executionEnvironment": { "type": "string", "enum": [ "EXECUTION_ENVIRONMENT_UNSPECIFIED", "EXECUTION_ENVIRONMENT_GEN1", "EXECUTION_ENVIRONMENT_GEN2" ], "enumDescriptions": [ "Unspecified", "Uses the First Generation environment.", "Uses Second Generation environment." ], "description": "The execution environment being used to host this Task." }, "reconciling": { "description": "Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run.", "readOnly": true, "type": "boolean" }, "encryptionKey": { "type": "string", "readOnly": true, "description": "Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek" }, "updateTime": { "description": "Output only. The last-modified time.", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { "description": "Output only. The unique name of this Task.", "type": "string", "readOnly": true }, "completionTime": { "description": "Output only. Represents time when the Task was completed. It is not guaranteed to be set in happens-before order across separate operations.", "type": "string", "format": "google-datetime", "readOnly": true }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "job": { "type": "string", "readOnly": true, "description": "Output only. The name of the parent Job." }, "scheduledTime": { "description": "Output only. Represents time when the task was scheduled to run by the system. It is not guaranteed to be set in happens-before order across separate operations.", "readOnly": true, "type": "string", "format": "google-datetime" }, "maxRetries": { "type": "integer", "format": "int32", "description": "Number of retries allowed per Task, before marking this Task failed." }, "createTime": { "description": "Output only. Represents time when the task was created by the system. It is not guaranteed to be set in happens-before order across separate operations.", "readOnly": true, "type": "string", "format": "google-datetime" }, "observedGeneration": { "type": "string", "description": "Output only. The generation of this Task. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run.", "format": "int64", "readOnly": true }, "logUri": { "type": "string", "readOnly": true, "description": "Output only. URI where logs for this execution can be found in Cloud Console." }, "volumes": { "description": "A list of Volumes to make available to containers.", "type": "array", "items": { "$ref": "GoogleCloudRunV2Volume" } }, "etag": { "description": "Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", "type": "string", "readOnly": true }, "generation": { "format": "int64", "type": "string", "readOnly": true, "description": "Output only. A number that monotonically increases every time the user modifies the desired state." }, "index": { "format": "int32", "readOnly": true, "type": "integer", "description": "Output only. Index of the Task, unique per execution, and beginning at 0." }, "startTime": { "description": "Output only. Represents time when the task started to run. It is not guaranteed to be set in happens-before order across separate operations.", "format": "google-datetime", "type": "string", "readOnly": true }, "serviceAccount": { "type": "string", "description": "Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account." }, "labels": { "additionalProperties": { "type": "string" }, "description": "Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels", "type": "object", "readOnly": true }, "workloadIdentityConfig": { "$ref": "GoogleCloudRunV2WorkloadIdentityConfig", "description": "Optional. The Task's workload identity settings." }, "timeout": { "description": "Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.", "type": "string", "format": "google-duration" }, "expireTime": { "description": "Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.", "format": "google-datetime", "type": "string", "readOnly": true }, "retried": { "description": "Output only. The number of times this Task was retried. Tasks are retried when they fail up to the maxRetries limit.", "format": "int32", "readOnly": true, "type": "integer" }, "uid": { "type": "string", "description": "Output only. Server assigned unique identifier for the Task. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.", "readOnly": true }, "execution": { "description": "Output only. The name of the parent Execution.", "type": "string", "readOnly": true }, "conditions": { "readOnly": true, "description": "Output only. The Condition of this Task, containing its readiness status, and detailed error information in case it did not reach the desired state.", "type": "array", "items": { "$ref": "GoogleCloudRunV2Condition" } }, "lastAttemptResult": { "description": "Output only. Result of the last attempt of this Task.", "$ref": "GoogleCloudRunV2TaskAttemptResult", "readOnly": true }, "gpuZonalRedundancyDisabled": { "readOnly": true, "type": "boolean", "description": "Optional. Output only. True if GPU zonal redundancy is disabled on this task." }, "containers": { "description": "Holds the single container that defines the unit of execution for this task.", "items": { "$ref": "GoogleCloudRunV2Container" }, "type": "array" }, "annotations": { "readOnly": true, "additionalProperties": { "type": "string" }, "description": "Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "type": "object" }, "nodeSelector": { "readOnly": true, "$ref": "GoogleCloudRunV2NodeSelector", "description": "Output only. The node selector for the task." }, "vpcAccess": { "$ref": "GoogleCloudRunV2VpcAccess", "description": "Output only. VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.", "readOnly": true } } }, "GoogleDevtoolsCloudbuildV1Build": { "type": "object", "properties": { "projectId": { "description": "Output only. ID of the project.", "readOnly": true, "type": "string" }, "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" }, "options": { "$ref": "GoogleDevtoolsCloudbuildV1BuildOptions", "description": "Special options for this build." }, "secrets": { "items": { "$ref": "GoogleDevtoolsCloudbuildV1Secret" }, "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" }, "artifacts": { "description": "Artifacts produced by the build that should be uploaded upon successful completion of all build steps.", "$ref": "GoogleDevtoolsCloudbuildV1Artifacts" }, "finishTime": { "readOnly": true, "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.", "type": "string", "format": "google-datetime" }, "logUrl": { "type": "string", "readOnly": true, "description": "Output only. URL to logs for this build in Google Cloud Console." }, "source": { "description": "Optional. The location of the source files to build.", "$ref": "GoogleDevtoolsCloudbuildV1Source" }, "sourceProvenance": { "description": "Output only. A permanent fixed identifier for source.", "readOnly": true, "$ref": "GoogleDevtoolsCloudbuildV1SourceProvenance" }, "images": { "type": "array", "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`.", "items": { "type": "string" } }, "name": { "description": "Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service.", "type": "string", "readOnly": true }, "availableSecrets": { "description": "Secrets and secret environment variables.", "$ref": "GoogleDevtoolsCloudbuildV1Secrets" }, "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" }, "status": { "enum": [ "STATUS_UNKNOWN", "PENDING", "QUEUED", "WORKING", "SUCCESS", "FAILURE", "INTERNAL_ERROR", "TIMEOUT", "CANCELLED", "EXPIRED" ], "description": "Output only. Status of the build.", "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`." ], "readOnly": true, "type": "string" }, "buildTriggerId": { "description": "Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.", "type": "string", "readOnly": true }, "tags": { "type": "array", "description": "Tags for annotation of a `Build`. These are not docker tags.", "items": { "type": "string" } }, "substitutions": { "description": "Substitutions data for `Build` resource.", "additionalProperties": { "type": "string" }, "type": "object" }, "timing": { "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.", "type": "object", "readOnly": true, "additionalProperties": { "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan" } }, "createTime": { "description": "Output only. Time at which the request to create the build was received.", "format": "google-datetime", "readOnly": true, "type": "string" }, "approval": { "description": "Output only. Describes this build's approval configuration, status, and result.", "$ref": "GoogleDevtoolsCloudbuildV1BuildApproval", "readOnly": true }, "warnings": { "type": "array", "readOnly": true, "description": "Output only. Non-fatal problems encountered during the execution of the build.", "items": { "$ref": "GoogleDevtoolsCloudbuildV1Warning" } }, "dependencies": { "description": "Optional. Dependencies that the Cloud Build worker will fetch before executing user steps.", "type": "array", "items": { "$ref": "GoogleDevtoolsCloudbuildV1Dependency" } }, "gitConfig": { "$ref": "GoogleDevtoolsCloudbuildV1GitConfig", "description": "Optional. Configuration for git operations." }, "failureInfo": { "description": "Output only. Contains information about the build when status=FAILURE.", "readOnly": true, "$ref": "GoogleDevtoolsCloudbuildV1FailureInfo" }, "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." }, "steps": { "items": { "$ref": "GoogleDevtoolsCloudbuildV1BuildStep" }, "type": "array", "description": "Required. The operations to be performed on the workspace." }, "startTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Time at which execution of the build was started." }, "results": { "$ref": "GoogleDevtoolsCloudbuildV1Results", "description": "Output only. Results of the build.", "readOnly": true }, "timeout": { "format": "google-duration", "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.", "type": "string" }, "statusDetail": { "readOnly": true, "description": "Output only. Customer-readable message about the current status.", "type": "string" }, "id": { "type": "string", "description": "Output only. Unique identifier of the build.", "readOnly": true } }, "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.", "id": "GoogleDevtoolsCloudbuildV1Build" }, "GoogleDevtoolsCloudbuildV1GitSourceRepository": { "description": "A repository for a git source.", "id": "GoogleDevtoolsCloudbuildV1GitSourceRepository", "properties": { "developerConnect": { "type": "string", "description": "The Developer Connect Git repository link formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`" }, "url": { "description": "Location of the Git repository.", "type": "string" } }, "type": "object" }, "GoogleDevtoolsCloudbuildV1Source": { "description": "Location of the source in a supported storage service.", "properties": { "storageSourceManifest": { "$ref": "GoogleDevtoolsCloudbuildV1StorageSourceManifest", "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)." }, "developerConnectConfig": { "$ref": "GoogleDevtoolsCloudbuildV1DeveloperConnectConfig", "description": "If provided, get the source from this Developer Connect config." }, "gitSource": { "description": "If provided, get the source from this Git repository.", "$ref": "GoogleDevtoolsCloudbuildV1GitSource" }, "connectedRepository": { "description": "Optional. If provided, get the source from this 2nd-gen Google Cloud Build repository resource.", "$ref": "GoogleDevtoolsCloudbuildV1ConnectedRepository" }, "storageSource": { "$ref": "GoogleDevtoolsCloudbuildV1StorageSource", "description": "If provided, get the source from this location in Cloud Storage." }, "repoSource": { "description": "If provided, get the source from this location in a Cloud Source Repository.", "$ref": "GoogleDevtoolsCloudbuildV1RepoSource" } }, "id": "GoogleDevtoolsCloudbuildV1Source", "type": "object" }, "GoogleCloudRunV2HTTPHeader": { "id": "GoogleCloudRunV2HTTPHeader", "properties": { "value": { "type": "string", "description": "Optional. The header field value" }, "name": { "type": "string", "description": "Required. The header field name" } }, "description": "HTTPHeader describes a custom header to be used in HTTP probes", "type": "object" }, "GoogleCloudRunV2RevisionTemplate": { "description": "RevisionTemplate describes the data a revision should have when created from a template.", "type": "object", "properties": { "revision": { "type": "string", "description": "Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name." }, "executionEnvironment": { "description": "Optional. The sandbox environment to host this Revision.", "enumDescriptions": [ "Unspecified", "Uses the First Generation environment.", "Uses Second Generation environment." ], "type": "string", "enum": [ "EXECUTION_ENVIRONMENT_UNSPECIFIED", "EXECUTION_ENVIRONMENT_GEN1", "EXECUTION_ENVIRONMENT_GEN2" ] }, "workloadIdentityConfig": { "description": "Optional. The Revision's workload identity settings.", "$ref": "GoogleCloudRunV2WorkloadIdentityConfig" }, "timeout": { "type": "string", "format": "google-duration", "description": "Optional. Max allowed time for an instance to respond to a request." }, "encryptionKeyRevocationAction": { "type": "string", "enum": [ "ENCRYPTION_KEY_REVOCATION_ACTION_UNSPECIFIED", "PREVENT_NEW", "SHUTDOWN" ], "description": "Optional. The action to take if the encryption key is revoked.", "enumDescriptions": [ "Unspecified", "Prevents the creation of new instances.", "Shuts down existing instances, and prevents creation of new ones." ] }, "containers": { "items": { "$ref": "GoogleCloudRunV2Container" }, "type": "array", "description": "Holds the list which define the units of execution for this Revision." }, "client": { "type": "string", "description": "Optional. Arbitrary identifier for the API client." }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate." }, "serviceAccount": { "description": "Optional. Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account.", "type": "string" }, "serviceMesh": { "$ref": "GoogleCloudRunV2ServiceMesh", "description": "Optional. Enables service mesh connectivity." }, "healthCheckDisabled": { "description": "Optional. Disables health checking containers during deployment.", "type": "boolean" }, "encryptionKey": { "description": "A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek", "type": "string" }, "scaling": { "description": "Optional. Scaling settings for this Revision.", "$ref": "GoogleCloudRunV2RevisionScaling" }, "volumes": { "description": "Optional. A list of Volumes to make available to containers.", "type": "array", "items": { "$ref": "GoogleCloudRunV2Volume" } }, "vpcAccess": { "description": "Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.", "$ref": "GoogleCloudRunV2VpcAccess" }, "annotations": { "description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 RevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.", "type": "object", "additionalProperties": { "type": "string" } }, "maxInstanceRequestConcurrency": { "format": "int32", "type": "integer", "description": "Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, concurrency defaults to 80 when requested `CPU \u003e= 1` and defaults to 1 when requested `CPU \u003c 1`." }, "encryptionKeyShutdownDuration": { "format": "google-duration", "description": "Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.", "type": "string" }, "clientVersion": { "type": "string", "description": "Optional. Arbitrary version identifier for the API client." }, "gpuZonalRedundancyDisabled": { "type": "boolean", "description": "Optional. True if GPU zonal redundancy is disabled on this revision." }, "sessionAffinity": { "type": "boolean", "description": "Optional. Enable session affinity." }, "nodeSelector": { "description": "Optional. The node selector for the revision template.", "$ref": "GoogleCloudRunV2NodeSelector" } }, "id": "GoogleCloudRunV2RevisionTemplate" }, "GoogleCloudRunV2SecretVolumeSource": { "description": "The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret.", "type": "object", "id": "GoogleCloudRunV2SecretVolumeSource", "properties": { "items": { "type": "array", "items": { "$ref": "GoogleCloudRunV2VersionToPath" }, "description": "If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version." }, "secret": { "type": "string", "description": "Required. The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project." }, "defaultMode": { "description": "Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.", "type": "integer", "format": "int32" } } }, "GoogleCloudRunV2ExecutionTemplate": { "id": "GoogleCloudRunV2ExecutionTemplate", "type": "object", "description": "ExecutionTemplate describes the data an execution should have when created from a template.", "properties": { "delayExecution": { "type": "boolean", "description": "Optional. If true, the system will start the execution within the next 12 hours depending on available capacity." }, "taskCount": { "description": "Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. Defaults to 1.", "type": "integer", "format": "int32" }, "parallelism": { "description": "Optional. Specifies the maximum desired number of tasks the execution should run at given time. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism.", "type": "integer", "format": "int32" }, "template": { "$ref": "GoogleCloudRunV2TaskTemplate", "description": "Required. Describes the task(s) that will be created when executing an execution." }, "client": { "description": "Optional. Arbitrary identifier for the API client.", "type": "string" }, "labels": { "description": "Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.", "additionalProperties": { "type": "string" }, "type": "object" }, "clientVersion": { "description": "Optional. Arbitrary version identifier for the API client.", "type": "string" }, "annotations": { "additionalProperties": { "type": "string" }, "description": "Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.", "type": "object" } } }, "GoogleDevtoolsCloudbuildV1ConnectedRepository": { "properties": { "dir": { "type": "string", "description": "Optional. Directory, relative to the source root, in which to run the build." }, "repository": { "description": "Required. Name of the Google Cloud Build repository, formatted as `projects/*/locations/*/connections/*/repositories/*`.", "type": "string" }, "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." } }, "type": "object", "id": "GoogleDevtoolsCloudbuildV1ConnectedRepository", "description": "Location of the source in a 2nd-gen Google Cloud Build repository resource." }, "GoogleCloudRunV2GRPCAction": { "type": "object", "description": "GRPCAction describes an action involving a GRPC port.", "id": "GoogleCloudRunV2GRPCAction", "properties": { "port": { "format": "int32", "type": "integer", "description": "Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort." }, "service": { "type": "string", "description": "Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC." } } }, "GoogleCloudRunV2VpcAccess": { "id": "GoogleCloudRunV2VpcAccess", "properties": { "connector": { "description": "VPC Access connector name. Format: `projects/{project}/locations/{location}/connectors/{connector}`, where `{project}` can be project id or number. For more information on sending traffic to a VPC network via a connector, visit https://cloud.google.com/run/docs/configuring/vpc-connectors.", "type": "string" }, "egress": { "description": "Optional. Traffic VPC egress settings. If not provided, it defaults to PRIVATE_RANGES_ONLY.", "enumDescriptions": [ "Unspecified", "All outbound traffic is routed through the VPC connector.", "Only private IP ranges are routed through the VPC connector." ], "type": "string", "enum": [ "VPC_EGRESS_UNSPECIFIED", "ALL_TRAFFIC", "PRIVATE_RANGES_ONLY" ] }, "networkInterfaces": { "type": "array", "description": "Optional. Direct VPC egress settings. Currently only single network interface is supported.", "items": { "$ref": "GoogleCloudRunV2NetworkInterface" } } }, "description": "VPC Access settings. For more information on sending traffic to a VPC network, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.", "type": "object" }, "GoogleCloudRunV2RunJobRequest": { "type": "object", "id": "GoogleCloudRunV2RunJobRequest", "properties": { "overrides": { "$ref": "GoogleCloudRunV2Overrides", "description": "Overrides specification for a given execution of a job. If provided, overrides will be applied to update the execution or task spec." }, "etag": { "description": "A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", "type": "string" }, "validateOnly": { "type": "boolean", "description": "Indicates that the request should be validated without actually deleting any resources." } }, "description": "Request message to create a new Execution of a Job." }, "GoogleLongrunningListOperationsResponse": { "type": "object", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "GoogleLongrunningOperation" } }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } } }, "description": "The response message for Operations.ListOperations.", "id": "GoogleLongrunningListOperationsResponse" }, "GoogleCloudRunV2ExecutionReference": { "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "Creation timestamp of the execution." }, "deleteTime": { "format": "google-datetime", "type": "string", "description": "The deletion time of the execution. It is only populated as a response to a Delete request." }, "completionTime": { "type": "string", "description": "Creation timestamp of the execution.", "format": "google-datetime" }, "name": { "type": "string", "description": "Name of the execution." }, "completionStatus": { "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "Job execution has succeeded.", "Job execution has failed.", "Job execution is running normally.", "Waiting for backing resources to be provisioned.", "Job execution has been cancelled by the user." ], "type": "string", "enum": [ "COMPLETION_STATUS_UNSPECIFIED", "EXECUTION_SUCCEEDED", "EXECUTION_FAILED", "EXECUTION_RUNNING", "EXECUTION_PENDING", "EXECUTION_CANCELLED" ], "description": "Status for the execution completion." } }, "id": "GoogleCloudRunV2ExecutionReference", "description": "Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status.", "type": "object" }, "GoogleCloudRunV2VolumeMount": { "type": "object", "description": "VolumeMount describes a mounting of a Volume within a container.", "properties": { "subPath": { "type": "string", "description": "Optional. Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root). This field is currently rejected in Secret volume mounts." }, "name": { "type": "string", "description": "Required. This must match the Name of a Volume." }, "mountPath": { "description": "Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run", "type": "string" } }, "id": "GoogleCloudRunV2VolumeMount" }, "GoogleCloudRunV2InlinedSource": { "description": "Inlined source.", "properties": { "sources": { "description": "Required. Input only. The source code.", "type": "array", "items": { "$ref": "GoogleCloudRunV2SourceFile" } } }, "id": "GoogleCloudRunV2InlinedSource", "type": "object" }, "GoogleDevtoolsCloudbuildV1StepResult": { "type": "object", "id": "GoogleDevtoolsCloudbuildV1StepResult", "properties": { "name": { "description": "Required. The name of the result.", "type": "string" }, "attestationContent": { "description": "Optional. The content of the attestation to be generated.", "type": "string" }, "attestationType": { "description": "Optional. The type of attestation to be generated.", "type": "string" } }, "description": "StepResult is the declaration of a result for a build step." }, "GoogleDevtoolsCloudbuildV1NpmPackage": { "description": "Npm package to upload to Artifact Registry upon successful completion of all build steps.", "id": "GoogleDevtoolsCloudbuildV1NpmPackage", "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": { "description": "Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.", "type": "string" } }, "type": "object" }, "GoogleCloudRunV2BuildpacksBuild": { "type": "object", "description": "Build the source using Buildpacks.", "id": "GoogleCloudRunV2BuildpacksBuild", "properties": { "projectDescriptor": { "type": "string", "description": "Optional. project_descriptor stores the path to the project descriptor file. When empty, it means that there is no project descriptor file in the source." }, "runtime": { "deprecated": true, "type": "string", "description": "The runtime name, e.g. 'go113'. Leave blank for generic builds." }, "baseImage": { "type": "string", "description": "Optional. The base image to use for the build." }, "cacheImageUri": { "description": "Optional. cache_image_uri is the GCR/AR URL where the cache image will be stored. cache_image_uri is optional and omitting it will disable caching. This URL must be stable across builds. It is used to derive a build-specific temporary URL by substituting the tag with the build ID. The build will clean up the temporary image on a best-effort basis.", "type": "string" }, "functionTarget": { "type": "string", "description": "Optional. Name of the function target if the source is a function source. Required for function builds." }, "enableAutomaticUpdates": { "type": "boolean", "description": "Optional. Whether or not the application container will be enrolled in automatic base image updates. When true, the application will be built on a scratch base image, so the base layers can be appended at run time." }, "environmentVariables": { "description": "Optional. User-provided build-time environment variables.", "additionalProperties": { "type": "string" }, "type": "object" } } }, "GoogleCloudRunV2ListJobsResponse": { "properties": { "nextPageToken": { "description": "A token indicating there are more items than page_size. Use it in the next ListJobs request to continue.", "type": "string" }, "jobs": { "items": { "$ref": "GoogleCloudRunV2Job" }, "type": "array", "description": "The resulting list of Jobs." } }, "type": "object", "description": "Response message containing a list of Jobs.", "id": "GoogleCloudRunV2ListJobsResponse" }, "GoogleDevtoolsCloudbuildV1UploadedNpmPackage": { "description": "An npm package uploaded to Artifact Registry using the NpmPackage directive.", "type": "object", "properties": { "artifactRegistryPackage": { "type": "string", "readOnly": true, "description": "Output only. Path to the artifact in Artifact Registry." }, "fileHashes": { "description": "Hash types and values of the npm package.", "$ref": "GoogleDevtoolsCloudbuildV1FileHashes" }, "pushTiming": { "description": "Output only. Stores timing information for pushing the specified artifact.", "readOnly": true, "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan" }, "uri": { "description": "URI of the uploaded npm package.", "type": "string" } }, "id": "GoogleDevtoolsCloudbuildV1UploadedNpmPackage" }, "GoogleCloudRunV2ListServicesResponse": { "type": "object", "description": "Response message containing a list of Services.", "properties": { "nextPageToken": { "type": "string", "description": "A token indicating there are more items than page_size. Use it in the next ListServices request to continue." }, "services": { "items": { "$ref": "GoogleCloudRunV2Service" }, "type": "array", "description": "The resulting list of Services." }, "unreachable": { "description": "Output only. For global requests, returns the list of regions that could not be reached within the deadline.", "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "id": "GoogleCloudRunV2ListServicesResponse" }, "GoogleDevtoolsCloudbuildV1GitSource": { "description": "Location of the source in any accessible Git repository.", "type": "object", "id": "GoogleDevtoolsCloudbuildV1GitSource", "properties": { "url": { "type": "string", "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." }, "dir": { "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.", "type": "string" }, "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." } } }, "GoogleCloudRunV2Instance": { "properties": { "reconciling": { "type": "boolean", "description": "Output only. Returns `true` if the Instance is currently being acted upon by the system to bring it into the desired state. When a new Instance is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Instance to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation` will have a transient value that might mismatch the intended state. Once reconciliation is over (and this field is `false`), there are two possible outcomes: reconciliation succeeded and the serving state matches the Instance, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`.", "readOnly": true }, "etag": { "description": "Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", "type": "string" }, "creator": { "type": "string", "readOnly": true, "description": "Output only. Email address of the authenticated creator." }, "containers": { "items": { "$ref": "GoogleCloudRunV2Container" }, "type": "array", "description": "Required. Holds the single container that defines the unit of execution for this Instance." }, "gpuZonalRedundancyDisabled": { "type": "boolean", "description": "Optional. True if GPU zonal redundancy is disabled on this instance." }, "conditions": { "readOnly": true, "items": { "$ref": "GoogleCloudRunV2Condition" }, "description": "Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Instance does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", "type": "array" }, "expireTime": { "readOnly": true, "description": "Output only. For a deleted resource, the time after which it will be permamently deleted.", "format": "google-datetime", "type": "string" }, "binaryAuthorization": { "description": "Settings for the Binary Authorization feature.", "$ref": "GoogleCloudRunV2BinaryAuthorization" }, "launchStage": { "enumDescriptions": [ "Do not use this default value.", "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the \"Deprecation Policy\" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." ], "description": "The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, `GA` is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if `ALPHA` is provided as input, but only `BETA` and `GA`-level features are used, this field will be `BETA` on output.", "type": "string", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", "UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED" ] }, "client": { "description": "Arbitrary identifier for the API client.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "defaultUriDisabled": { "description": "Optional. Disables public resolution of the default URI of this Instance.", "type": "boolean" }, "encryptionKey": { "type": "string", "description": "A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek" }, "serviceAccount": { "type": "string" }, "name": { "type": "string", "description": "The fully qualified name of this Instance. In `CreateInstanceRequest`, this field is ignored, and instead composed from `CreateInstanceRequest.parent` and `CreateInstanceRequest.instance_id`." }, "containerStatuses": { "readOnly": true, "description": "Output only. Status information for each of the specified containers. The status includes the resolved digest for specified images.", "type": "array", "items": { "$ref": "GoogleCloudRunV2ContainerStatus" } }, "satisfiesPzs": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "restartPolicy": { "type": "string", "enum": [ "RESTART_POLICY_UNSPECIFIED", "ALWAYS", "ON_FAILURE", "NEVER" ], "enumDescriptions": [ "Unspecified restart policy.", "Always restart the instance.", "Restart if the instance terminates with non-zero exit code.", "Never restart the instance." ], "description": "Optional. Restart policy for the Instance." }, "ingress": { "type": "string", "enum": [ "INGRESS_TRAFFIC_UNSPECIFIED", "INGRESS_TRAFFIC_ALL", "INGRESS_TRAFFIC_INTERNAL_ONLY", "INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER", "INGRESS_TRAFFIC_NONE" ], "description": "Optional. Provides the ingress settings for this Instance. On output, returns the currently observed ingress settings, or `INGRESS_TRAFFIC_UNSPECIFIED` if no revision is active.", "enumDescriptions": [ "Unspecified", "All inbound traffic is allowed.", "Only internal traffic is allowed.", "Both internal and Google Cloud Load Balancer traffic is allowed.", "No ingress traffic is allowed." ] }, "encryptionKeyShutdownDuration": { "description": "If `encryption_key_revocation_action` is `SHUTDOWN`, the duration before shutting down all instances. The minimum increment is 1 hour.", "format": "google-duration", "type": "string" }, "clientVersion": { "description": "Arbitrary version identifier for the API client.", "type": "string" }, "generation": { "format": "int64", "readOnly": true, "description": "Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an `int64` value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.", "type": "string" }, "nodeSelector": { "description": "Optional. The node selector for the instance.", "$ref": "GoogleCloudRunV2NodeSelector" }, "uid": { "type": "string", "readOnly": true, "description": "Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted." }, "createTime": { "format": "google-datetime", "description": "Output only. The creation time.", "readOnly": true, "type": "string" }, "encryptionKeyRevocationAction": { "type": "string", "enum": [ "ENCRYPTION_KEY_REVOCATION_ACTION_UNSPECIFIED", "PREVENT_NEW", "SHUTDOWN" ], "description": "The action to take if the encryption key is revoked.", "enumDescriptions": [ "Unspecified", "Prevents the creation of new instances.", "Shuts down existing instances, and prevents creation of new ones." ] }, "sshEnabled": { "type": "boolean", "description": "Optional. Enables SSH access to the Instance." }, "urls": { "items": { "type": "string" }, "type": "array", "readOnly": true, "description": "Output only. All URLs serving traffic for this Instance." }, "lastModifier": { "description": "Output only. Email address of the last authenticated modifier.", "readOnly": true, "type": "string" }, "description": { "description": "User-provided description of the Instance. This field currently has a 512-character limit.", "type": "string" }, "updateTime": { "description": "Output only. The last-modified time.", "format": "google-datetime", "readOnly": true, "type": "string" }, "vpcAccess": { "$ref": "GoogleCloudRunV2VpcAccess", "description": "Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc." }, "observedGeneration": { "type": "string", "format": "int64", "description": "Output only. The generation of this Instance currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an `int64` value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.", "readOnly": true }, "invokerIamDisabled": { "description": "Optional. Disables IAM permission check for `run.routes.invoke` for callers of this Instance. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check.", "type": "boolean" }, "iapEnabled": { "description": "Optional. IAP settings on the Instance.", "type": "boolean" }, "terminalCondition": { "description": "Output only. The Condition of this Instance, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", "$ref": "GoogleCloudRunV2Condition", "readOnly": true }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "volumes": { "items": { "$ref": "GoogleCloudRunV2Volume" }, "type": "array", "description": "A list of Volumes to make available to containers." }, "deleteTime": { "format": "google-datetime", "description": "Output only. The deletion time.", "type": "string", "readOnly": true }, "logUri": { "readOnly": true, "type": "string", "description": "Output only. The Google Console URI to obtain logs for the Instance." } }, "type": "object", "id": "GoogleCloudRunV2Instance", "description": "A Cloud Run Instance represents a single group of containers running in a region." }, "GoogleCloudRunV2TaskTemplate": { "id": "GoogleCloudRunV2TaskTemplate", "type": "object", "description": "TaskTemplate describes the data a task should have when created from a template.", "properties": { "maxRetries": { "format": "int32", "description": "Number of retries allowed per Task, before marking this Task failed. Defaults to 3.", "type": "integer" }, "volumes": { "items": { "$ref": "GoogleCloudRunV2Volume" }, "description": "Optional. A list of Volumes to make available to containers.", "type": "array" }, "timeout": { "format": "google-duration", "description": "Optional. Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds.", "type": "string" }, "serviceAccount": { "description": "Optional. Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.", "type": "string" }, "nodeSelector": { "$ref": "GoogleCloudRunV2NodeSelector", "description": "Optional. The node selector for the task template." }, "gpuZonalRedundancyDisabled": { "description": "Optional. True if GPU zonal redundancy is disabled on this task template.", "type": "boolean" }, "vpcAccess": { "$ref": "GoogleCloudRunV2VpcAccess", "description": "Optional. VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc." }, "executionEnvironment": { "type": "string", "enum": [ "EXECUTION_ENVIRONMENT_UNSPECIFIED", "EXECUTION_ENVIRONMENT_GEN1", "EXECUTION_ENVIRONMENT_GEN2" ], "description": "Optional. The execution environment being used to host this Task.", "enumDescriptions": [ "Unspecified", "Uses the First Generation environment.", "Uses Second Generation environment." ] }, "encryptionKey": { "description": "A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek", "type": "string" }, "containers": { "items": { "$ref": "GoogleCloudRunV2Container" }, "type": "array", "description": "Holds the single container that defines the unit of execution for this task." }, "workloadIdentityConfig": { "$ref": "GoogleCloudRunV2WorkloadIdentityConfig", "description": "Optional. The Task's workload identity settings." } } }, "GoogleCloudRunV2Metadata": { "type": "object", "description": "Metadata represents the JSON encoded generated customer metadata.", "id": "GoogleCloudRunV2Metadata", "properties": { "metadata": { "type": "string", "description": "JSON encoded Google-generated Customer Metadata for a given resource/project." } } }, "GoogleCloudRunV2NFSVolumeSource": { "description": "Represents an NFS mount.", "properties": { "readOnly": { "type": "boolean", "description": "If true, the volume will be mounted as read only for all mounts." }, "path": { "description": "Path that is exported by the NFS server.", "type": "string" }, "server": { "description": "Hostname or IP address of the NFS server", "type": "string" } }, "id": "GoogleCloudRunV2NFSVolumeSource", "type": "object" }, "GoogleCloudRunV2Revision": { "properties": { "service": { "readOnly": true, "type": "string", "description": "Output only. The name of the parent service." }, "serviceAccount": { "type": "string", "description": "Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has." }, "observedGeneration": { "type": "string", "readOnly": true, "format": "int64", "description": "Output only. The generation of this Revision currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run." }, "updateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The last-modified time.", "type": "string" }, "sessionAffinity": { "type": "boolean", "description": "Enable session affinity." }, "etag": { "type": "string", "description": "Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", "readOnly": true }, "maxInstanceRequestConcurrency": { "format": "int32", "description": "Sets the maximum number of requests that each serving instance can receive.", "type": "integer" }, "timeout": { "description": "Max allowed time for an instance to respond to a request.", "format": "google-duration", "type": "string" }, "labels": { "description": "Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.", "type": "object", "readOnly": true, "additionalProperties": { "type": "string" } }, "client": { "description": "Output only. Arbitrary identifier for the API client.", "type": "string", "readOnly": true }, "deleteTime": { "description": "Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.", "format": "google-datetime", "type": "string", "readOnly": true }, "creator": { "type": "string", "readOnly": true, "description": "Output only. Email address of the authenticated creator." }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "encryptionKeyRevocationAction": { "type": "string", "enum": [ "ENCRYPTION_KEY_REVOCATION_ACTION_UNSPECIFIED", "PREVENT_NEW", "SHUTDOWN" ], "description": "The action to take if the encryption key is revoked.", "enumDescriptions": [ "Unspecified", "Prevents the creation of new instances.", "Shuts down existing instances, and prevents creation of new ones." ] }, "scaling": { "$ref": "GoogleCloudRunV2RevisionScaling", "description": "Scaling settings for this revision." }, "executionEnvironment": { "type": "string", "enum": [ "EXECUTION_ENVIRONMENT_UNSPECIFIED", "EXECUTION_ENVIRONMENT_GEN1", "EXECUTION_ENVIRONMENT_GEN2" ], "enumDescriptions": [ "Unspecified", "Uses the First Generation environment.", "Uses Second Generation environment." ], "description": "The execution environment being used to host this Revision." }, "name": { "description": "Output only. The unique name of this Revision.", "readOnly": true, "type": "string" }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The creation time." }, "launchStage": { "description": "The least stable launch stage needed to create this resource, as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are used, this field will be BETA.", "enumDescriptions": [ "Do not use this default value.", "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the \"Deprecation Policy\" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." ], "type": "string", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", "UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED" ] }, "generation": { "format": "int64", "description": "Output only. A number that monotonically increases every time the user modifies the desired state.", "readOnly": true, "type": "string" }, "reconciling": { "description": "Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Service.reconciling` for additional information on reconciliation process in Cloud Run.", "type": "boolean", "readOnly": true }, "uid": { "description": "Output only. Server assigned unique identifier for the Revision. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.", "type": "string", "readOnly": true }, "scalingStatus": { "description": "Output only. The current effective scaling settings for the revision.", "$ref": "GoogleCloudRunV2RevisionScalingStatus", "readOnly": true }, "encryptionKeyShutdownDuration": { "format": "google-duration", "type": "string", "description": "If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour." }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "readOnly": true }, "vpcAccess": { "description": "VPC Access configuration for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.", "$ref": "GoogleCloudRunV2VpcAccess" }, "serviceMesh": { "$ref": "GoogleCloudRunV2ServiceMesh", "description": "Enables service mesh connectivity." }, "encryptionKey": { "description": "A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek", "type": "string" }, "containers": { "items": { "$ref": "GoogleCloudRunV2Container" }, "type": "array", "description": "Holds the list which define the units of execution for this Revision." }, "volumes": { "items": { "$ref": "GoogleCloudRunV2Volume" }, "type": "array", "description": "A list of Volumes to make available to containers." }, "gpuZonalRedundancyDisabled": { "description": "Optional. Output only. True if GPU zonal redundancy is disabled on this revision.", "readOnly": true, "type": "boolean" }, "workloadIdentityConfig": { "$ref": "GoogleCloudRunV2WorkloadIdentityConfig", "description": "Optional. The Revision's workload identity settings." }, "logUri": { "readOnly": true, "type": "string", "description": "Output only. The Google Console URI to obtain logs for the Revision." }, "nodeSelector": { "description": "The node selector for the revision.", "$ref": "GoogleCloudRunV2NodeSelector" }, "expireTime": { "format": "google-datetime", "description": "Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.", "type": "string", "readOnly": true }, "conditions": { "items": { "$ref": "GoogleCloudRunV2Condition" }, "description": "Output only. The Condition of this Revision, containing its readiness status, and detailed error information in case it did not reach a serving state.", "readOnly": true, "type": "array" }, "clientVersion": { "type": "string", "readOnly": true, "description": "Output only. Arbitrary version identifier for the API client." } }, "description": "A Revision is an immutable snapshot of code and configuration. A Revision references a container image. Revisions are only created by updates to its parent Service.", "id": "GoogleCloudRunV2Revision", "type": "object" }, "GoogleCloudRunV2SourceFile": { "type": "object", "id": "GoogleCloudRunV2SourceFile", "properties": { "content": { "description": "Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application.", "type": "string" }, "filename": { "type": "string", "description": "Required. Input only. The file name for the source code. e.g., `\"index.js\"` or `\"node_modules/dependency.js\"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file." } }, "description": "Source file." }, "GoogleDevtoolsCloudbuildV1FileHashes": { "description": "Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.", "properties": { "fileHash": { "type": "array", "description": "Collection of file hashes.", "items": { "$ref": "GoogleDevtoolsCloudbuildV1Hash" } } }, "id": "GoogleDevtoolsCloudbuildV1FileHashes", "type": "object" }, "GoogleDevtoolsCloudbuildV1StorageSourceManifest": { "properties": { "object": { "description": "Required. Cloud Storage object containing the source manifest. This object must be a JSON file.", "type": "string" }, "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))." }, "generation": { "format": "int64", "type": "string", "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used." } }, "id": "GoogleDevtoolsCloudbuildV1StorageSourceManifest", "type": "object", "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)." }, "GoogleIamV1AuditConfig": { "type": "object", "id": "GoogleIamV1AuditConfig", "properties": { "auditLogConfigs": { "description": "The configuration for logging of each type of permission.", "type": "array", "items": { "$ref": "GoogleIamV1AuditLogConfig" } }, "service": { "type": "string", "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services." } }, "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging." }, "GoogleDevtoolsCloudbuildV1DeveloperConnectConfig": { "id": "GoogleDevtoolsCloudbuildV1DeveloperConnectConfig", "type": "object", "description": "This config defines the location of a source through Developer Connect.", "properties": { "revision": { "description": "Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.", "type": "string" }, "dir": { "description": "Required. Directory, relative to the source root, in which to run the build.", "type": "string" }, "gitRepositoryLink": { "description": "Required. The Developer Connect Git repository link, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`.", "type": "string" } } }, "GoogleCloudRunV2Job": { "id": "GoogleCloudRunV2Job", "description": "Job represents the configuration of a single job, which references a container image that is run to completion.", "properties": { "creator": { "type": "string", "readOnly": true, "description": "Output only. Email address of the authenticated creator." }, "executionCount": { "description": "Output only. Number of executions created for this job.", "type": "integer", "readOnly": true, "format": "int32" }, "uid": { "readOnly": true, "description": "Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.", "type": "string" }, "latestCreatedExecution": { "description": "Output only. Name of the last created execution.", "readOnly": true, "$ref": "GoogleCloudRunV2ExecutionReference" }, "name": { "description": "The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}", "type": "string" }, "observedGeneration": { "description": "Output only. The generation of this Job. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", "type": "string", "format": "int64", "readOnly": true }, "expireTime": { "description": "Output only. For a deleted resource, the time after which it will be permamently deleted.", "format": "google-datetime", "readOnly": true, "type": "string" }, "annotations": { "description": "Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job. This field follows Kubernetes annotations' namespacing, limits, and rules.", "type": "object", "additionalProperties": { "type": "string" } }, "functionalType": { "type": "string", "enum": [ "FUNCTIONAL_TYPE_UNSPECIFIED", "FUNCTIONAL_TYPE_AGENT", "FUNCTIONAL_TYPE_MCP_SERVER" ], "description": "Optional. The functional type of the Job.", "enumDescriptions": [ "Specifies that the functional type is unspecified.", "Represents an AGENT functional type.", "Represents an MCP_SERVER functional type." ] }, "etag": { "description": "Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", "type": "string" }, "client": { "description": "Arbitrary identifier for the API client.", "type": "string" }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "type": "boolean", "readOnly": true }, "labels": { "additionalProperties": { "type": "string" }, "description": "Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job.", "type": "object" }, "conditions": { "type": "array", "description": "Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", "items": { "$ref": "GoogleCloudRunV2Condition" }, "readOnly": true }, "runExecutionToken": { "type": "string", "description": "A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully completed. The sum of job name and token length must be fewer than 63 characters." }, "template": { "description": "Required. The template used to create executions for this Job.", "$ref": "GoogleCloudRunV2ExecutionTemplate" }, "terminalCondition": { "$ref": "GoogleCloudRunV2Condition", "readOnly": true, "description": "Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state." }, "deleteTime": { "type": "string", "description": "Output only. The deletion time. It is only populated as a response to a Delete request.", "format": "google-datetime", "readOnly": true }, "launchStage": { "enumDescriptions": [ "Do not use this default value.", "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the \"Deprecation Policy\" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." ], "description": "The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.", "type": "string", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", "UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED" ] }, "binaryAuthorization": { "$ref": "GoogleCloudRunV2BinaryAuthorization", "description": "Settings for the Binary Authorization feature." }, "clientVersion": { "type": "string", "description": "Arbitrary version identifier for the API client." }, "updateTime": { "type": "string", "readOnly": true, "description": "Output only. The last-modified time.", "format": "google-datetime" }, "reconciling": { "type": "boolean", "readOnly": true, "description": "Output only. Returns true if the Job is currently being acted upon by the system to bring it into the desired state. When a new Job is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Job to the desired state. This process is called reconciliation. While reconciliation is in process, `observed_generation` and `latest_succeeded_execution`, will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the state matches the Job, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `observed_generation` and `generation`, `latest_succeeded_execution` and `latest_created_execution`. If reconciliation failed, `observed_generation` and `latest_succeeded_execution` will have the state of the last succeeded execution or empty for newly created Job. Additional information on the failure can be found in `terminal_condition` and `conditions`." }, "lastModifier": { "description": "Output only. Email address of the last authenticated modifier.", "type": "string", "readOnly": true }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The creation time." }, "generation": { "description": "Output only. A number that monotonically increases every time the user modifies the desired state.", "readOnly": true, "type": "string", "format": "int64" }, "startExecutionToken": { "type": "string", "description": "A unique string used as a suffix creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters." } }, "type": "object" }, "GoogleLongrunningWaitOperationRequest": { "type": "object", "id": "GoogleLongrunningWaitOperationRequest", "description": "The request message for Operations.WaitOperation.", "properties": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "type": "string" } } }, "GoogleCloudRunV2CloudStorageSource": { "properties": { "bucket": { "description": "Required. The Cloud Storage bucket name.", "type": "string" }, "object": { "description": "Required. The Cloud Storage object name.", "type": "string" }, "generation": { "type": "string", "format": "int64", "description": "Optional. The Cloud Storage object generation." } }, "description": "Cloud Storage source.", "type": "object", "id": "GoogleCloudRunV2CloudStorageSource" }, "GoogleDevtoolsCloudbuildV1InlineSecret": { "properties": { "envMap": { "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": { "format": "byte", "type": "string" }, "type": "object" }, "kmsKeyName": { "type": "string", "description": "Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/*" } }, "type": "object", "description": "Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.", "id": "GoogleDevtoolsCloudbuildV1InlineSecret" }, "GoogleCloudRunV2StopInstanceRequest": { "type": "object", "description": "Request message for deleting an Instance.", "id": "GoogleCloudRunV2StopInstanceRequest", "properties": { "validateOnly": { "type": "boolean", "description": "Optional. Indicates that the request should be validated without actually stopping any resources." }, "etag": { "description": "Optional. A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates.", "type": "string" } } }, "GoogleDevtoolsCloudbuildV1StorageSource": { "description": "Location of the source in an archive file in Cloud Storage.", "id": "GoogleDevtoolsCloudbuildV1StorageSource", "type": "object", "properties": { "sourceFetcher": { "description": "Optional. Option to specify the tool to fetch the source file for the build.", "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." ], "type": "string", "enum": [ "SOURCE_FETCHER_UNSPECIFIED", "GSUTIL", "GCS_FETCHER" ] }, "bucket": { "description": "Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", "type": "string" }, "object": { "type": "string", "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." }, "generation": { "description": "Optional. Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", "type": "string", "format": "int64" } } }, "GoogleDevtoolsCloudbuildV1HttpConfig": { "type": "object", "properties": { "proxySecretVersionName": { "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": "string" } }, "description": "HttpConfig is a configuration for HTTP related git operations.", "id": "GoogleDevtoolsCloudbuildV1HttpConfig" }, "GoogleCloudRunV2ContainerOverride": { "type": "object", "properties": { "env": { "description": "List of environment variables to set in the container. Will be merged with existing env for override.", "items": { "$ref": "GoogleCloudRunV2EnvVar" }, "type": "array" }, "args": { "description": "Optional. Arguments to the entrypoint. Will replace existing args for override.", "type": "array", "items": { "type": "string" } }, "clearArgs": { "type": "boolean", "description": "Optional. True if the intention is to clear out existing args list." }, "name": { "description": "The name of the container specified as a DNS_LABEL.", "type": "string" } }, "id": "GoogleCloudRunV2ContainerOverride", "description": "Per-container override specification." }, "GoogleIamV1Binding": { "properties": { "members": { "items": { "type": "string" }, "type": "array", "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`." }, "role": { "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" }, "condition": { "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "$ref": "GoogleTypeExpr" } }, "type": "object", "description": "Associates `members`, or principals, with a `role`.", "id": "GoogleIamV1Binding" }, "GoogleCloudRunV2WorkerPoolScaling": { "description": "Worker pool scaling settings.", "properties": { "manualInstanceCount": { "description": "Optional. The total number of instances in manual scaling mode.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudRunV2WorkerPoolScaling", "type": "object" }, "GoogleCloudRunV2SubmitBuildRequest": { "properties": { "buildpackBuild": { "$ref": "GoogleCloudRunV2BuildpacksBuild", "description": "Build the source using Buildpacks." }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Optional. Additional tags to annotate the build." }, "serviceAccount": { "description": "Optional. The service account to use for the build. If not set, the default Cloud Build service account for the project will be used.", "type": "string" }, "imageUri": { "type": "string", "description": "Required. Artifact Registry URI to store the built image." }, "machineType": { "type": "string", "description": "Optional. The machine type from default pool to use for the build. If left blank, cloudbuild will use a sensible default. Currently only E2_HIGHCPU_8 is supported. If worker_pool is set, this field will be ignored." }, "dockerBuild": { "description": "Build the source using Docker. This means the source has a Dockerfile.", "$ref": "GoogleCloudRunV2DockerBuild" }, "releaseTrack": { "description": "Optional. The release track of the client that initiated the build request.", "enumDescriptions": [ "Do not use this default value.", "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the \"Deprecation Policy\" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." ], "type": "string", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", "UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED" ] }, "storageSource": { "description": "Required. Source for the build.", "$ref": "GoogleCloudRunV2StorageSource" }, "workerPool": { "description": "Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where `{project}` and `{region}` are the project id and region respectively where the worker pool is defined and `{workerPool}` is the short name of the worker pool.", "type": "string" }, "client": { "description": "Optional. The client that initiated the build request.", "type": "string" } }, "type": "object", "description": "Request message for submitting a Build.", "id": "GoogleCloudRunV2SubmitBuildRequest" }, "GoogleDevtoolsCloudbuildV1UploadedGoModule": { "type": "object", "properties": { "artifactRegistryPackage": { "readOnly": true, "type": "string", "description": "Output only. Path to the artifact in Artifact Registry." }, "fileHashes": { "$ref": "GoogleDevtoolsCloudbuildV1FileHashes", "description": "Hash types and values of the Go Module Artifact." }, "pushTiming": { "description": "Output only. Stores timing information for pushing the specified artifact.", "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", "readOnly": true }, "uri": { "type": "string", "description": "URI of the uploaded artifact." } }, "id": "GoogleDevtoolsCloudbuildV1UploadedGoModule", "description": "A Go module artifact uploaded to Artifact Registry using the GoModule directive." }, "GoogleCloudRunV2Probe": { "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", "properties": { "failureThreshold": { "type": "integer", "description": "Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.", "format": "int32" }, "grpc": { "$ref": "GoogleCloudRunV2GRPCAction", "description": "Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified." }, "tcpSocket": { "description": "Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.", "$ref": "GoogleCloudRunV2TCPSocketAction" }, "timeoutSeconds": { "description": "Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.", "type": "integer", "format": "int32" }, "initialDelaySeconds": { "description": "Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.", "type": "integer", "format": "int32" }, "periodSeconds": { "description": "Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.", "format": "int32", "type": "integer" }, "httpGet": { "description": "Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.", "$ref": "GoogleCloudRunV2HTTPGetAction" } }, "type": "object", "id": "GoogleCloudRunV2Probe" }, "GoogleCloudRunV2ListRevisionsResponse": { "type": "object", "id": "GoogleCloudRunV2ListRevisionsResponse", "properties": { "nextPageToken": { "description": "A token indicating there are more items than page_size. Use it in the next ListRevisions request to continue.", "type": "string" }, "revisions": { "description": "The resulting list of Revisions.", "type": "array", "items": { "$ref": "GoogleCloudRunV2Revision" } } }, "description": "Response message containing a list of Revisions." }, "GoogleCloudRunV2WorkloadIdentityConfig": { "properties": { "identityCertificateEnabled": { "description": "Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag.", "type": "boolean" }, "identityType": { "type": "string", "enum": [ "IDENTITY_TYPE_UNSPECIFIED", "IDENTITY_TYPE_SERVICE_ACCOUNT", "IDENTITY_TYPE_AGENT_IDENTITY" ], "description": "Optional. The type of identity to use.", "enumDescriptions": [ "Unspecified", "Service account identity.", "Agent identity." ] }, "identity": { "type": "string", "description": "Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates." } }, "type": "object", "id": "GoogleCloudRunV2WorkloadIdentityConfig", "description": "Workload identity settings." }, "GoogleProtobufEmpty": { "id": "GoogleProtobufEmpty", "properties": {}, "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" }, "GoogleDevtoolsCloudbuildV1Artifacts": { "properties": { "pythonPackages": { "type": "array", "items": { "$ref": "GoogleDevtoolsCloudbuildV1PythonPackage" }, "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." }, "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.", "items": { "$ref": "GoogleDevtoolsCloudbuildV1Oci" }, "type": "array" }, "images": { "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.", "type": "array", "items": { "type": "string" } }, "npmPackages": { "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": "GoogleDevtoolsCloudbuildV1NpmPackage" }, "type": "array" }, "mavenArtifacts": { "items": { "$ref": "GoogleDevtoolsCloudbuildV1MavenArtifact" }, "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.", "type": "array" }, "objects": { "$ref": "GoogleDevtoolsCloudbuildV1ArtifactObjects", "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." }, "genericArtifacts": { "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", "items": { "$ref": "GoogleDevtoolsCloudbuildV1GenericArtifact" } }, "goModules": { "items": { "$ref": "GoogleDevtoolsCloudbuildV1GoModule" }, "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." } }, "type": "object", "id": "GoogleDevtoolsCloudbuildV1Artifacts", "description": "Artifacts produced by a build that should be uploaded upon successful completion of all build steps." }, "GoogleIamV1SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "type": "object", "properties": { "policy": { "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.", "$ref": "GoogleIamV1Policy" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`" } }, "id": "GoogleIamV1SetIamPolicyRequest" }, "GoogleTypeExpr": { "type": "object", "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "id": "GoogleTypeExpr", "properties": { "description": { "type": "string", "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI." }, "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" }, "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" }, "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" } } }, "GoogleCloudRunV2HTTPGetAction": { "type": "object", "description": "HTTPGetAction describes an action based on HTTP Get requests.", "properties": { "path": { "type": "string", "description": "Optional. Path to access on the HTTP server. Defaults to '/'." }, "port": { "description": "Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.", "type": "integer", "format": "int32" }, "httpHeaders": { "items": { "$ref": "GoogleCloudRunV2HTTPHeader" }, "type": "array", "description": "Optional. Custom headers to set in the request. HTTP allows repeated headers." } }, "id": "GoogleCloudRunV2HTTPGetAction" }, "GoogleCloudRunV2Condition": { "id": "GoogleCloudRunV2Condition", "type": "object", "properties": { "lastTransitionTime": { "description": "Last time the condition transitioned from one status to another.", "type": "string", "format": "google-datetime" }, "severity": { "description": "How to interpret failures of this condition, one of Error, Warning, Info", "enumDescriptions": [ "Unspecified severity", "Error severity.", "Warning severity.", "Info severity." ], "type": "string", "enum": [ "SEVERITY_UNSPECIFIED", "ERROR", "WARNING", "INFO" ] }, "revisionReason": { "type": "string", "description": "Output only. A reason for the revision condition.", "enum": [ "REVISION_REASON_UNDEFINED", "PENDING", "RESERVE", "RETIRED", "RETIRING", "RECREATING", "HEALTH_CHECK_CONTAINER_ERROR", "CUSTOMIZED_PATH_RESPONSE_PENDING", "MIN_INSTANCES_NOT_PROVISIONED", "ACTIVE_REVISION_LIMIT_REACHED", "NO_DEPLOYMENT", "HEALTH_CHECK_SKIPPED", "MIN_INSTANCES_WARMING" ], "readOnly": true, "enumDescriptions": [ "Default value.", "Revision in Pending state.", "Revision is in Reserve state.", "Revision is Retired.", "Revision is being retired.", "Revision is being recreated.", "There was a health check error.", "Health check failed due to user error from customized path of the container. System will retry.", "A revision with min_instance_count \u003e 0 was created and is reserved, but it was not configured to serve traffic, so it's not live. This can also happen momentarily during traffic migration.", "The maximum allowed number of active revisions has been reached.", "There was no deployment defined. This value is no longer used, but Services created in older versions of the API might contain this value.", "A revision's container has no port specified since the revision is of a manually scaled service with 0 instance count", "A revision with min_instance_count \u003e 0 was created and is waiting for enough instances to begin a traffic migration." ] }, "state": { "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "Transient state: Reconciliation has not started yet.", "Transient state: reconciliation is still in progress.", "Terminal state: Reconciliation did not succeed.", "Terminal state: Reconciliation completed successfully." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "CONDITION_PENDING", "CONDITION_RECONCILING", "CONDITION_FAILED", "CONDITION_SUCCEEDED" ], "description": "State of the condition." }, "instanceReason": { "type": "string", "enumDescriptions": [ "Default value.", "Instance deleted.", "Instance stopped.", "Instance stopping.", "Instance exited with a non-zero exit code." ], "description": "Output only. A reason for the instance condition.", "readOnly": true, "enum": [ "INSTANCE_REASON_UNSPECIFIED", "INSTANCE_DELETED", "INSTANCE_STOPPED", "INSTANCE_STOPPING", "INSTANCE_NON_ZERO_EXIT_CODE" ] }, "type": { "type": "string", "description": "type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * \"Ready\": True when the Resource is ready." }, "message": { "type": "string", "description": "Human readable message indicating details about the current status." }, "executionReason": { "enumDescriptions": [ "Default value.", "Internal system error getting execution status. System will retry.", "A task reached its retry limit and the last attempt failed due to the user container exiting with a non-zero exit code.", "The execution was cancelled by users.", "The execution is in the process of being cancelled.", "The execution was deleted.", "A delayed execution is waiting for a start time.", "A delayed execution exceeded the maximum runtime duration." ], "enum": [ "EXECUTION_REASON_UNDEFINED", "JOB_STATUS_SERVICE_POLLING_ERROR", "NON_ZERO_EXIT_CODE", "CANCELLED", "CANCELLING", "DELETED", "DELAYED_START_PENDING", "DELAYED_EXECUTION_EXCEEDING_DURATION_LIMIT" ], "readOnly": true, "description": "Output only. A reason for the execution condition.", "type": "string" }, "reason": { "enumDescriptions": [ "Default value.", "Reason unknown. Further details will be in message.", "Revision creation process failed.", "Timed out waiting for completion.", "The container image path is incorrect.", "Insufficient permissions on the container image.", "Container image is not authorized by policy.", "Container image policy authorization check failed.", "Insufficient permissions on encryption key.", "Permission check on encryption key failed.", "At least one Access check on secrets failed.", "Waiting for operation to complete.", "System will retry immediately.", "System will retry later; current attempt failed.", "An internal error occurred. Further information may be in the message.", "User-provided VPC network was not found." ], "type": "string", "description": "Output only. A common (service-level) reason for this condition.", "readOnly": true, "enum": [ "COMMON_REASON_UNDEFINED", "UNKNOWN", "REVISION_FAILED", "PROGRESS_DEADLINE_EXCEEDED", "CONTAINER_MISSING", "CONTAINER_PERMISSION_DENIED", "CONTAINER_IMAGE_UNAUTHORIZED", "CONTAINER_IMAGE_AUTHORIZATION_CHECK_FAILED", "ENCRYPTION_KEY_PERMISSION_DENIED", "ENCRYPTION_KEY_CHECK_FAILED", "SECRETS_ACCESS_CHECK_FAILED", "WAITING_FOR_OPERATION", "IMMEDIATE_RETRY", "POSTPONED_RETRY", "INTERNAL", "VPC_NETWORK_NOT_FOUND" ] } }, "description": "Defines a status condition for a resource." }, "GoogleCloudRunV2NodeSelector": { "type": "object", "description": "Hardware constraints configuration.", "id": "GoogleCloudRunV2NodeSelector", "properties": { "accelerator": { "type": "string", "description": "Required. GPU accelerator type to attach to an instance." } } }, "Proto2BridgeMessageSet": { "deprecated": true, "description": "This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a \"bridge\" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments.", "id": "Proto2BridgeMessageSet", "properties": {}, "type": "object" }, "GoogleCloudRunV2Volume": { "id": "GoogleCloudRunV2Volume", "description": "Volume represents a named volume in a container.", "type": "object", "properties": { "emptyDir": { "$ref": "GoogleCloudRunV2EmptyDirVolumeSource", "description": "Ephemeral storage used as a shared volume." }, "cloudSqlInstance": { "$ref": "GoogleCloudRunV2CloudSqlInstance", "description": "For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run." }, "nfs": { "$ref": "GoogleCloudRunV2NFSVolumeSource", "description": "For NFS Voumes, contains the path to the nfs Volume" }, "secret": { "$ref": "GoogleCloudRunV2SecretVolumeSource", "description": "Secret represents a secret that should populate this volume." }, "name": { "type": "string", "description": "Required. Volume's name." }, "gcs": { "description": "Persistent storage backed by a Google Cloud Storage bucket.", "$ref": "GoogleCloudRunV2GCSVolumeSource" } } }, "GoogleCloudRunV2ExportImageResponse": { "properties": { "operationId": { "description": "An operation ID used to track the status of image exports tied to the original pod ID in the request.", "type": "string" } }, "type": "object", "description": "ExportImageResponse contains an operation Id to track the image export operation.", "id": "GoogleCloudRunV2ExportImageResponse" }, "GoogleCloudRunV2SubmitBuildResponse": { "description": "Response message for submitting a Build.", "id": "GoogleCloudRunV2SubmitBuildResponse", "properties": { "baseImageUri": { "description": "URI of the base builder image in Artifact Registry being used in the build. Used to opt into automatic base image updates.", "type": "string" }, "baseImageWarning": { "description": "Warning message for the base image.", "type": "string" }, "buildOperation": { "$ref": "GoogleLongrunningOperation", "description": "Cloud Build operation to be polled via CloudBuild API." } }, "type": "object" }, "GoogleCloudRunV2UploadSourceRequest": { "id": "GoogleCloudRunV2UploadSourceRequest", "type": "object", "description": "The request message for the UploadSource method.", "properties": { "service": { "description": "The name of Cloud Run Service upload source archive will be used for.", "type": "string" } } }, "GoogleCloudRunV2VersionToPath": { "properties": { "mode": { "description": "Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", "type": "integer", "format": "int32" }, "path": { "description": "Required. The relative path of the secret in the container.", "type": "string" }, "version": { "description": "The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version.", "type": "string" } }, "description": "VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path.", "type": "object", "id": "GoogleCloudRunV2VersionToPath" }, "GoogleCloudRunV2ListTasksResponse": { "type": "object", "id": "GoogleCloudRunV2ListTasksResponse", "properties": { "nextPageToken": { "description": "A token indicating there are more items than page_size. Use it in the next ListTasks request to continue.", "type": "string" }, "tasks": { "description": "The resulting list of Tasks.", "items": { "$ref": "GoogleCloudRunV2Task" }, "type": "array" } }, "description": "Response message containing a list of Tasks." }, "GoogleCloudRunV2ContainerStatus": { "id": "GoogleCloudRunV2ContainerStatus", "type": "object", "description": "ContainerStatus holds the information of container name and image digest value.", "properties": { "imageDigest": { "description": "ImageDigest holds the resolved digest for the image specified and resolved during the creation of Revision. This field holds the digest value regardless of whether a tag or digest was originally specified in the Container object.", "type": "string" }, "name": { "description": "The name of the container, if specified.", "type": "string" } } }, "GoogleCloudRunV2StorageSource": { "id": "GoogleCloudRunV2StorageSource", "properties": { "generation": { "description": "Optional. Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", "format": "int64", "type": "string" }, "object": { "type": "string", "description": "Required. Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build." }, "bucket": { "description": "Required. Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", "type": "string" } }, "description": "Location of the source in an archive file in Google Cloud Storage.", "type": "object" }, "GoogleCloudRunV2Container": { "type": "object", "properties": { "readinessProbe": { "description": "Readiness probe to be used for health checks.", "$ref": "GoogleCloudRunV2Probe" }, "baseImageUri": { "description": "Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update.", "type": "string" }, "args": { "type": "array", "description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided.", "items": { "type": "string" } }, "command": { "description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.", "type": "array", "items": { "type": "string" } }, "volumeMounts": { "description": "Volume to mount into the container's filesystem.", "type": "array", "items": { "$ref": "GoogleCloudRunV2VolumeMount" } }, "startupProbe": { "description": "Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails.", "$ref": "GoogleCloudRunV2Probe" }, "sourceCode": { "description": "Optional. Location of the source. This field is only supported in Cloud Run Service.", "$ref": "GoogleCloudRunV2SourceCode" }, "ports": { "items": { "$ref": "GoogleCloudRunV2ContainerPort" }, "description": "List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.", "type": "array" }, "sandboxLauncher": { "type": "boolean", "description": "Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes." }, "buildInfo": { "description": "Output only. The build info of the container image.", "$ref": "GoogleCloudRunV2BuildInfo", "readOnly": true }, "env": { "items": { "$ref": "GoogleCloudRunV2EnvVar" }, "description": "List of environment variables to set in the container.", "type": "array" }, "image": { "description": "Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.", "type": "string" }, "dependsOn": { "description": "Names of the containers that must start before this container.", "type": "array", "items": { "type": "string" } }, "workingDir": { "description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.", "type": "string" }, "livenessProbe": { "$ref": "GoogleCloudRunV2Probe", "description": "Periodic probe of container liveness. Container will be restarted if the probe fails." }, "resources": { "$ref": "GoogleCloudRunV2ResourceRequirements", "description": "Compute Resource requirements by this container." }, "name": { "type": "string", "description": "Name of the container specified as a DNS_LABEL (RFC 1123)." } }, "description": "A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments can be supplied by the system to the container at runtime.", "id": "GoogleCloudRunV2Container" }, "GoogleDevtoolsCloudbuildV1PoolOption": { "type": "object", "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.", "id": "GoogleDevtoolsCloudbuildV1PoolOption", "properties": { "resolvedWorkerRelease": { "description": "Output only. OUTPUT_ONLY. Worker release resolved from the release channel.", "readOnly": true, "type": "string" }, "workerRelease": { "description": "Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access.", "readOnly": true, "type": "string" }, "name": { "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}", "type": "string" } } }, "GoogleDevtoolsCloudbuildV1Secrets": { "type": "object", "id": "GoogleDevtoolsCloudbuildV1Secrets", "properties": { "secretManager": { "description": "Secrets in Secret Manager and associated secret environment variable.", "type": "array", "items": { "$ref": "GoogleDevtoolsCloudbuildV1SecretManagerSecret" } }, "inline": { "type": "array", "items": { "$ref": "GoogleDevtoolsCloudbuildV1InlineSecret" }, "description": "Secrets encrypted with KMS key and the associated secret environment variable." } }, "description": "Secrets and secret environment variables." }, "GoogleDevtoolsCloudbuildV1BuildStepResults": { "id": "GoogleDevtoolsCloudbuildV1BuildStepResults", "description": "Results for a build step.", "properties": { "results": { "type": "object", "description": "Results for a build step.", "additionalProperties": { "type": "string" } } }, "type": "object" }, "GoogleDevtoolsCloudbuildV1BuiltImage": { "type": "object", "properties": { "ociMediaType": { "type": "string", "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." ], "enum": [ "OCI_MEDIA_TYPE_UNSPECIFIED", "IMAGE_MANIFEST", "IMAGE_INDEX" ], "description": "Output only. The OCI media type of the artifact. Non-OCI images, such as Docker images, will have an unspecified value.", "readOnly": true }, "pushTiming": { "description": "Output only. Stores timing information for pushing the specified image.", "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", "readOnly": true }, "artifactRegistryPackage": { "type": "string", "readOnly": true, "description": "Output only. Path to the artifact in Artifact Registry." }, "name": { "type": "string", "description": "Name used to push the container image to Google Container Registry, as presented to `docker push`." }, "digest": { "description": "Docker Registry 2.0 digest.", "type": "string" } }, "description": "An image built by the pipeline.", "id": "GoogleDevtoolsCloudbuildV1BuiltImage" }, "GoogleDevtoolsCloudbuildV1Warning": { "properties": { "priority": { "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" ], "description": "The priority for this warning.", "type": "string", "enum": [ "PRIORITY_UNSPECIFIED", "INFO", "WARNING", "ALERT" ] }, "text": { "type": "string", "description": "Explanation of the warning generated." } }, "description": "A non-fatal problem encountered during the execution of the build.", "id": "GoogleDevtoolsCloudbuildV1Warning", "type": "object" }, "GoogleCloudRunV2ExportImageRequest": { "properties": { "destinationRepo": { "description": "Required. The export destination url (the Artifact Registry repo).", "type": "string" } }, "description": "Request message for exporting Cloud Run image.", "type": "object", "id": "GoogleCloudRunV2ExportImageRequest" }, "GoogleCloudRunV2TrafficTargetStatus": { "description": "Represents the observed state of a single `TrafficTarget` entry.", "type": "object", "id": "GoogleCloudRunV2TrafficTargetStatus", "properties": { "type": { "type": "string", "enum": [ "TRAFFIC_TARGET_ALLOCATION_TYPE_UNSPECIFIED", "TRAFFIC_TARGET_ALLOCATION_TYPE_LATEST", "TRAFFIC_TARGET_ALLOCATION_TYPE_REVISION" ], "enumDescriptions": [ "Unspecified instance allocation type.", "Allocates instances to the Service's latest ready Revision.", "Allocates instances to a Revision by name." ], "description": "The allocation type for this traffic target." }, "revision": { "description": "Revision to which this traffic is sent.", "type": "string" }, "tag": { "description": "Indicates the string used in the URI to exclusively reference this target.", "type": "string" }, "uri": { "type": "string", "description": "Displays the target URI." }, "percent": { "format": "int32", "type": "integer", "description": "Specifies percent of the traffic to this Revision." } } }, "GoogleDevtoolsCloudbuildV1Hash": { "description": "Container message for hash values.", "type": "object", "id": "GoogleDevtoolsCloudbuildV1Hash", "properties": { "type": { "description": "The type of hash that was performed.", "type": "string", "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." ] }, "value": { "description": "The hash value.", "format": "byte", "type": "string" } } }, "GoogleCloudRunV2ServiceMesh": { "type": "object", "properties": { "mesh": { "description": "The Mesh resource name. Format: `projects/{project}/locations/global/meshes/{mesh}`, where `{project}` can be project id or number.", "type": "string" } }, "id": "GoogleCloudRunV2ServiceMesh", "description": "Settings for Cloud Service Mesh. For more information see https://cloud.google.com/service-mesh/docs/overview." }, "GoogleRpcStatus": { "type": "object", "id": "GoogleRpcStatus", "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" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "type": "array" }, "code": { "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer" } }, "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)." }, "GoogleDevtoolsCloudbuildV1BuildApproval": { "properties": { "state": { "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." ], "type": "string", "description": "Output only. The state of this build's approval.", "enum": [ "STATE_UNSPECIFIED", "PENDING", "APPROVED", "REJECTED", "CANCELLED" ], "readOnly": true }, "result": { "readOnly": true, "$ref": "GoogleDevtoolsCloudbuildV1ApprovalResult", "description": "Output only. Result of manual approval for this Build." }, "config": { "description": "Output only. Configuration for manual approval of this build.", "$ref": "GoogleDevtoolsCloudbuildV1ApprovalConfig", "readOnly": true } }, "type": "object", "id": "GoogleDevtoolsCloudbuildV1BuildApproval", "description": "BuildApproval describes a build's approval configuration, state, and result." }, "GoogleDevtoolsCloudbuildV1RepoSource": { "description": "Location of the source in a Google Cloud Source Repository.", "type": "object", "properties": { "invertRegex": { "type": "boolean", "description": "Optional. Only trigger a build if the revision regex does NOT match the revision regex." }, "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." }, "commitSha": { "description": "Explicit commit SHA to build.", "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" }, "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" }, "projectId": { "description": "Optional. ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.", "type": "string" }, "repoName": { "type": "string", "description": "Required. Name of the Cloud Source Repository." }, "substitutions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Substitutions to use in a triggered build. Should only be used with RunBuildTrigger" } }, "id": "GoogleDevtoolsCloudbuildV1RepoSource" }, "GoogleCloudRunV2SecretKeySelector": { "type": "object", "properties": { "version": { "type": "string", "description": "The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias." }, "secret": { "description": "Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project.", "type": "string" } }, "id": "GoogleCloudRunV2SecretKeySelector", "description": "SecretEnvVarSource represents a source for the value of an EnvVar." }, "GoogleCloudRunV2SourceCode": { "type": "object", "id": "GoogleCloudRunV2SourceCode", "description": "Source type for the container.", "properties": { "inlinedSource": { "description": "Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service.", "$ref": "GoogleCloudRunV2InlinedSource" }, "cloudStorageSource": { "$ref": "GoogleCloudRunV2CloudStorageSource", "description": "The source is a Cloud Storage bucket." } } }, "GoogleDevtoolsCloudbuildV1ArtifactObjects": { "type": "object", "id": "GoogleDevtoolsCloudbuildV1ArtifactObjects", "description": "Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.", "properties": { "location": { "type": "string", "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." }, "paths": { "type": "array", "items": { "type": "string" }, "description": "Path globs used to match files in the build's workspace." }, "timing": { "description": "Output only. Stores timing information for pushing all artifact objects.", "readOnly": true, "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan" } } }, "GoogleDevtoolsCloudbuildV1ApprovalResult": { "description": "ApprovalResult describes the decision and associated metadata of a manual approval of a build.", "type": "object", "id": "GoogleDevtoolsCloudbuildV1ApprovalResult", "properties": { "url": { "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.", "type": "string" }, "approvalTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time when the approval decision was made." }, "approverAccount": { "readOnly": true, "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.", "type": "string" }, "decision": { "type": "string", "enum": [ "DECISION_UNSPECIFIED", "APPROVED", "REJECTED" ], "enumDescriptions": [ "Default enum type. This should not be used.", "Build is approved.", "Build is rejected." ], "description": "Required. The decision of this manual approval." }, "comment": { "type": "string", "description": "Optional. An optional comment for this manual approval result." } } }, "GoogleDevtoolsCloudbuildV1Volume": { "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" } }, "id": "GoogleDevtoolsCloudbuildV1Volume", "description": "Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution." }, "GoogleCloudRunV2CancelExecutionRequest": { "id": "GoogleCloudRunV2CancelExecutionRequest", "description": "Request message for deleting an Execution.", "type": "object", "properties": { "validateOnly": { "type": "boolean", "description": "Indicates that the request should be validated without actually cancelling any resources." }, "etag": { "type": "string", "description": "A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates." } } }, "GoogleCloudRunV2ResourceRequirements": { "properties": { "cpuIdle": { "description": "Determines whether CPU is only allocated during requests (true by default). However, if ResourceRequirements is set, the caller must explicitly set this field to true to preserve the default behavior.", "type": "boolean" }, "startupCpuBoost": { "type": "boolean", "description": "Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency." }, "limits": { "additionalProperties": { "type": "string" }, "description": "Only `memory`, `cpu` and `nvidia.com/gpu` keys in the map are supported. Notes: * The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits * The only supported 'nvidia.com/gpu' value is '1'.", "type": "object" } }, "description": "ResourceRequirements describes the compute resource requirements.", "type": "object", "id": "GoogleCloudRunV2ResourceRequirements" }, "GoogleDevtoolsCloudbuildV1SecretManagerSecret": { "id": "GoogleDevtoolsCloudbuildV1SecretManagerSecret", "description": "Pairs a secret environment variable with a SecretVersion in Secret Manager.", "properties": { "versionName": { "description": "Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*", "type": "string" }, "env": { "type": "string", "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": "object" }, "GoogleDevtoolsCloudbuildV1GenericArtifactDependency": { "id": "GoogleDevtoolsCloudbuildV1GenericArtifactDependency", "properties": { "resource": { "description": "Required. The location to download the artifact files from. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1", "type": "string" }, "destPath": { "type": "string", "description": "Optional. Where the artifact files should be placed on the worker. Required when specified in `Build.dependencies`." } }, "description": "Represents a generic artifact as a build dependency.", "type": "object" }, "GoogleCloudRunV2CloudSqlInstance": { "properties": { "instances": { "items": { "type": "string" }, "type": "array", "description": "A list of Cloud SQL instance connection names. Cloud Run uses these to establish connections to the specified Cloud SQL instances. While the SQL instance name itself is unique within a project, the full connection name requires the location for proper routing. Format: `{project}:{location}:{instance}` Example: `my-project:us-central1:my-instance` You can find this value on the instance's **Overview** page in the Google Cloud console or by using the following `gcloud` command: ```sh gcloud sql instances describe INSTANCE_NAME \\ --format='value(connectionName)' ``` Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run." } }, "type": "object", "id": "GoogleCloudRunV2CloudSqlInstance", "description": "Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run." }, "GoogleCloudRunV2ListWorkerPoolsResponse": { "id": "GoogleCloudRunV2ListWorkerPoolsResponse", "type": "object", "properties": { "nextPageToken": { "description": "A token indicating there are more items than page_size. Use it in the next ListWorkerPools request to continue.", "type": "string" }, "workerPools": { "description": "The resulting list of WorkerPools.", "type": "array", "items": { "$ref": "GoogleCloudRunV2WorkerPool" } } }, "description": "Response message containing a list of WorkerPools." }, "GoogleCloudRunV2EmptyDirVolumeSource": { "id": "GoogleCloudRunV2EmptyDirVolumeSource", "properties": { "sizeLimit": { "description": "Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir", "type": "string" }, "medium": { "type": "string", "enum": [ "MEDIUM_UNSPECIFIED", "MEMORY", "DISK" ], "enumDescriptions": [ "When not specified, falls back to the default implementation which is currently in memory (this may change over time).", "Explicitly set the EmptyDir to be in memory. Uses tmpfs.", "Explicitly sets the EmptyDir to be a disk." ], "description": "The medium on which the data is stored. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional" } }, "description": "In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs).", "type": "object" }, "GoogleDevtoolsCloudbuildV1PythonPackage": { "id": "GoogleDevtoolsCloudbuildV1PythonPackage", "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", "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": { "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.", "items": { "type": "string" }, "type": "array" } } }, "GoogleIamV1TestIamPermissionsResponse": { "type": "object", "description": "Response message for `TestIamPermissions` method.", "id": "GoogleIamV1TestIamPermissionsResponse", "properties": { "permissions": { "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "type": "array", "items": { "type": "string" } } } }, "GoogleDevtoolsCloudbuildV1UploadedGenericArtifact": { "description": "A generic artifact uploaded to Artifact Registry using the GenericArtifact directive.", "properties": { "artifactRegistryPackage": { "readOnly": true, "description": "Output only. Path to the artifact in Artifact Registry.", "type": "string" }, "pushTiming": { "description": "Output only. Stores timing information for pushing the specified artifact.", "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", "readOnly": true }, "artifactFingerprint": { "$ref": "GoogleDevtoolsCloudbuildV1FileHashes", "readOnly": true, "description": "Output only. The hash of the whole artifact." }, "fileHashes": { "readOnly": true, "description": "Output only. The file hashes that make up the generic artifact.", "type": "object", "additionalProperties": { "$ref": "GoogleDevtoolsCloudbuildV1FileHashes" } }, "uri": { "description": "Output only. URI of the uploaded artifact. Ex: projects/p1/locations/us/repositories/r1/packages/p1/versions/v1", "type": "string", "readOnly": true } }, "type": "object", "id": "GoogleDevtoolsCloudbuildV1UploadedGenericArtifact" }, "GoogleCloudRunV2RevisionScaling": { "type": "object", "properties": { "concurrencyUtilization": { "type": "number", "description": "Optional. Determines a threshold for concurrency utilization before scaling begins. Accepted values are between `0.1` and `0.95` (inclusive) or `0.0` to disable concurrency utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled.", "format": "float" }, "maxInstanceCount": { "type": "integer", "description": "Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances", "format": "int32" }, "cpuUtilization": { "description": "Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.90` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled.", "type": "number", "format": "float" }, "minInstanceCount": { "description": "Optional. Minimum number of serving instances that this resource should have.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudRunV2RevisionScaling", "description": "Settings for revision-level scaling settings." }, "GoogleDevtoolsCloudbuildV1Oci": { "id": "GoogleDevtoolsCloudbuildV1Oci", "description": "OCI image to upload to Artifact Registry upon successful completion of all build steps.", "properties": { "tags": { "description": "Optional. Tags to apply to the uploaded image. e.g. latest, 1.0.0", "type": "array", "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" }, "file": { "description": "Required. Path on the local file system where to find the container to upload. e.g. /workspace/my-image.tar", "type": "string" } }, "type": "object" }, "GoogleCloudRunV2GCSVolumeSource": { "description": "Represents a volume backed by a Cloud Storage bucket using Cloud Storage FUSE.", "properties": { "bucket": { "description": "Cloud Storage Bucket name.", "type": "string" }, "mountOptions": { "description": "A list of additional flags to pass to the gcsfuse CLI. Options should be specified without the leading \"--\".", "items": { "type": "string" }, "type": "array" }, "readOnly": { "type": "boolean", "description": "If true, the volume will be mounted as read only for all mounts." } }, "type": "object", "id": "GoogleCloudRunV2GCSVolumeSource" }, "GoogleCloudRunV2TrafficTarget": { "type": "object", "id": "GoogleCloudRunV2TrafficTarget", "properties": { "type": { "description": "The allocation type for this traffic target.", "enumDescriptions": [ "Unspecified instance allocation type.", "Allocates instances to the Service's latest ready Revision.", "Allocates instances to a Revision by name." ], "type": "string", "enum": [ "TRAFFIC_TARGET_ALLOCATION_TYPE_UNSPECIFIED", "TRAFFIC_TARGET_ALLOCATION_TYPE_LATEST", "TRAFFIC_TARGET_ALLOCATION_TYPE_REVISION" ] }, "tag": { "type": "string", "description": "Indicates a string to be part of the URI to exclusively reference this target." }, "revision": { "description": "Revision to which to send this portion of traffic, if traffic allocation is by revision.", "type": "string" }, "percent": { "format": "int32", "type": "integer", "description": "Specifies percent of the traffic to this Revision. This defaults to zero if unspecified." } }, "description": "Holds a single traffic routing entry for the Service. Allocations can be done to a specific Revision name, or pointing to the latest Ready Revision." }, "GoogleCloudRunV2ListInstancesResponse": { "id": "GoogleCloudRunV2ListInstancesResponse", "type": "object", "description": "Response message containing a list of Instances.", "properties": { "instances": { "description": "The resulting list of Instances.", "items": { "$ref": "GoogleCloudRunV2Instance" }, "type": "array" }, "nextPageToken": { "description": "A token indicating there are more items than page_size. Use it in the next ListInstances request to continue.", "type": "string" } } }, "GoogleCloudRunV2UploadSourceResponse": { "type": "object", "description": "The response message for the UploadSource method.", "id": "GoogleCloudRunV2UploadSourceResponse", "properties": { "cloudStorageSource": { "description": "The Cloud Storage object path the source archive is uploaded to.", "$ref": "GoogleCloudRunV2CloudStorageSource" } } }, "GoogleCloudRunV2BuildInfo": { "description": "Build information of the image.", "id": "GoogleCloudRunV2BuildInfo", "properties": { "functionTarget": { "type": "string", "readOnly": true, "description": "Output only. Entry point of the function when the image is a Cloud Run function." }, "sourceLocation": { "readOnly": true, "type": "string", "description": "Output only. Source code location of the image." } }, "type": "object" }, "GoogleCloudRunV2StartInstanceRequest": { "properties": { "etag": { "type": "string", "description": "Optional. A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates." }, "validateOnly": { "description": "Optional. Indicates that the request should be validated without actually stopping any resources.", "type": "boolean" } }, "id": "GoogleCloudRunV2StartInstanceRequest", "type": "object", "description": "Request message for starting an Instance." }, "GoogleCloudRunV2ServiceScaling": { "id": "GoogleCloudRunV2ServiceScaling", "properties": { "maxInstanceCount": { "format": "int32", "description": "Optional. total max instances for the service. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving.", "type": "integer" }, "scalingMode": { "description": "Optional. The scaling mode for the service.", "enumDescriptions": [ "Unspecified.", "Scale based on traffic between min and max instances.", "Scale to exactly min instances and ignore max instances." ], "type": "string", "enum": [ "SCALING_MODE_UNSPECIFIED", "AUTOMATIC", "MANUAL" ] }, "manualInstanceCount": { "description": "Optional. total instance count for the service in manual scaling mode. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving.", "type": "integer", "format": "int32" }, "minInstanceCount": { "type": "integer", "description": "Optional. total min instances for the service. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving.", "format": "int32" } }, "description": "Scaling settings applied at the service level rather than at the revision level.", "type": "object" }, "GoogleCloudRunV2BuildConfig": { "id": "GoogleCloudRunV2BuildConfig", "properties": { "workerPool": { "description": "Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the Cloud Run function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where `{project}` and `{region}` are the project id and region respectively where the worker pool is defined and `{workerPool}` is the short name of the worker pool.", "type": "string" }, "imageUri": { "type": "string", "description": "Optional. Artifact Registry URI to store the built image." }, "environmentVariables": { "description": "Optional. User-provided build-time environment variables for the function", "type": "object", "additionalProperties": { "type": "string" } }, "functionTarget": { "type": "string", "description": "Optional. The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named \"function\"." }, "sourceLocation": { "description": "The Cloud Storage bucket URI where the function source code is located.", "type": "string" }, "enableAutomaticUpdates": { "type": "boolean", "description": "Optional. Sets whether the function will receive automatic base image updates." }, "serviceAccount": { "description": "Optional. Service account to be used for building the container. The format of this field is `projects/{projectId}/serviceAccounts/{serviceAccountEmail}`.", "type": "string" }, "name": { "readOnly": true, "description": "Output only. The Cloud Build name of the latest successful deployment of the function.", "type": "string" }, "baseImage": { "description": "Optional. The base image used to build the function.", "type": "string" } }, "type": "object", "description": "Describes the Build step of the function that builds a container from the given source." }, "GoogleCloudRunV2WorkerPoolRevisionTemplate": { "type": "object", "id": "GoogleCloudRunV2WorkerPoolRevisionTemplate", "properties": { "containers": { "description": "Holds list of the containers that defines the unit of execution for this Revision.", "type": "array", "items": { "$ref": "GoogleCloudRunV2Container" } }, "encryptionKeyRevocationAction": { "enumDescriptions": [ "Unspecified", "Prevents the creation of new instances.", "Shuts down existing instances, and prevents creation of new ones." ], "description": "Optional. The action to take if the encryption key is revoked.", "type": "string", "enum": [ "ENCRYPTION_KEY_REVOCATION_ACTION_UNSPECIFIED", "PREVENT_NEW", "SHUTDOWN" ] }, "client": { "type": "string", "description": "Optional. Arbitrary identifier for the API client." }, "labels": { "description": "Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate.", "additionalProperties": { "type": "string" }, "type": "object" }, "serviceAccount": { "type": "string", "description": "Optional. Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account." }, "encryptionKeyShutdownDuration": { "format": "google-duration", "description": "Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.", "type": "string" }, "encryptionKey": { "description": "A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek", "type": "string" }, "annotations": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules." }, "volumes": { "description": "Optional. A list of Volumes to make available to containers.", "type": "array", "items": { "$ref": "GoogleCloudRunV2Volume" } }, "vpcAccess": { "$ref": "GoogleCloudRunV2VpcAccess", "description": "Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc." }, "gpuZonalRedundancyDisabled": { "description": "Optional. True if GPU zonal redundancy is disabled on this worker pool.", "type": "boolean" }, "serviceMesh": { "$ref": "GoogleCloudRunV2ServiceMesh", "description": "Optional. Enables service mesh connectivity." }, "revision": { "description": "Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the WorkerPool name.", "type": "string" }, "nodeSelector": { "description": "Optional. The node selector for the revision template.", "$ref": "GoogleCloudRunV2NodeSelector" }, "clientVersion": { "type": "string", "description": "Optional. Arbitrary version identifier for the API client." } }, "description": "WorkerPoolRevisionTemplate describes the data a worker pool revision should have when created from a template." }, "GoogleDevtoolsCloudbuildV1BuildOperationMetadata": { "description": "Metadata for build operations.", "id": "GoogleDevtoolsCloudbuildV1BuildOperationMetadata", "properties": { "build": { "description": "The build that the operation is tracking.", "$ref": "GoogleDevtoolsCloudbuildV1Build" } }, "type": "object" }, "GoogleCloudRunV2DockerBuild": { "id": "GoogleCloudRunV2DockerBuild", "description": "Build the source using Docker. This means the source has a Dockerfile.", "type": "object", "properties": {} }, "GoogleDevtoolsCloudbuildV1BuildStep": { "id": "GoogleDevtoolsCloudbuildV1BuildStep", "properties": { "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." }, "env": { "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\".", "items": { "type": "string" }, "type": "array" }, "volumes": { "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.", "type": "array", "items": { "$ref": "GoogleDevtoolsCloudbuildV1Volume" } }, "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" }, "entrypoint": { "type": "string", "description": "Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used." }, "id": { "type": "string", "description": "Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency." }, "args": { "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.", "items": { "type": "string" } }, "pullTiming": { "description": "Output only. Stores timing information for pulling this build step's builder image only.", "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", "readOnly": true }, "secretEnv": { "type": "array", "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`.", "items": { "type": "string" } }, "allowExitCodes": { "type": "array", "items": { "format": "int32", "type": "integer" }, "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." }, "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" }, "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" }, "results": { "description": "Declaration of results for this build step.", "type": "array", "items": { "$ref": "GoogleDevtoolsCloudbuildV1StepResult" } }, "exitCode": { "description": "Output only. Return code from running the step.", "format": "int32", "type": "integer", "readOnly": true }, "status": { "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`." ], "readOnly": true, "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.", "enum": [ "STATUS_UNKNOWN", "PENDING", "QUEUED", "WORKING", "SUCCESS", "FAILURE", "INTERNAL_ERROR", "TIMEOUT", "CANCELLED", "EXPIRED" ] }, "timeout": { "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.", "format": "google-duration", "type": "string" }, "timing": { "readOnly": true, "$ref": "GoogleDevtoolsCloudbuildV1TimeSpan", "description": "Output only. Stores timing information for executing this build step." }, "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." }, "waitFor": { "items": { "type": "string" }, "type": "array", "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." } }, "description": "A step in the build pipeline.", "type": "object" }, "GoogleDevtoolsCloudbuildV1GoModule": { "id": "GoogleDevtoolsCloudbuildV1GoModule", "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": { "repositoryProjectId": { "description": "Optional. Project ID of the Artifact Registry repository. Defaults to the build project.", "type": "string" }, "modulePath": { "type": "string", "description": "Optional. The Go module's \"module path\". e.g. example.com/foo/v2" }, "repositoryLocation": { "description": "Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location.", "type": "string" }, "repositoryName": { "type": "string", "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" }, "moduleVersion": { "type": "string", "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" }, "sourcePath": { "type": "string", "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" } } }, "GoogleCloudRunV2TaskAttemptResult": { "properties": { "status": { "description": "Output only. The status of this attempt. If the status code is OK, then the attempt succeeded.", "readOnly": true, "$ref": "GoogleRpcStatus" }, "termSignal": { "type": "integer", "description": "Output only. Termination signal of the container. This is set to non-zero if the container is terminated by the system. At most one of exit_code or term_signal will be set.", "format": "int32", "readOnly": true }, "exitCode": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details. At most one of exit_code or term_signal will be set." } }, "id": "GoogleCloudRunV2TaskAttemptResult", "type": "object", "description": "Result of a task attempt." }, "GoogleDevtoolsCloudbuildV1Dependency": { "type": "object", "id": "GoogleDevtoolsCloudbuildV1Dependency", "description": "A dependency that the Cloud Build worker will fetch before executing user steps.", "properties": { "genericArtifact": { "$ref": "GoogleDevtoolsCloudbuildV1GenericArtifactDependency", "description": "Represents a generic artifact as a build dependency." }, "empty": { "description": "If set to true disable all dependency fetching (ignoring the default source as well).", "type": "boolean" }, "gitSource": { "description": "Represents a git repository as a build dependency.", "$ref": "GoogleDevtoolsCloudbuildV1GitSourceDependency" } } } }, "endpoints": [ { "description": "Locational Endpoint", "location": "africa-south1", "endpointUrl": "https://africa-south1-run.googleapis.com/" }, { "endpointUrl": "https://asia-east1-run.googleapis.com/", "description": "Locational Endpoint", "location": "asia-east1" }, { "description": "Locational Endpoint", "endpointUrl": "https://asia-east2-run.googleapis.com/", "location": "asia-east2" }, { "endpointUrl": "https://asia-northeast1-run.googleapis.com/", "description": "Locational Endpoint", "location": "asia-northeast1" }, { "endpointUrl": "https://asia-northeast2-run.googleapis.com/", "location": "asia-northeast2", "description": "Locational Endpoint" }, { "description": "Locational Endpoint", "location": "asia-northeast3", "endpointUrl": "https://asia-northeast3-run.googleapis.com/" }, { "location": "asia-south1", "description": "Locational Endpoint", "endpointUrl": "https://asia-south1-run.googleapis.com/" }, { "description": "Locational Endpoint", "location": "asia-south2", "endpointUrl": "https://asia-south2-run.googleapis.com/" }, { "location": "asia-southeast1", "endpointUrl": "https://asia-southeast1-run.googleapis.com/", "description": "Locational Endpoint" }, { "endpointUrl": "https://asia-southeast2-run.googleapis.com/", "location": "asia-southeast2", "description": "Locational Endpoint" }, { "location": "asia-southeast3", "endpointUrl": "https://asia-southeast3-run.googleapis.com/", "description": "Locational Endpoint" }, { "endpointUrl": "https://asia-southeast4-run.googleapis.com/", "location": "asia-southeast4", "description": "Locational Endpoint" }, { "endpointUrl": "https://australia-southeast1-run.googleapis.com/", "location": "australia-southeast1", "description": "Locational Endpoint" }, { "location": "australia-southeast2", "description": "Locational Endpoint", "endpointUrl": "https://australia-southeast2-run.googleapis.com/" }, { "description": "Locational Endpoint", "endpointUrl": "https://europe-central2-run.googleapis.com/", "location": "europe-central2" }, { "description": "Locational Endpoint", "location": "europe-north1", "endpointUrl": "https://europe-north1-run.googleapis.com/" }, { "description": "Locational Endpoint", "location": "europe-north2", "endpointUrl": "https://europe-north2-run.googleapis.com/" }, { "location": "europe-southwest1", "endpointUrl": "https://europe-southwest1-run.googleapis.com/", "description": "Locational Endpoint" }, { "endpointUrl": "https://europe-west1-run.googleapis.com/", "description": "Locational Endpoint", "location": "europe-west1" }, { "location": "europe-west10", "description": "Locational Endpoint", "endpointUrl": "https://europe-west10-run.googleapis.com/" }, { "description": "Locational Endpoint", "endpointUrl": "https://europe-west12-run.googleapis.com/", "location": "europe-west12" }, { "endpointUrl": "https://europe-west15-run.googleapis.com/", "location": "europe-west15", "description": "Locational Endpoint" }, { "endpointUrl": "https://europe-west2-run.googleapis.com/", "location": "europe-west2", "description": "Locational Endpoint" }, { "endpointUrl": "https://europe-west3-run.googleapis.com/", "description": "Locational Endpoint", "location": "europe-west3" }, { "endpointUrl": "https://europe-west4-run.googleapis.com/", "description": "Locational Endpoint", "location": "europe-west4" }, { "description": "Locational Endpoint", "location": "europe-west6", "endpointUrl": "https://europe-west6-run.googleapis.com/" }, { "description": "Locational Endpoint", "location": "europe-west8", "endpointUrl": "https://europe-west8-run.googleapis.com/" }, { "description": "Locational Endpoint", "endpointUrl": "https://europe-west9-run.googleapis.com/", "location": "europe-west9" }, { "description": "Locational Endpoint", "location": "me-central1", "endpointUrl": "https://me-central1-run.googleapis.com/" }, { "endpointUrl": "https://me-central2-run.googleapis.com/", "location": "me-central2", "description": "Locational Endpoint" }, { "endpointUrl": "https://me-west1-run.googleapis.com/", "location": "me-west1", "description": "Locational Endpoint" }, { "description": "Locational Endpoint", "endpointUrl": "https://northamerica-northeast1-run.googleapis.com/", "location": "northamerica-northeast1" }, { "location": "northamerica-northeast2", "description": "Locational Endpoint", "endpointUrl": "https://northamerica-northeast2-run.googleapis.com/" }, { "location": "northamerica-south1", "endpointUrl": "https://northamerica-south1-run.googleapis.com/", "description": "Locational Endpoint" }, { "endpointUrl": "https://southamerica-east1-run.googleapis.com/", "location": "southamerica-east1", "description": "Locational Endpoint" }, { "description": "Locational Endpoint", "location": "southamerica-west1", "endpointUrl": "https://southamerica-west1-run.googleapis.com/" }, { "endpointUrl": "https://us-central1-run.googleapis.com/", "location": "us-central1", "description": "Locational Endpoint" }, { "endpointUrl": "https://us-central2-run.googleapis.com/", "location": "us-central2", "description": "Locational Endpoint" }, { "description": "Locational Endpoint", "endpointUrl": "https://us-east1-run.googleapis.com/", "location": "us-east1" }, { "location": "us-east4", "description": "Locational Endpoint", "endpointUrl": "https://us-east4-run.googleapis.com/" }, { "endpointUrl": "https://us-east5-run.googleapis.com/", "location": "us-east5", "description": "Locational Endpoint" }, { "location": "us-east7", "endpointUrl": "https://us-east7-run.googleapis.com/", "description": "Locational Endpoint" }, { "location": "us-south1", "description": "Locational Endpoint", "endpointUrl": "https://us-south1-run.googleapis.com/" }, { "description": "Locational Endpoint", "location": "us-west1", "endpointUrl": "https://us-west1-run.googleapis.com/" }, { "endpointUrl": "https://us-west2-run.googleapis.com/", "description": "Locational Endpoint", "location": "us-west2" }, { "endpointUrl": "https://us-west3-run.googleapis.com/", "location": "us-west3", "description": "Locational Endpoint" }, { "description": "Locational Endpoint", "endpointUrl": "https://us-west4-run.googleapis.com/", "location": "us-west4" }, { "location": "us-west8", "description": "Locational Endpoint", "endpointUrl": "https://us-west8-run.googleapis.com/" }, { "location": "africa-south1", "description": "Regional Endpoint", "endpointUrl": "https://run.africa-south1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "asia-east1", "endpointUrl": "https://run.asia-east1.rep.googleapis.com/" }, { "endpointUrl": "https://run.asia-east2.rep.googleapis.com/", "location": "asia-east2", "description": "Regional Endpoint" }, { "location": "asia-northeast1", "description": "Regional Endpoint", "endpointUrl": "https://run.asia-northeast1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "endpointUrl": "https://run.asia-northeast2.rep.googleapis.com/", "location": "asia-northeast2" }, { "description": "Regional Endpoint", "endpointUrl": "https://run.asia-northeast3.rep.googleapis.com/", "location": "asia-northeast3" }, { "description": "Regional Endpoint", "location": "asia-south1", "endpointUrl": "https://run.asia-south1.rep.googleapis.com/" }, { "endpointUrl": "https://run.asia-south2.rep.googleapis.com/", "location": "asia-south2", "description": "Regional Endpoint" }, { "endpointUrl": "https://run.asia-southeast1.rep.googleapis.com/", "location": "asia-southeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://run.asia-southeast2.rep.googleapis.com/", "location": "asia-southeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://run.asia-southeast3.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-southeast3" }, { "description": "Regional Endpoint", "location": "asia-southeast4", "endpointUrl": "https://run.asia-southeast4.rep.googleapis.com/" }, { "endpointUrl": "https://run.australia-southeast1.rep.googleapis.com/", "location": "australia-southeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://run.australia-southeast2.rep.googleapis.com/", "location": "australia-southeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://run.europe-central2.rep.googleapis.com/", "location": "europe-central2", "description": "Regional Endpoint" }, { "endpointUrl": "https://run.europe-north1.rep.googleapis.com/", "location": "europe-north1", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://run.europe-north2.rep.googleapis.com/", "location": "europe-north2" }, { "description": "Regional Endpoint", "location": "europe-southwest1", "endpointUrl": "https://run.europe-southwest1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "europe-west1", "endpointUrl": "https://run.europe-west1.rep.googleapis.com/" }, { "endpointUrl": "https://run.europe-west10.rep.googleapis.com/", "location": "europe-west10", "description": "Regional Endpoint" }, { "endpointUrl": "https://run.europe-west12.rep.googleapis.com/", "location": "europe-west12", "description": "Regional Endpoint" }, { "location": "europe-west15", "description": "Regional Endpoint", "endpointUrl": "https://run.europe-west15.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "europe-west2", "endpointUrl": "https://run.europe-west2.rep.googleapis.com/" }, { "location": "europe-west3", "endpointUrl": "https://run.europe-west3.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://run.europe-west4.rep.googleapis.com/", "location": "europe-west4", "description": "Regional Endpoint" }, { "location": "europe-west6", "description": "Regional Endpoint", "endpointUrl": "https://run.europe-west6.rep.googleapis.com/" }, { "endpointUrl": "https://run.europe-west8.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west8" }, { "description": "Regional Endpoint", "endpointUrl": "https://run.europe-west9.rep.googleapis.com/", "location": "europe-west9" }, { "description": "Regional Endpoint", "location": "me-central1", "endpointUrl": "https://run.me-central1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "me-central2", "endpointUrl": "https://run.me-central2.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "me-west1", "endpointUrl": "https://run.me-west1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "northamerica-northeast1", "endpointUrl": "https://run.northamerica-northeast1.rep.googleapis.com/" }, { "endpointUrl": "https://run.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "northamerica-south1", "endpointUrl": "https://run.northamerica-south1.rep.googleapis.com/" }, { "endpointUrl": "https://run.southamerica-east1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "southamerica-east1" }, { "endpointUrl": "https://run.southamerica-west1.rep.googleapis.com/", "location": "southamerica-west1", "description": "Regional Endpoint" }, { "endpointUrl": "https://run.us-central1.rep.googleapis.com/", "location": "us-central1", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "us-central2", "endpointUrl": "https://run.us-central2.rep.googleapis.com/" }, { "description": "Regional Endpoint", "endpointUrl": "https://run.us-east1.rep.googleapis.com/", "location": "us-east1" }, { "endpointUrl": "https://run.us-east4.rep.googleapis.com/", "location": "us-east4", "description": "Regional Endpoint" }, { "location": "us-east5", "endpointUrl": "https://run.us-east5.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://run.us-east7.rep.googleapis.com/", "location": "us-east7", "description": "Regional Endpoint" }, { "location": "us-south1", "endpointUrl": "https://run.us-south1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "us-west1", "description": "Regional Endpoint", "endpointUrl": "https://run.us-west1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "us-west2", "endpointUrl": "https://run.us-west2.rep.googleapis.com/" }, { "location": "us-west3", "description": "Regional Endpoint", "endpointUrl": "https://run.us-west3.rep.googleapis.com/" }, { "location": "us-west4", "description": "Regional Endpoint", "endpointUrl": "https://run.us-west4.rep.googleapis.com/" }, { "endpointUrl": "https://run.us-west8.rep.googleapis.com/", "location": "us-west8", "description": "Regional Endpoint" } ], "name": "run" }