{ "parameters": { "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "key": { "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.", "location": "query" }, "callback": { "location": "query", "description": "JSONP", "type": "string" }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query", "type": "boolean" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "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" }, "alt": { "default": "json", "description": "Data format for response.", "location": "query", "type": "string", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ] }, "$.xgafv": { "type": "string", "enum": [ "1", "2" ], "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format." } }, "description": "", "version_module": true, "documentationLink": "https://cloud.google.com/deploy/", "baseUrl": "https://clouddeploy.googleapis.com/", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "resources": { "projects": { "resources": { "locations": { "resources": { "operations": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "returnPartialSuccess": { "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.", "type": "boolean", "location": "query" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The standard list page size." }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "name": { "type": "string", "location": "path", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "clouddeploy.projects.locations.operations.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "path": "v1/{+name}/operations", "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" } }, "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Operation" }, "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "location": "path", "type": "string", "description": "The name of the operation resource." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "id": "clouddeploy.projects.locations.operations.get", "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.", "httpMethod": "GET" }, "delete": { "response": { "$ref": "Empty" }, "id": "clouddeploy.projects.locations.operations.delete", "path": "v1/{+name}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`.", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "description": "The name of the operation resource to be deleted.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}" }, "cancel": { "parameterOrder": [ "name" ], "id": "clouddeploy.projects.locations.operations.cancel", "response": { "$ref": "Empty" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "CancelOperationRequest" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be cancelled." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "path": "v1/{+name}:cancel" } } }, "deliveryPipelines": { "resources": { "automationRuns": { "methods": { "cancel": { "parameters": { "name": { "required": true, "type": "string", "description": "Required. Name of the `AutomationRun`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automationRuns/[^/]+$" } }, "response": { "$ref": "CancelAutomationRunResponse" }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automationRuns/{automationRunsId}:cancel", "description": "Cancels an AutomationRun. The `state` of the `AutomationRun` after cancelling is `CANCELLED`. `CancelAutomationRun` can be called on AutomationRun in the state `IN_PROGRESS` and `PENDING`; AutomationRun in a different state returns an `FAILED_PRECONDITION` error.", "httpMethod": "POST", "path": "v1/{+name}:cancel", "id": "clouddeploy.projects.locations.deliveryPipelines.automationRuns.cancel", "request": { "$ref": "CancelAutomationRunRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automationRuns/{automationRunsId}", "description": "Gets details of a single AutomationRun.", "id": "clouddeploy.projects.locations.deliveryPipelines.automationRuns.get", "path": "v1/{+name}", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Required. Name of the `AutomationRun`. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automationRuns/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "AutomationRun" } }, "list": { "parameterOrder": [ "parent" ], "response": { "$ref": "ListAutomationRunsResponse" }, "httpMethod": "GET", "path": "v1/{+parent}/automationRuns", "id": "clouddeploy.projects.locations.deliveryPipelines.automationRuns.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists AutomationRuns in a given project and location.", "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The parent `Delivery Pipeline`, which owns this collection of automationRuns. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$" }, "pageToken": { "description": "A page token, received from a previous `ListAutomationRuns` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.", "type": "string", "location": "query" }, "orderBy": { "type": "string", "location": "query", "description": "Field to sort by." }, "filter": { "location": "query", "type": "string", "description": "Filter automationRuns to be returned. All fields can be used in the filter." }, "pageSize": { "description": "The maximum number of automationRuns to return. The service may return fewer than this value. If unspecified, at most 50 automationRuns will be returned. The maximum value is 1000; values above 1000 will be set to 1000.", "location": "query", "format": "int32", "type": "integer" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automationRuns" } } }, "automations": { "methods": { "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "Automation" }, "path": "v1/{+parent}/automations", "response": { "$ref": "Operation" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$", "description": "Required. The parent collection in which the `Automation` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.", "required": true, "type": "string", "location": "path" }, "validateOnly": { "location": "query", "description": "Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.", "type": "boolean" }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "automationId": { "location": "query", "type": "string", "description": "Required. ID of the `Automation`." } }, "parameterOrder": [ "parent" ], "description": "Creates a new Automation in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations", "id": "clouddeploy.projects.locations.deliveryPipelines.automations.create", "httpMethod": "POST" }, "list": { "id": "clouddeploy.projects.locations.deliveryPipelines.automations.list", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations", "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "The maximum number of automations to return. The service may return fewer than this value. If unspecified, at most 50 automations will be returned. The maximum value is 1000; values above 1000 will be set to 1000.", "type": "integer" }, "pageToken": { "type": "string", "description": "A page token, received from a previous `ListAutomations` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.", "location": "query" }, "parent": { "required": true, "description": "Required. The parent `Delivery Pipeline`, which owns this collection of automations. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$" }, "filter": { "location": "query", "type": "string", "description": "Filter automations to be returned. All fields can be used in the filter." }, "orderBy": { "type": "string", "location": "query", "description": "Field to sort by." } }, "path": "v1/{+parent}/automations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "ListAutomationsResponse" }, "description": "Lists Automations in a given project and location." }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameterOrder": [ "name" ], "parameters": { "validateOnly": { "description": "Optional. If set, validate the request and verify whether the resource exists, but do not actually post it.", "type": "boolean", "location": "query" }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string", "location": "query" }, "allowMissing": { "description": "Optional. If set to true, then deleting an already deleted or non-existing `Automation` will succeed.", "location": "query", "type": "boolean" }, "etag": { "location": "query", "description": "Optional. The weak etag of the request. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The name of the `Automation` to delete. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations/{automationsId}", "id": "clouddeploy.projects.locations.deliveryPipelines.automations.delete", "response": { "$ref": "Operation" }, "httpMethod": "DELETE", "description": "Deletes a single Automation resource." }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations/{automationsId}", "id": "clouddeploy.projects.locations.deliveryPipelines.automations.patch", "parameters": { "validateOnly": { "description": "Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.", "location": "query", "type": "boolean" }, "updateMask": { "location": "query", "description": "Required. Field mask is used to specify the fields to be overwritten by the update in the `Automation` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.", "type": "string", "format": "google-fieldmask" }, "requestId": { "location": "query", "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." }, "allowMissing": { "location": "query", "type": "boolean", "description": "Optional. If set to true, updating a `Automation` that does not exist will result in the creation of a new `Automation`." }, "name": { "location": "path", "description": "Output only. Name of the `Automation`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}`.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Updates the parameters of a single Automation resource.", "httpMethod": "PATCH", "path": "v1/{+name}", "response": { "$ref": "Operation" }, "request": { "$ref": "Automation" } }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "Automation" }, "id": "clouddeploy.projects.locations.deliveryPipelines.automations.get", "httpMethod": "GET", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations/{automationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automations/[^/]+$", "location": "path", "required": true, "description": "Required. Name of the `Automation`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`." } }, "description": "Gets details of a single Automation." } } }, "releases": { "methods": { "list": { "parameters": { "filter": { "location": "query", "type": "string", "description": "Optional. Filter releases to be returned. See https://google.aip.dev/160 for more details." }, "pageSize": { "description": "Optional. The maximum number of `Release` objects to return. The service may return fewer than this value. If unspecified, at most 50 `Release` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.", "type": "integer", "location": "query", "format": "int32" }, "orderBy": { "type": "string", "location": "query", "description": "Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details." }, "pageToken": { "type": "string", "location": "query", "description": "Optional. A page token, received from a previous `ListReleases` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token." }, "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$", "required": true, "description": "Required. The `DeliveryPipeline` which owns this collection of `Release` objects." } }, "id": "clouddeploy.projects.locations.deliveryPipelines.releases.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases", "response": { "$ref": "ListReleasesResponse" }, "path": "v1/{+parent}/releases", "description": "Lists Releases in a given project and location.", "parameterOrder": [ "parent" ], "httpMethod": "GET" }, "create": { "path": "v1/{+parent}/releases", "description": "Creates a new Release in a given project and location.", "id": "clouddeploy.projects.locations.deliveryPipelines.releases.create", "httpMethod": "POST", "request": { "$ref": "Release" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases", "parameterOrder": [ "parent" ], "parameters": { "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string", "location": "query" }, "overrideDeployPolicy": { "repeated": true, "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.", "type": "string", "location": "query" }, "releaseId": { "description": "Required. ID of the `Release`.", "location": "query", "type": "string" }, "validateOnly": { "description": "Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.", "location": "query", "type": "boolean" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$", "description": "Required. The parent collection in which the `Release` is created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.", "location": "path", "type": "string", "required": true } } }, "get": { "parameterOrder": [ "name" ], "httpMethod": "GET", "path": "v1/{+name}", "response": { "$ref": "Release" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}", "id": "clouddeploy.projects.locations.deliveryPipelines.releases.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+$", "location": "path", "description": "Required. Name of the `Release`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single Release." }, "abandon": { "id": "clouddeploy.projects.locations.deliveryPipelines.releases.abandon", "description": "Abandons a Release in the Delivery Pipeline.", "httpMethod": "POST", "parameterOrder": [ "name" ], "response": { "$ref": "AbandonReleaseResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}:abandon", "path": "v1/{+name}:abandon", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "Required. Name of the Release. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`.", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+$" } }, "request": { "$ref": "AbandonReleaseRequest" } } }, "resources": { "rollouts": { "methods": { "create": { "parameterOrder": [ "parent" ], "path": "v1/{+parent}/rollouts", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "description": "Creates a new Rollout in a given project and location.", "id": "clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts", "request": { "$ref": "Rollout" }, "parameters": { "rolloutId": { "description": "Required. ID of the `Rollout`.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The parent collection in which the `Rollout` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`." }, "validateOnly": { "description": "Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.", "type": "boolean", "location": "query" }, "requestId": { "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" }, "startingPhaseId": { "location": "query", "description": "Optional. The starting phase ID for the `Rollout`. If empty the `Rollout` will start at the first phase.", "type": "string" }, "overrideDeployPolicy": { "location": "query", "type": "string", "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.", "repeated": true } } }, "ignoreJob": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}:ignoreJob", "id": "clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.ignoreJob", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Ignores the specified Job in a Rollout.", "parameters": { "rollout": { "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+$", "location": "path", "description": "Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.", "type": "string", "required": true } }, "path": "v1/{+rollout}:ignoreJob", "request": { "$ref": "IgnoreJobRequest" }, "parameterOrder": [ "rollout" ], "response": { "$ref": "IgnoreJobResponse" }, "httpMethod": "POST" }, "get": { "description": "Gets details of a single Rollout.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}", "path": "v1/{+name}", "parameters": { "name": { "required": true, "description": "Required. Name of the `Rollout`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Rollout" }, "httpMethod": "GET", "id": "clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.get" }, "advance": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:advance", "httpMethod": "POST", "description": "Advances a Rollout in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}:advance", "parameters": { "name": { "required": true, "description": "Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+$" } }, "id": "clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.advance", "response": { "$ref": "AdvanceRolloutResponse" }, "request": { "$ref": "AdvanceRolloutRequest" }, "parameterOrder": [ "name" ] }, "cancel": { "id": "clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.cancel", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+$", "location": "path", "description": "Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}:cancel", "request": { "$ref": "CancelRolloutRequest" }, "description": "Cancels a Rollout in a given project and location.", "path": "v1/{+name}:cancel", "response": { "$ref": "CancelRolloutResponse" }, "parameterOrder": [ "name" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "retryJob": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}:retryJob", "parameterOrder": [ "rollout" ], "parameters": { "rollout": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+$", "description": "Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`." } }, "description": "Retries the specified Job in a Rollout.", "id": "clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.retryJob", "path": "v1/{+rollout}:retryJob", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "RetryJobResponse" }, "request": { "$ref": "RetryJobRequest" } }, "approve": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+$", "location": "path", "type": "string", "required": true, "description": "Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`." } }, "request": { "$ref": "ApproveRolloutRequest" }, "parameterOrder": [ "name" ], "path": "v1/{+name}:approve", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}:approve", "description": "Approves a Rollout.", "response": { "$ref": "ApproveRolloutResponse" }, "httpMethod": "POST", "id": "clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.approve", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "type": "string", "location": "query", "description": "Optional. A page token, received from a previous `ListRollouts` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token." }, "parent": { "description": "Required. The `Release` which owns this collection of `Rollout` objects.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+$", "required": true, "location": "path" }, "pageSize": { "type": "integer", "location": "query", "description": "Optional. The maximum number of `Rollout` objects to return. The service may return fewer than this value. If unspecified, at most 50 `Rollout` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.", "format": "int32" }, "filter": { "location": "query", "description": "Optional. Filter rollouts to be returned. See https://google.aip.dev/160 for more details.", "type": "string" }, "orderBy": { "description": "Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" } }, "description": "Lists Rollouts in a given project and location.", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts", "httpMethod": "GET", "response": { "$ref": "ListRolloutsResponse" }, "id": "clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.list", "path": "v1/{+parent}/rollouts" } }, "resources": { "jobRuns": { "methods": { "terminate": { "description": "Terminates a Job Run in a given project and location.", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+/jobRuns/[^/]+$", "required": true, "description": "Required. Name of the `JobRun`. Format must be `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}`.", "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}/jobRuns/{jobRunsId}:terminate", "path": "v1/{+name}:terminate", "request": { "$ref": "TerminateJobRunRequest" }, "id": "clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.terminate", "httpMethod": "POST", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "TerminateJobRunResponse" } }, "get": { "description": "Gets details of a single JobRun.", "response": { "$ref": "JobRun" }, "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. Name of the `JobRun`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}`.", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+/jobRuns/[^/]+$", "location": "path", "type": "string", "required": true } }, "path": "v1/{+name}", "id": "clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}/jobRuns/{jobRunsId}", "httpMethod": "GET" }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "ListJobRunsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/jobRuns", "id": "clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}/jobRuns", "parameters": { "pageSize": { "description": "Optional. The maximum number of `JobRun` objects to return. The service may return fewer than this value. If unspecified, at most 50 `JobRun` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+/rollouts/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The `Rollout` which owns this collection of `JobRun` objects." }, "pageToken": { "description": "Optional. A page token, received from a previous `ListJobRuns` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.", "type": "string", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "Optional. Filter results to be returned. See https://google.aip.dev/160 for more details." }, "orderBy": { "description": "Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.", "location": "query", "type": "string" } }, "description": "Lists JobRuns in a given project and location." } } } } } } } }, "methods": { "patch": { "request": { "$ref": "DeliveryPipeline" }, "response": { "$ref": "Operation" }, "httpMethod": "PATCH", "id": "clouddeploy.projects.locations.deliveryPipelines.patch", "parameterOrder": [ "name" ], "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "description": "Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$" }, "validateOnly": { "type": "boolean", "location": "query", "description": "Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made." }, "requestId": { "type": "string", "location": "query", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." }, "updateMask": { "description": "Required. Field mask is used to specify the fields to be overwritten by the update in the `DeliveryPipeline` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.", "location": "query", "type": "string", "format": "google-fieldmask" }, "allowMissing": { "type": "boolean", "description": "Optional. If set to true, updating a `DeliveryPipeline` that does not exist will result in the creation of a new `DeliveryPipeline`.", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}", "description": "Updates the parameters of a single DeliveryPipeline." }, "setIamPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "httpMethod": "POST", "response": { "$ref": "Policy" }, "path": "v1/{+resource}:setIamPolicy", "parameterOrder": [ "resource" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$", "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.", "type": "string", "required": true } }, "id": "clouddeploy.projects.locations.deliveryPipelines.setIamPolicy" }, "getIamPolicy": { "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}:getIamPolicy", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$", "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", "location": "path" }, "options.requestedPolicyVersion": { "type": "integer", "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)." } }, "parameterOrder": [ "resource" ], "response": { "$ref": "Policy" }, "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "id": "clouddeploy.projects.locations.deliveryPipelines.getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+resource}:getIamPolicy" }, "delete": { "id": "clouddeploy.projects.locations.deliveryPipelines.delete", "path": "v1/{+name}", "parameters": { "validateOnly": { "type": "boolean", "location": "query", "description": "Optional. If set, validate the request and preview the review, but do not actually post it." }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "name": { "description": "Required. The name of the `DeliveryPipeline` to delete. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$", "location": "path", "type": "string" }, "etag": { "type": "string", "location": "query", "description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding." }, "allowMissing": { "location": "query", "description": "Optional. If set to true, then deleting an already deleted or non-existing `DeliveryPipeline` will succeed.", "type": "boolean" }, "force": { "type": "boolean", "description": "Optional. If set to true, all child resources under this pipeline will also be deleted. Otherwise, the request will only work if the pipeline has no child resources.", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "httpMethod": "DELETE", "description": "Deletes a single DeliveryPipeline.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "httpMethod": "GET", "description": "Gets details of a single DeliveryPipeline.", "parameterOrder": [ "name" ], "response": { "$ref": "DeliveryPipeline" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$", "type": "string", "required": true, "description": "Required. Name of the `DeliveryPipeline`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.", "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}", "id": "clouddeploy.projects.locations.deliveryPipelines.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ListDeliveryPipelinesResponse" }, "parameters": { "pageSize": { "description": "The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines will be returned. The maximum value is 1000; values above 1000 will be set to 1000.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "A page token, received from a previous `ListDeliveryPipelines` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token." }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The parent, which owns this collection of pipelines. Format must be `projects/{project_id}/locations/{location_name}`." }, "filter": { "type": "string", "description": "Filter pipelines to be returned. See https://google.aip.dev/160 for more details.", "location": "query" }, "orderBy": { "type": "string", "description": "Field to sort by. See https://google.aip.dev/132#ordering for more details.", "location": "query" } }, "id": "clouddeploy.projects.locations.deliveryPipelines.list", "httpMethod": "GET", "path": "v1/{+parent}/deliveryPipelines", "description": "Lists DeliveryPipelines in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines", "parameterOrder": [ "parent" ] }, "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines", "path": "v1/{+parent}/deliveryPipelines", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "DeliveryPipeline" }, "id": "clouddeploy.projects.locations.deliveryPipelines.create", "httpMethod": "POST", "description": "Creates a new DeliveryPipeline in a given project and location.", "parameters": { "deliveryPipelineId": { "description": "Required. ID of the `DeliveryPipeline`.", "location": "query", "type": "string" }, "validateOnly": { "type": "boolean", "location": "query", "description": "Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made." }, "requestId": { "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" }, "parent": { "location": "path", "type": "string", "description": "Required. The parent collection in which the `DeliveryPipeline` must be created. The format is `projects/{project_id}/locations/{location_name}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ] }, "rollbackTarget": { "path": "v1/{+name}:rollbackTarget", "httpMethod": "POST", "id": "clouddeploy.projects.locations.deliveryPipelines.rollbackTarget", "response": { "$ref": "RollbackTargetResponse" }, "description": "Creates a `Rollout` to roll back the specified target.", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$", "location": "path", "type": "string", "description": "Required. The `DeliveryPipeline` for which the rollback `Rollout` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}:rollbackTarget", "parameterOrder": [ "name" ], "request": { "$ref": "RollbackTargetRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { "parameters": { "resource": { "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", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}:testIamPermissions", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "clouddeploy.projects.locations.deliveryPipelines.testIamPermissions", "parameterOrder": [ "resource" ], "response": { "$ref": "TestIamPermissionsResponse" }, "httpMethod": "POST", "request": { "$ref": "TestIamPermissionsRequest" }, "path": "v1/{+resource}:testIamPermissions" } } }, "deployPolicies": { "methods": { "create": { "httpMethod": "POST", "path": "v1/{+parent}/deployPolicies", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployPolicies", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new DeployPolicy in a given project and location.", "id": "clouddeploy.projects.locations.deployPolicies.create", "parameters": { "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent collection in which the `DeployPolicy` must be created. The format is `projects/{project_id}/locations/{location_name}`." }, "validateOnly": { "location": "query", "description": "Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.", "type": "boolean" }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "deployPolicyId": { "location": "query", "description": "Required. ID of the `DeployPolicy`.", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "DeployPolicy" }, "response": { "$ref": "Operation" } }, "getIamPolicy": { "response": { "$ref": "Policy" }, "id": "clouddeploy.projects.locations.deployPolicies.getIamPolicy", "path": "v1/{+resource}:getIamPolicy", "httpMethod": "GET", "parameterOrder": [ "resource" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployPolicies/{deployPoliciesId}:getIamPolicy", "parameters": { "options.requestedPolicyVersion": { "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", "type": "integer" }, "resource": { "required": true, "type": "string", "location": "path", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/deployPolicies/[^/]+$" } } }, "delete": { "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployPolicies/{deployPoliciesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "description": "Deletes a single DeployPolicy.", "response": { "$ref": "Operation" }, "path": "v1/{+name}", "parameters": { "etag": { "type": "string", "location": "query", "description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding." }, "allowMissing": { "type": "boolean", "location": "query", "description": "Optional. If set to true, then deleting an already deleted or non-existing `DeployPolicy` will succeed." }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deployPolicies/[^/]+$", "description": "Required. The name of the `DeployPolicy` to delete. The format is `projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}`.", "required": true, "type": "string" }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { "type": "boolean", "description": "Optional. If set, validate the request and preview the review, but do not actually post it.", "location": "query" } }, "id": "clouddeploy.projects.locations.deployPolicies.delete" }, "get": { "response": { "$ref": "DeployPolicy" }, "httpMethod": "GET", "id": "clouddeploy.projects.locations.deployPolicies.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/deployPolicies/[^/]+$", "description": "Required. Name of the `DeployPolicy`. Format must be `projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}`.", "type": "string", "required": true, "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployPolicies/{deployPoliciesId}", "path": "v1/{+name}", "description": "Gets details of a single DeployPolicy.", "parameterOrder": [ "name" ] }, "list": { "httpMethod": "GET", "response": { "$ref": "ListDeployPoliciesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployPolicies", "id": "clouddeploy.projects.locations.deployPolicies.list", "parameters": { "parent": { "required": true, "description": "Required. The parent, which owns this collection of deploy policies. Format must be `projects/{project_id}/locations/{location_name}`.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "description": "A page token, received from a previous `ListDeployPolicies` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "description": "The maximum number of deploy policies to return. The service may return fewer than this value. If unspecified, at most 50 deploy policies will be returned. The maximum value is 1000; values above 1000 will be set to 1000.", "type": "integer", "format": "int32" }, "filter": { "location": "query", "type": "string", "description": "Filter deploy policies to be returned. See https://google.aip.dev/160 for more details. All fields can be used in the filter." }, "orderBy": { "description": "Field to sort by. See https://google.aip.dev/132#ordering for more details.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/deployPolicies", "description": "Lists DeployPolicies in a given project and location." }, "setIamPolicy": { "parameters": { "resource": { "required": true, "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.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deployPolicies/[^/]+$" } }, "parameterOrder": [ "resource" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployPolicies/{deployPoliciesId}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "id": "clouddeploy.projects.locations.deployPolicies.setIamPolicy", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1/{+resource}:setIamPolicy" }, "patch": { "parameters": { "name": { "required": true, "description": "Output only. Name of the `DeployPolicy`. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`. The `deployPolicy` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deployPolicies/[^/]+$" }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Required. Field mask is used to specify the fields to be overwritten by the update in the `DeployPolicy` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.", "type": "string" }, "requestId": { "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" }, "validateOnly": { "type": "boolean", "location": "query", "description": "Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made." }, "allowMissing": { "type": "boolean", "location": "query", "description": "Optional. If set to true, updating a `DeployPolicy` that does not exist will result in the creation of a new `DeployPolicy`." } }, "description": "Updates the parameters of a single DeployPolicy.", "id": "clouddeploy.projects.locations.deployPolicies.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Operation" }, "path": "v1/{+name}", "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployPolicies/{deployPoliciesId}", "parameterOrder": [ "name" ], "request": { "$ref": "DeployPolicy" } } } }, "customTargetTypes": { "methods": { "list": { "parameters": { "orderBy": { "description": "Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.", "type": "string", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "Optional. Filter custom target types to be returned. See https://google.aip.dev/160 for more details." }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token, received from a previous `ListCustomTargetTypes` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token." }, "pageSize": { "description": "Optional. The maximum number of `CustomTargetType` objects to return. The service may return fewer than this value. If unspecified, at most 50 `CustomTargetType` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "location": "path", "type": "string", "description": "Required. The parent that owns this collection of custom target types. Format must be `projects/{project_id}/locations/{location_name}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true } }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes", "id": "clouddeploy.projects.locations.customTargetTypes.list", "path": "v1/{+parent}/customTargetTypes", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists CustomTargetTypes in a given project and location.", "response": { "$ref": "ListCustomTargetTypesResponse" } }, "create": { "parameterOrder": [ "parent" ], "id": "clouddeploy.projects.locations.customTargetTypes.create", "response": { "$ref": "Operation" }, "httpMethod": "POST", "description": "Creates a new CustomTargetType in a given project and location.", "request": { "$ref": "CustomTargetType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/customTargetTypes", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes", "parameters": { "validateOnly": { "location": "query", "description": "Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.", "type": "boolean" }, "customTargetTypeId": { "type": "string", "description": "Required. ID of the `CustomTargetType`.", "location": "query" }, "parent": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent collection in which the `CustomTargetType` must be created. The format is `projects/{project_id}/locations/{location_name}`.", "location": "path" }, "requestId": { "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } } }, "setIamPolicy": { "parameterOrder": [ "resource" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes/{customTargetTypesId}:setIamPolicy", "path": "v1/{+resource}:setIamPolicy", "httpMethod": "POST", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "clouddeploy.projects.locations.customTargetTypes.setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "parameters": { "resource": { "required": true, "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.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/customTargetTypes/[^/]+$" } }, "response": { "$ref": "Policy" } }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes/{customTargetTypesId}", "parameters": { "validateOnly": { "location": "query", "description": "Optional. If set to true, the request is validated but no actual change is made.", "type": "boolean" }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string", "location": "query" }, "allowMissing": { "description": "Optional. If set to true, then deleting an already deleted or non-existing `CustomTargetType` will succeed.", "type": "boolean", "location": "query" }, "etag": { "description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "location": "query", "type": "string" }, "name": { "location": "path", "description": "Required. The name of the `CustomTargetType` to delete. Format must be `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`.", "pattern": "^projects/[^/]+/locations/[^/]+/customTargetTypes/[^/]+$", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "clouddeploy.projects.locations.customTargetTypes.delete", "description": "Deletes a single CustomTargetType.", "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "path": "v1/{+name}" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "request": { "$ref": "CustomTargetType" }, "parameters": { "allowMissing": { "description": "Optional. If set to true, updating a `CustomTargetType` that does not exist will result in the creation of a new `CustomTargetType`.", "location": "query", "type": "boolean" }, "updateMask": { "location": "query", "description": "Required. Field mask is used to specify the fields to be overwritten by the update in the `CustomTargetType` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.", "format": "google-fieldmask", "type": "string" }, "requestId": { "location": "query", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "name": { "description": "Identifier. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/{customTargetType}`. The `customTargetType` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/customTargetTypes/[^/]+$", "type": "string" }, "validateOnly": { "description": "Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.", "location": "query", "type": "boolean" } }, "id": "clouddeploy.projects.locations.customTargetTypes.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes/{customTargetTypesId}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "httpMethod": "PATCH", "description": "Updates a single CustomTargetType." }, "getIamPolicy": { "httpMethod": "GET", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes/{customTargetTypesId}:getIamPolicy", "id": "clouddeploy.projects.locations.customTargetTypes.getIamPolicy", "parameterOrder": [ "resource" ], "response": { "$ref": "Policy" }, "parameters": { "options.requestedPolicyVersion": { "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", "format": "int32", "location": "query" }, "resource": { "required": true, "location": "path", "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.", "pattern": "^projects/[^/]+/locations/[^/]+/customTargetTypes/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+resource}:getIamPolicy" }, "get": { "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/customTargetTypes/[^/]+$", "description": "Required. Name of the `CustomTargetType`. Format must be `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`." } }, "response": { "$ref": "CustomTargetType" }, "description": "Gets details of a single CustomTargetType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes/{customTargetTypesId}", "id": "clouddeploy.projects.locations.customTargetTypes.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "httpMethod": "GET" } } }, "targets": { "methods": { "get": { "id": "clouddeploy.projects.locations.targets.get", "httpMethod": "GET", "response": { "$ref": "Target" }, "description": "Gets details of a single Target.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/targets/[^/]+$", "description": "Required. Name of the `Target`. Format must be `projects/{project_id}/locations/{location_name}/targets/{target_name}`.", "location": "path", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/targets/{targetsId}", "parameterOrder": [ "name" ] }, "getIamPolicy": { "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+resource}:getIamPolicy", "parameters": { "resource": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/targets/[^/]+$", "location": "path", "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 }, "options.requestedPolicyVersion": { "location": "query", "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" } }, "response": { "$ref": "Policy" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/targets/{targetsId}:getIamPolicy", "parameterOrder": [ "resource" ], "httpMethod": "GET", "id": "clouddeploy.projects.locations.targets.getIamPolicy" }, "patch": { "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/targets/{targetsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single Target.", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "format": "google-fieldmask", "description": "Required. Field mask is used to specify the fields to be overwritten by the update in the `Target` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.", "type": "string", "location": "query" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/targets/[^/]+$", "description": "Identifier. Name of the `Target`. Format is `projects/{project}/locations/{location}/targets/{target}`. The `target` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`", "type": "string", "required": true }, "allowMissing": { "description": "Optional. If set to true, updating a `Target` that does not exist will result in the creation of a new `Target`.", "location": "query", "type": "boolean" }, "requestId": { "type": "string", "location": "query", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." }, "validateOnly": { "location": "query", "type": "boolean", "description": "Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made." } }, "id": "clouddeploy.projects.locations.targets.patch", "response": { "$ref": "Operation" }, "request": { "$ref": "Target" }, "path": "v1/{+name}" }, "delete": { "id": "clouddeploy.projects.locations.targets.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/targets/{targetsId}", "parameterOrder": [ "name" ], "parameters": { "allowMissing": { "description": "Optional. If set to true, then deleting an already deleted or non-existing `Target` will succeed.", "type": "boolean", "location": "query" }, "validateOnly": { "type": "boolean", "location": "query", "description": "Optional. If set, validate the request and preview the review, but do not actually post it." }, "requestId": { "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" }, "etag": { "description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "location": "query", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/targets/[^/]+$", "description": "Required. The name of the `Target` to delete. The format is `projects/{project_id}/locations/{location_name}/targets/{target_name}`.", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "Operation" }, "path": "v1/{+name}", "description": "Deletes a single Target.", "httpMethod": "DELETE" }, "testIamPermissions": { "request": { "$ref": "TestIamPermissionsRequest" }, "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "path": "v1/{+resource}:testIamPermissions", "parameterOrder": [ "resource" ], "parameters": { "resource": { "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, "pattern": "^projects/[^/]+/locations/[^/]+/targets/[^/]+$", "location": "path", "type": "string" } }, "response": { "$ref": "TestIamPermissionsResponse" }, "id": "clouddeploy.projects.locations.targets.testIamPermissions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/targets/{targetsId}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST" }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/targets", "path": "v1/{+parent}/targets", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "Optional. A page token, received from a previous `ListTargets` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token." }, "pageSize": { "description": "Optional. The maximum number of `Target` objects to return. The service may return fewer than this value. If unspecified, at most 50 `Target` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.", "type": "integer", "location": "query", "format": "int32" }, "filter": { "location": "query", "type": "string", "description": "Optional. Filter targets to be returned. See https://google.aip.dev/160 for more details." }, "parent": { "description": "Required. The parent, which owns this collection of targets. Format must be `projects/{project_id}/locations/{location_name}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "orderBy": { "type": "string", "location": "query", "description": "Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details." } }, "parameterOrder": [ "parent" ], "description": "Lists Targets in a given project and location.", "id": "clouddeploy.projects.locations.targets.list", "response": { "$ref": "ListTargetsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { "response": { "$ref": "Policy" }, "parameters": { "resource": { "type": "string", "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.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/targets/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/targets/{targetsId}:setIamPolicy", "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "id": "clouddeploy.projects.locations.targets.setIamPolicy", "parameterOrder": [ "resource" ] }, "create": { "id": "clouddeploy.projects.locations.targets.create", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/targets", "request": { "$ref": "Target" }, "response": { "$ref": "Operation" }, "description": "Creates a new Target in a given project and location.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "validateOnly": { "description": "Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.", "type": "boolean", "location": "query" }, "requestId": { "location": "query", "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." }, "targetId": { "type": "string", "location": "query", "description": "Required. ID of the `Target`." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent collection in which the `Target` must be created. The format is `projects/{project_id}/locations/{location_name}`.", "location": "path", "type": "string", "required": true } }, "path": "v1/{+parent}/targets" } } } }, "methods": { "getConfig": { "parameters": { "name": { "required": true, "description": "Required. Name of requested configuration.", "pattern": "^projects/[^/]+/locations/[^/]+/config$", "location": "path", "type": "string" } }, "response": { "$ref": "Config" }, "path": "v1/{+name}", "httpMethod": "GET", "id": "clouddeploy.projects.locations.getConfig", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the configuration for a location.", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/config" }, "get": { "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "path": "v1/{+name}", "parameters": { "name": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Resource name for the location." } }, "parameterOrder": [ "name" ], "id": "clouddeploy.projects.locations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "description": "Gets information about a location." }, "list": { "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "response": { "$ref": "ListLocationsResponse" }, "parameterOrder": [ "name" ], "parameters": { "pageToken": { "location": "query", "type": "string", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page." }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "type": "integer", "location": "query" }, "name": { "location": "path", "type": "string", "description": "The resource that owns the locations collection, if applicable.", "required": true, "pattern": "^projects/[^/]+$" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "extraLocationTypes": { "repeated": true, "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "type": "string", "location": "query" } }, "id": "clouddeploy.projects.locations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}/locations" } } } } } }, "version": "v1", "endpoints": [ { "description": "Regional Endpoint", "location": "asia-south1", "endpointUrl": "https://clouddeploy.asia-south1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "endpointUrl": "https://clouddeploy.asia-south2.rep.googleapis.com/", "location": "asia-south2" }, { "location": "us-central1", "description": "Regional Endpoint", "endpointUrl": "https://clouddeploy.us-central1.rep.googleapis.com/" }, { "endpointUrl": "https://clouddeploy.us-east1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-east1" }, { "location": "us-east4", "endpointUrl": "https://clouddeploy.us-east4.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://clouddeploy.us-east5.rep.googleapis.com/", "location": "us-east5", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "us-east7", "endpointUrl": "https://clouddeploy.us-east7.rep.googleapis.com/" }, { "location": "us-south1", "endpointUrl": "https://clouddeploy.us-south1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://clouddeploy.us-west1.rep.googleapis.com/", "location": "us-west1", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "us-west2", "endpointUrl": "https://clouddeploy.us-west2.rep.googleapis.com/" }, { "location": "us-west3", "description": "Regional Endpoint", "endpointUrl": "https://clouddeploy.us-west3.rep.googleapis.com/" }, { "location": "us-west4", "endpointUrl": "https://clouddeploy.us-west4.rep.googleapis.com/", "description": "Regional Endpoint" } ], "kind": "discovery#restDescription", "name": "clouddeploy", "canonicalName": "Cloud Deploy", "ownerName": "Google", "fullyEncodeReservedExpansion": true, "id": "clouddeploy:v1", "revision": "20260923", "ownerDomain": "google.com", "protocol": "rest", "rootUrl": "https://clouddeploy.googleapis.com/", "basePath": "", "schemas": { "DeployJobRun": { "id": "DeployJobRun", "properties": { "build": { "description": "Output only. The resource name of the Cloud Build `Build` object that is used to deploy. Format is `projects/{project}/locations/{location}/builds/{build}`.", "readOnly": true, "type": "string" }, "metadata": { "$ref": "DeployJobRunMetadata", "description": "Output only. Metadata containing information about the deploy job run.", "readOnly": true }, "artifact": { "readOnly": true, "description": "Output only. The artifact of a deploy job run, if available.", "$ref": "DeployArtifact" }, "failureMessage": { "type": "string", "readOnly": true, "description": "Output only. Additional information about the deploy failure, if available." }, "failureCause": { "type": "string", "enum": [ "FAILURE_CAUSE_UNSPECIFIED", "CLOUD_BUILD_UNAVAILABLE", "EXECUTION_FAILED", "DEADLINE_EXCEEDED", "MISSING_RESOURCES_FOR_CANARY", "CLOUD_BUILD_REQUEST_FAILED", "DEPLOY_FEATURE_NOT_SUPPORTED" ], "readOnly": true, "enumDescriptions": [ "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [Required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The deploy operation did not complete successfully; check Cloud Build logs.", "The deploy job run did not complete within the allotted time.", "There were missing resources in the runtime environment required for a canary deployment. Check the Cloud Build logs for more information.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details.", "The deploy operation had a feature configured that is not supported." ], "description": "Output only. The reason the deploy failed. This will always be unspecified while the deploy is in progress or if it succeeded." } }, "description": "DeployJobRun contains information specific to a deploy `JobRun`.", "type": "object" }, "PromoteReleaseOperation": { "properties": { "targetId": { "description": "Output only. The ID of the target that represents the promotion stage to which the release will be promoted. The value of this field is the last segment of a target name.", "readOnly": true, "type": "string" }, "wait": { "readOnly": true, "description": "Output only. How long the operation will be paused.", "type": "string", "format": "google-duration" }, "rollout": { "description": "Output only. The name of the rollout that initiates the `AutomationRun`.", "readOnly": true, "type": "string" }, "phase": { "type": "string", "description": "Output only. The starting phase of the rollout created by this operation.", "readOnly": true } }, "type": "object", "description": "Contains the information of an automated promote-release operation.", "id": "PromoteReleaseOperation" }, "AuditConfig": { "type": "object", "id": "AuditConfig", "properties": { "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." }, "auditLogConfigs": { "description": "The configuration for logging of each type of permission.", "type": "array", "items": { "$ref": "AuditLogConfig" } } }, "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." }, "Date": { "id": "Date", "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "properties": { "month": { "type": "integer", "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32" }, "day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "type": "integer", "format": "int32" }, "year": { "format": "int32", "type": "integer", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year." } }, "type": "object" }, "Operation": { "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" }, "response": { "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`.", "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "metadata": { "type": "object", "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "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.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" } }, "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "id": "Operation" }, "DeployParameters": { "type": "object", "properties": { "matchTargetLabels": { "description": "Optional. Deploy parameters are applied to targets with match labels. If unspecified, deploy parameters are applied to all targets (including child targets of a multi-target).", "additionalProperties": { "type": "string" }, "type": "object" }, "values": { "description": "Required. Values are deploy parameters in key-value pairs.", "type": "object", "additionalProperties": { "type": "string" } } }, "id": "DeployParameters", "description": "DeployParameters contains deploy parameters information." }, "TimeWindows": { "description": "Time windows within which actions are restricted. See the [documentation](https://cloud.google.com/deploy/docs/deploy-policy#dates_times) for more information on how to configure dates/times.", "id": "TimeWindows", "type": "object", "properties": { "weeklyWindows": { "description": "Optional. Recurring weekly windows within which actions are restricted.", "items": { "$ref": "WeeklyWindow" }, "type": "array" }, "oneTimeWindows": { "description": "Optional. One-time windows within which actions are restricted.", "type": "array", "items": { "$ref": "OneTimeWindow" } }, "timeZone": { "type": "string", "description": "Required. The time zone in IANA format [IANA Time Zone Database](https://www.iana.org/time-zones) (e.g. America/New_York)." } } }, "CanaryDeployment": { "id": "CanaryDeployment", "description": "CanaryDeployment represents the canary deployment configuration", "properties": { "percentages": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Required. The percentage based deployments that will occur as a part of a `Rollout`. List is expected in ascending order and each integer n is 0 \u003c= n \u003c 100. If the GatewayServiceMesh is configured for Kubernetes, then the range for n is 0 \u003c= n \u003c= 100." }, "verifyConfig": { "description": "Optional. Configuration for the verify job. Cannot be set if `verify` is set to true.", "$ref": "Verify" }, "postdeploy": { "description": "Optional. Configuration for the postdeploy job of the last phase. If this is not configured, there will be no postdeploy job for this phase.", "$ref": "Postdeploy" }, "predeploy": { "$ref": "Predeploy", "description": "Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase." }, "verify": { "description": "Optional. Whether to run verify tests after each percentage deployment via `skaffold verify`.", "type": "boolean" }, "analysis": { "description": "Optional. Configuration for the analysis job. If configured, the analysis will run after each percentage deployment.", "$ref": "Analysis" } }, "type": "object" }, "DeployPolicyNotificationEvent": { "id": "DeployPolicyNotificationEvent", "type": "object", "description": "Payload proto for \"clouddeploy.googleapis.com/deploypolicy_notification\". Platform Log event that describes the failure to send a pub/sub notification when there is a DeployPolicy status change.", "properties": { "message": { "description": "Debug message for when a deploy policy fails to send a pub/sub notification.", "type": "string" }, "type": { "description": "Type of this notification, e.g. for a Pub/Sub failure.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_PUBSUB_NOTIFICATION_FAILURE", "TYPE_RESOURCE_STATE_CHANGE", "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDescriptions": [ "Type is unspecified.", "A Pub/Sub notification failed to be sent.", "Resource state changed.", "A process aborted.", "Restriction check failed.", "Resource deleted.", "Rollout updated.", "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "enumDeprecated": [ false, false, false, false, false, false, false, false, true ] }, "deployPolicyUid": { "description": "Unique identifier of the deploy policy.", "type": "string" }, "deployPolicy": { "type": "string", "description": "The name of the `DeployPolicy`." } } }, "VerifyJob": { "properties": { "tasks": { "type": "array", "readOnly": true, "items": { "$ref": "Task" }, "description": "Output only. The tasks that are executed as part of the verify Job." } }, "id": "VerifyJob", "description": "A verify Job.", "type": "object" }, "TargetArtifact": { "id": "TargetArtifact", "type": "object", "properties": { "skaffoldConfigPath": { "description": "Output only. File path of the resolved Skaffold configuration for the stable phase, relative to the URI.", "type": "string", "readOnly": true }, "artifactUri": { "readOnly": true, "type": "string", "description": "Output only. URI of a directory containing the artifacts. This contains deployment configuration used by Skaffold during a rollout, and all paths are relative to this location." }, "phaseArtifacts": { "readOnly": true, "description": "Output only. Map from the phase ID to the phase artifacts for the `Target`.", "type": "object", "additionalProperties": { "$ref": "PhaseArtifact" } }, "manifestPath": { "description": "Output only. File path of the rendered manifest relative to the URI for the stable phase.", "type": "string", "readOnly": true } }, "description": "The artifacts produced by a target render operation." }, "ListDeliveryPipelinesResponse": { "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "deliveryPipelines": { "type": "array", "items": { "$ref": "DeliveryPipeline" }, "description": "The `DeliveryPipeline` objects." }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } }, "description": "The response object from `ListDeliveryPipelines`.", "type": "object", "id": "ListDeliveryPipelinesResponse" }, "RolloutUpdateEvent": { "description": "Payload proto for \"clouddeploy.googleapis.com/rollout_update\" Platform Log event that describes the rollout update event.", "type": "object", "id": "RolloutUpdateEvent", "properties": { "pipelineUid": { "type": "string", "description": "Unique identifier of the pipeline." }, "message": { "type": "string", "description": "Debug message for when a rollout update event occurs." }, "targetId": { "description": "ID of the target.", "type": "string" }, "rolloutUpdateType": { "description": "The type of the rollout update.", "type": "string", "enum": [ "ROLLOUT_UPDATE_TYPE_UNSPECIFIED", "PENDING", "PENDING_RELEASE", "IN_PROGRESS", "CANCELLING", "CANCELLED", "HALTED", "SUCCEEDED", "FAILED", "APPROVAL_REQUIRED", "APPROVED", "REJECTED", "ADVANCE_REQUIRED", "ADVANCED" ], "enumDescriptions": [ "Rollout update type unspecified.", "Rollout state updated to pending (release has succeeded, waiting on the rollout to start).", "Rollout state updated to pending release.", "Rollout state updated to in progress.", "Rollout state updated to cancelling.", "Rollout state updated to cancelled.", "Rollout state updated to halted.", "Rollout state updated to succeeded.", "Rollout state updated to failed.", "Rollout requires approval.", "Rollout has been approved.", "Rollout has been rejected.", "Rollout requires advance to the next phase.", "Rollout has been advanced." ] }, "release": { "description": "The name of the `Release`.", "type": "string" }, "releaseUid": { "description": "Unique identifier of the release.", "type": "string" }, "type": { "enumDescriptions": [ "Type is unspecified.", "A Pub/Sub notification failed to be sent.", "Resource state changed.", "A process aborted.", "Restriction check failed.", "Resource deleted.", "Rollout updated.", "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "description": "Type of this notification, e.g. for a rollout update event.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_PUBSUB_NOTIFICATION_FAILURE", "TYPE_RESOURCE_STATE_CHANGE", "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ false, false, false, false, false, false, false, false, true ] }, "rollout": { "description": "The name of the rollout. rollout_uid is not in this log message because we write some of these log messages at rollout creation time, before we've generated the uid.", "type": "string" } } }, "CustomTargetType": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional. Description of the `CustomTargetType`. Max length is 255 characters." }, "updateTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Most recent time at which the `CustomTargetType` was updated." }, "customActions": { "$ref": "CustomTargetSkaffoldActions", "description": "Optional. Configures render and deploy for the `CustomTargetType` using Skaffold custom actions." }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be \u003c= 128 bytes.", "type": "object" }, "tasks": { "description": "Optional. Configures render and deploy for the `CustomTargetType` using tasks.", "$ref": "CustomTargetTasks" }, "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. Time at which the `CustomTargetType` was created." }, "annotations": { "additionalProperties": { "type": "string" }, "description": "Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.", "type": "object" }, "etag": { "description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, "uid": { "readOnly": true, "description": "Output only. Unique identifier of the `CustomTargetType`.", "type": "string" }, "name": { "type": "string", "description": "Identifier. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/{customTargetType}`. The `customTargetType` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`" }, "customTargetTypeId": { "type": "string", "readOnly": true, "description": "Output only. Resource id of the `CustomTargetType`." } }, "id": "CustomTargetType", "description": "A `CustomTargetType` resource in the Cloud Deploy API. A `CustomTargetType` defines a type of custom target that can be referenced in a `Target` in order to facilitate deploying to other systems besides the supported runtimes." }, "PolicyRule": { "type": "object", "properties": { "rolloutRestriction": { "$ref": "RolloutRestriction", "description": "Optional. Rollout restrictions." } }, "id": "PolicyRule", "description": "Deploy Policy rule." }, "FailedAlertPolicy": { "id": "FailedAlertPolicy", "description": "FailedAlertPolicy contains information about an alert policy that was found to be firing during an alert policy check.", "properties": { "alertPolicy": { "type": "string", "readOnly": true, "description": "Output only. The name of the alert policy that was found to be firing. Format is `projects/{project}/locations/{location}/alertPolicies/{alertPolicy}`." }, "alerts": { "type": "array", "readOnly": true, "description": "Output only. Open alerts for the alerting policies that matched the alert policy check configuration.", "items": { "type": "string" } } }, "type": "object" }, "RepairPhase": { "description": "RepairPhase tracks the repair attempts that have been made for each `RepairPhaseConfig` specified in the `Automation` resource.", "properties": { "retry": { "$ref": "RetryPhase", "readOnly": true, "description": "Output only. Records of the retry attempts for retry repair mode." }, "rollback": { "description": "Output only. Rollback attempt for rollback repair mode .", "readOnly": true, "$ref": "RollbackAttempt" } }, "id": "RepairPhase", "type": "object" }, "Predeploy": { "id": "Predeploy", "description": "Predeploy contains the predeploy job configuration information.", "type": "object", "properties": { "actions": { "items": { "type": "string" }, "type": "array", "description": "Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job." }, "tasks": { "items": { "$ref": "Task" }, "description": "Optional. The tasks that will run as a part of the predeploy job. The tasks are executed sequentially in the order specified. Only one of `actions` or `tasks` can be specified.", "type": "array" } } }, "Verify": { "id": "Verify", "type": "object", "description": "Verify contains the verify job configuration information.", "properties": { "tasks": { "type": "array", "description": "Optional. The tasks that will run as a part of the verify job. The tasks are executed sequentially in the order specified.", "items": { "$ref": "Task" } } } }, "RolloutRestriction": { "type": "object", "id": "RolloutRestriction", "properties": { "actions": { "items": { "enumDescriptions": [ "Unspecified.", "Advance the rollout to the next phase.", "Approve the rollout.", "Cancel the rollout.", "Create a rollout.", "Ignore a job result on the rollout.", "Retry a job for a rollout.", "Rollback a rollout.", "Terminate a jobrun." ], "type": "string", "enum": [ "ROLLOUT_ACTIONS_UNSPECIFIED", "ADVANCE", "APPROVE", "CANCEL", "CREATE", "IGNORE_JOB", "RETRY_JOB", "ROLLBACK", "TERMINATE_JOBRUN" ] }, "description": "Optional. Rollout actions to be restricted as part of the policy. If left empty, all actions will be restricted.", "type": "array" }, "invokers": { "type": "array", "items": { "enumDescriptions": [ "Unspecified.", "The action is user-driven. For example, creating a rollout manually via a gcloud create command.", "Automated action by Cloud Deploy." ], "type": "string", "enum": [ "INVOKER_UNSPECIFIED", "USER", "DEPLOY_AUTOMATION" ] }, "description": "Optional. What invoked the action. If left empty, all invoker types will be restricted." }, "timeWindows": { "description": "Required. Time window within which actions are restricted.", "$ref": "TimeWindows" }, "id": { "description": "Required. Restriction rule ID. Required and must be unique within a DeployPolicy. The format is `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.", "type": "string" } }, "description": "Rollout restrictions." }, "AnthosCluster": { "type": "object", "properties": { "membership": { "description": "Optional. Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.", "type": "string" } }, "id": "AnthosCluster", "description": "Information specifying an Anthos Cluster." }, "RuntimeConfig": { "id": "RuntimeConfig", "properties": { "kubernetes": { "$ref": "KubernetesConfig", "description": "Optional. Kubernetes runtime configuration." }, "cloudRun": { "description": "Optional. Cloud Run runtime configuration.", "$ref": "CloudRunConfig" } }, "description": "RuntimeConfig contains the runtime specific configurations for a deployment strategy.", "type": "object" }, "KubernetesConfig": { "description": "KubernetesConfig contains the Kubernetes runtime configuration.", "type": "object", "properties": { "gatewayServiceMesh": { "description": "Optional. Kubernetes Gateway API service mesh configuration.", "$ref": "GatewayServiceMesh" }, "serviceNetworking": { "$ref": "ServiceNetworking", "description": "Optional. Kubernetes Service networking configuration." } }, "id": "KubernetesConfig" }, "RetryJobResponse": { "id": "RetryJobResponse", "properties": {}, "description": "The response object from 'RetryJob'.", "type": "object" }, "ChildRolloutJobs": { "type": "object", "id": "ChildRolloutJobs", "description": "ChildRollouts job composition", "properties": { "createRolloutJobs": { "items": { "$ref": "Job" }, "type": "array", "readOnly": true, "description": "Output only. List of CreateChildRolloutJobs" }, "advanceRolloutJobs": { "items": { "$ref": "Job" }, "type": "array", "readOnly": true, "description": "Output only. List of AdvanceChildRolloutJobs" } } }, "AdvanceRolloutRequest": { "description": "The request object used by `AdvanceRollout`.", "properties": { "overrideDeployPolicy": { "items": { "type": "string" }, "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.", "type": "array" }, "phaseId": { "description": "Required. The phase ID to advance the `Rollout` to.", "type": "string" } }, "id": "AdvanceRolloutRequest", "type": "object" }, "Retry": { "id": "Retry", "properties": { "backoffMode": { "enumDescriptions": [ "No WaitMode is specified.", "Increases the wait time linearly.", "Increases the wait time exponentially." ], "type": "string", "enum": [ "BACKOFF_MODE_UNSPECIFIED", "BACKOFF_MODE_LINEAR", "BACKOFF_MODE_EXPONENTIAL" ], "description": "Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0." }, "wait": { "type": "string", "format": "google-duration", "description": "Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d." }, "attempts": { "type": "string", "format": "int64", "description": "Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10." } }, "description": "Retries the failed job.", "type": "object" }, "TestIamPermissionsRequest": { "type": "object", "properties": { "permissions": { "items": { "type": "string" }, "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).", "type": "array" } }, "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest" }, "CustomTargetSkaffoldActions": { "id": "CustomTargetSkaffoldActions", "type": "object", "properties": { "renderAction": { "description": "Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.", "type": "string" }, "includeSkaffoldModules": { "type": "array", "description": "Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.", "items": { "$ref": "SkaffoldModules" } }, "deployAction": { "description": "Required. The Skaffold custom action responsible for deploy operations.", "type": "string" } }, "description": "CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions." }, "AdvanceRolloutOperation": { "type": "object", "id": "AdvanceRolloutOperation", "description": "Contains the information of an automated advance-rollout operation.", "properties": { "destinationPhase": { "type": "string", "readOnly": true, "description": "Output only. The phase the rollout will be advanced to." }, "rollout": { "readOnly": true, "type": "string", "description": "Output only. The name of the rollout that initiates the `AutomationRun`." }, "sourcePhase": { "description": "Output only. The phase of a deployment that initiated the operation.", "type": "string", "readOnly": true }, "wait": { "readOnly": true, "format": "google-duration", "description": "Output only. How long the operation will be paused.", "type": "string" } } }, "ApproveRolloutResponse": { "properties": {}, "id": "ApproveRolloutResponse", "description": "The response object from `ApproveRollout`.", "type": "object" }, "ServiceNetworking": { "description": "Information about the Kubernetes Service networking configuration.", "type": "object", "properties": { "service": { "type": "string", "description": "Required. Name of the Kubernetes Service." }, "podSelectorLabel": { "type": "string", "description": "Optional. The label to use when selecting Pods for the Deployment resource. This label must already be present in the Deployment." }, "deployment": { "description": "Required. Name of the Kubernetes Deployment whose traffic is managed by the specified Service.", "type": "string" }, "disablePodOverprovisioning": { "description": "Optional. Whether to disable Pod overprovisioning. If Pod overprovisioning is disabled then Cloud Deploy will limit the number of total Pods used for the deployment strategy to the number of Pods the Deployment has on the cluster.", "type": "boolean" } }, "id": "ServiceNetworking" }, "TerminateJobRunRequest": { "id": "TerminateJobRunRequest", "description": "The request object used by `TerminateJobRun`.", "properties": { "overrideDeployPolicy": { "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "PredeployJob": { "properties": { "tasks": { "type": "array", "readOnly": true, "description": "Output only. The tasks that are executed as part of the predeploy Job.", "items": { "$ref": "Task" } }, "actions": { "readOnly": true, "description": "Output only. The custom actions that the predeploy Job executes.", "items": { "type": "string" }, "type": "array" } }, "description": "A predeploy Job.", "type": "object", "id": "PredeployJob" }, "Status": { "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": { "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array" }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" } }, "type": "object", "id": "Status", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)." }, "TargetAttribute": { "type": "object", "properties": { "id": { "description": "Optional. ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name * \"*\", all targets in a location", "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Target labels." } }, "description": "Contains criteria for selecting Targets. This could be used to select targets for a Deploy Policy or for an Automation.", "id": "TargetAttribute" }, "OperationMetadata": { "type": "object", "description": "Represents the metadata of the long-running operation.", "id": "OperationMetadata", "properties": { "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "type": "string", "readOnly": true }, "verb": { "readOnly": true, "description": "Output only. Name of the verb executed by the operation.", "type": "string" }, "endTime": { "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string" }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "apiVersion": { "readOnly": true, "description": "Output only. API version used to start the operation.", "type": "string" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" } } }, "ListRolloutsResponse": { "id": "ListRolloutsResponse", "description": "ListRolloutsResponse is the response object returned by `ListRollouts`.", "type": "object", "properties": { "rollouts": { "items": { "$ref": "Rollout" }, "type": "array", "description": "The `Rollout` objects." }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } } }, "Standard": { "type": "object", "properties": { "predeploy": { "$ref": "Predeploy", "description": "Optional. Configuration for the predeploy job. If this is not configured, the predeploy job will not be present." }, "verify": { "type": "boolean", "description": "Optional. Whether to verify a deployment via `skaffold verify`." }, "analysis": { "$ref": "Analysis", "description": "Optional. Configuration for the analysis job. If this is not configured, the analysis job will not be present." }, "postdeploy": { "$ref": "Postdeploy", "description": "Optional. Configuration for the postdeploy job. If this is not configured, the postdeploy job will not be present." }, "verifyConfig": { "description": "Optional. Configuration for the verify job. Cannot be set if `verify` is set to true.", "$ref": "Verify" } }, "id": "Standard", "description": "Standard represents the standard deployment strategy." }, "Phase": { "type": "object", "description": "Phase represents a collection of jobs that are logically grouped together for a `Rollout`.", "properties": { "childRolloutJobs": { "$ref": "ChildRolloutJobs", "description": "Output only. ChildRollout job composition.", "readOnly": true }, "state": { "readOnly": true, "description": "Output only. Current state of the Phase.", "enumDescriptions": [ "The Phase has an unspecified state.", "The Phase is waiting for an earlier Phase(s) to complete.", "The Phase is in progress.", "The Phase has succeeded.", "The Phase has failed.", "The Phase was aborted.", "The Phase was skipped." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "IN_PROGRESS", "SUCCEEDED", "FAILED", "ABORTED", "SKIPPED" ] }, "id": { "type": "string", "description": "Output only. The ID of the Phase.", "readOnly": true }, "skipMessage": { "description": "Output only. Additional information on why the Phase was skipped, if available.", "readOnly": true, "type": "string" }, "deploymentJobs": { "$ref": "DeploymentJobs", "description": "Output only. Deployment job composition.", "readOnly": true } }, "id": "Phase" }, "CancelRolloutRequest": { "type": "object", "properties": { "overrideDeployPolicy": { "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.", "items": { "type": "string" }, "type": "array" } }, "description": "The request object used by `CancelRollout`.", "id": "CancelRolloutRequest" }, "RolloutNotificationEvent": { "id": "RolloutNotificationEvent", "type": "object", "description": "Payload proto for \"clouddeploy.googleapis.com/rollout_notification\" Platform Log event that describes the failure to send rollout status change Pub/Sub notification.", "properties": { "releaseUid": { "type": "string", "description": "Unique identifier of the `Release`." }, "message": { "type": "string", "description": "Debug message for when a notification fails to send." }, "targetId": { "description": "ID of the `Target` that the rollout is deployed to.", "type": "string" }, "rolloutUid": { "type": "string", "description": "Unique identifier of the `Rollout`." }, "pipelineUid": { "description": "Unique identifier of the `DeliveryPipeline`.", "type": "string" }, "release": { "type": "string", "description": "The name of the `Release`." }, "type": { "description": "Type of this notification, e.g. for a Pub/Sub failure.", "enumDescriptions": [ "Type is unspecified.", "A Pub/Sub notification failed to be sent.", "Resource state changed.", "A process aborted.", "Restriction check failed.", "Resource deleted.", "Rollout updated.", "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "enumDeprecated": [ false, false, false, false, false, false, false, false, true ], "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_PUBSUB_NOTIFICATION_FAILURE", "TYPE_RESOURCE_STATE_CHANGE", "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ] }, "rollout": { "description": "The name of the `Rollout`.", "type": "string" } } }, "MultiTarget": { "type": "object", "description": "Information specifying a multiTarget.", "properties": { "targetIds": { "description": "Required. The target_ids of this multiTarget.", "items": { "type": "string" }, "type": "array" } }, "id": "MultiTarget" }, "CreateChildRolloutJob": { "id": "CreateChildRolloutJob", "type": "object", "properties": {}, "description": "A createChildRollout Job." }, "AssociatedEntities": { "properties": { "anthosClusters": { "description": "Optional. Information specifying Anthos clusters as associated entities.", "type": "array", "items": { "$ref": "AnthosCluster" } }, "gkeClusters": { "description": "Optional. Information specifying GKE clusters as associated entities.", "type": "array", "items": { "$ref": "GkeCluster" } } }, "type": "object", "description": "Information about entities associated with a `Target`.", "id": "AssociatedEntities" }, "CustomTarget": { "type": "object", "id": "CustomTarget", "description": "Information specifying a Custom Target.", "properties": { "customTargetType": { "type": "string", "description": "Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`." } } }, "ListCustomTargetTypesResponse": { "properties": { "customTargetTypes": { "description": "The `CustomTargetType` objects.", "type": "array", "items": { "$ref": "CustomTargetType" } }, "unreachable": { "description": "Locations that could not be reached.", "items": { "type": "string" }, "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object", "description": "The response object from `ListCustomTargetTypes.`", "id": "ListCustomTargetTypesResponse" }, "RollbackTargetRequest": { "description": "The request object for `RollbackTarget`.", "properties": { "overrideDeployPolicy": { "type": "array", "items": { "type": "string" }, "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deploy_policy}`." }, "rollbackConfig": { "description": "Optional. Configs for the rollback `Rollout`.", "$ref": "RollbackTargetConfig" }, "targetId": { "description": "Required. ID of the `Target` that is being rolled back.", "type": "string" }, "rolloutId": { "type": "string", "description": "Required. ID of the rollback `Rollout` to create." }, "rolloutToRollBack": { "description": "Optional. If provided, this must be the latest `Rollout` that is on the `Target`.", "type": "string" }, "releaseId": { "description": "Optional. ID of the `Release` to roll back to. If this isn't specified, the previous successful `Rollout` to the specified target will be used to determine the `Release`.", "type": "string" }, "validateOnly": { "description": "Optional. If set to true, the request is validated and the user is provided with a `RollbackTargetResponse`.", "type": "boolean" } }, "type": "object", "id": "RollbackTargetRequest" }, "PhaseConfig": { "description": "PhaseConfig represents the configuration for a phase in the custom canary deployment.", "type": "object", "id": "PhaseConfig", "properties": { "phaseId": { "type": "string", "description": "Required. The ID to assign to the `Rollout` phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`." }, "verifyConfig": { "description": "Optional. Configuration for the verify job. Cannot be set if `verify` is set to true.", "$ref": "Verify" }, "analysis": { "$ref": "Analysis", "description": "Optional. Configuration for the analysis job of this phase. If this is not configured, there will be no analysis job for this phase." }, "predeploy": { "description": "Optional. Configuration for the predeploy job of this phase. If this is not configured, there will be no predeploy job for this phase.", "$ref": "Predeploy" }, "percentage": { "description": "Required. Percentage deployment for the phase.", "type": "integer", "format": "int32" }, "postdeploy": { "$ref": "Postdeploy", "description": "Optional. Configuration for the postdeploy job of this phase. If this is not configured, there will be no postdeploy job for this phase." }, "verify": { "type": "boolean", "description": "Optional. Whether to run verify tests after the deployment via `skaffold verify`." }, "profiles": { "description": "Optional. Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the `DeliveryPipeline` stage.", "type": "array", "items": { "type": "string" } } } }, "GkeCluster": { "description": "Information specifying a GKE Cluster.", "id": "GkeCluster", "properties": { "dnsEndpoint": { "type": "boolean", "description": "Optional. If set, the cluster will be accessed using the DNS endpoint. Note that both `dns_endpoint` and `internal_ip` cannot be set to true." }, "proxyUrl": { "type": "string", "description": "Optional. If set, used to configure a [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server." }, "cluster": { "description": "Optional. Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`.", "type": "string" }, "internalIp": { "type": "boolean", "description": "Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). Note that `internal_ip` and `dns_endpoint` cannot both be set to true." } }, "type": "object" }, "Rollout": { "properties": { "activeRepairAutomationRun": { "readOnly": true, "description": "Output only. The AutomationRun actively repairing the rollout.", "type": "string" }, "metadata": { "$ref": "Metadata", "description": "Output only. Metadata contains information about the rollout.", "readOnly": true }, "annotations": { "type": "object", "description": "Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.", "additionalProperties": { "type": "string" } }, "targetId": { "type": "string", "description": "Required. The ID of Target to which this `Rollout` is deploying." }, "labels": { "description": "Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be \u003c= 128 bytes.", "additionalProperties": { "type": "string" }, "type": "object" }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Time at which the `Rollout` was created." }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "FAILED", "IN_PROGRESS", "PENDING_APPROVAL", "APPROVAL_REJECTED", "PENDING", "PENDING_RELEASE", "CANCELLING", "CANCELLED", "HALTED" ], "description": "Output only. Current state of the `Rollout`.", "enumDescriptions": [ "The `Rollout` has an unspecified state.", "The `Rollout` has completed successfully.", "The `Rollout` has failed.", "The `Rollout` is being deployed.", "The `Rollout` needs approval.", "An approver rejected the `Rollout`.", "The `Rollout` is waiting for an earlier Rollout(s) to complete on this `Target`.", "The `Rollout` is waiting for the `Release` to be fully rendered.", "The `Rollout` is in the process of being cancelled.", "The `Rollout` has been cancelled.", "The `Rollout` is halted." ], "readOnly": true }, "description": { "description": "Optional. Description of the `Rollout` for user purposes. Max length is 255 characters.", "type": "string" }, "rolledBackByRollouts": { "readOnly": true, "description": "Output only. Names of `Rollouts` that rolled back this `Rollout`.", "items": { "type": "string" }, "type": "array" }, "deployStartTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Time at which the `Rollout` started deploying.", "type": "string" }, "rollbackOfRollout": { "readOnly": true, "description": "Output only. Name of the `Rollout` that is rolled back by this `Rollout`. Empty if this `Rollout` wasn't created as a rollback.", "type": "string" }, "failureReason": { "type": "string", "readOnly": true, "description": "Output only. Additional information about the rollout failure, if available." }, "enqueueTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. Time at which the `Rollout` was enqueued." }, "controllerRollout": { "readOnly": true, "description": "Output only. Name of the `ControllerRollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.", "type": "string" }, "approveTime": { "description": "Output only. Time at which the `Rollout` was approved.", "type": "string", "readOnly": true, "format": "google-datetime" }, "deployEndTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Time at which the `Rollout` finished deploying." }, "approvalState": { "description": "Output only. Approval state of the `Rollout`.", "type": "string", "enum": [ "APPROVAL_STATE_UNSPECIFIED", "NEEDS_APPROVAL", "DOES_NOT_NEED_APPROVAL", "APPROVED", "REJECTED" ], "readOnly": true, "enumDescriptions": [ "The `Rollout` has an unspecified approval state.", "The `Rollout` requires approval.", "The `Rollout` does not require approval.", "The `Rollout` has been approved.", "The `Rollout` has been rejected." ] }, "phases": { "items": { "$ref": "Phase" }, "description": "Output only. The phases that represent the workflows of this `Rollout`.", "type": "array", "readOnly": true }, "deployingBuild": { "description": "Output only. The resource name of the Cloud Build `Build` object that is used to deploy the Rollout. Format is `projects/{project}/locations/{location}/builds/{build}`.", "readOnly": true, "type": "string" }, "uid": { "description": "Output only. Unique identifier of the `Rollout`.", "readOnly": true, "type": "string" }, "name": { "type": "string", "description": "Identifier. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`. The `rollout` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`" }, "etag": { "type": "string", "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding." }, "deployFailureCause": { "readOnly": true, "type": "string", "enum": [ "FAILURE_CAUSE_UNSPECIFIED", "CLOUD_BUILD_UNAVAILABLE", "EXECUTION_FAILED", "DEADLINE_EXCEEDED", "RELEASE_FAILED", "RELEASE_ABANDONED", "VERIFICATION_CONFIG_NOT_FOUND", "CLOUD_BUILD_REQUEST_FAILED", "OPERATION_FEATURE_NOT_SUPPORTED" ], "enumDescriptions": [ "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The deploy operation did not complete successfully; check Cloud Build logs.", "Deployment did not complete within the allotted time.", "Release is in a failed state.", "Release is abandoned.", "No Skaffold verify configuration was found.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details.", "A Rollout operation had a feature configured that is not supported." ], "description": "Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress." } }, "description": "A `Rollout` resource in the Cloud Deploy API. A `Rollout` contains information around a specific deployment to a `Target`.", "type": "object", "id": "Rollout" }, "SkaffoldGitSource": { "id": "SkaffoldGitSource", "properties": { "repo": { "description": "Required. Git repository the package should be cloned from.", "type": "string" }, "path": { "type": "string", "description": "Optional. Relative path from the repository root to the Skaffold file." }, "ref": { "description": "Optional. Git branch or tag to use when cloning the repository.", "type": "string" } }, "description": "Git repository containing Skaffold Config modules.", "type": "object" }, "CustomCanaryDeployment": { "type": "object", "properties": { "phaseConfigs": { "items": { "$ref": "PhaseConfig" }, "description": "Required. Configuration for each phase in the canary deployment in the order executed.", "type": "array" } }, "description": "CustomCanaryDeployment represents the custom canary deployment configuration.", "id": "CustomCanaryDeployment" }, "PredeployJobRun": { "properties": { "failureCause": { "enumDescriptions": [ "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The predeploy operation did not complete successfully; check Cloud Build logs.", "The predeploy job run did not complete within the allotted time.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details." ], "description": "Output only. The reason the predeploy failed. This will always be unspecified while the predeploy is in progress or if it succeeded.", "type": "string", "enum": [ "FAILURE_CAUSE_UNSPECIFIED", "CLOUD_BUILD_UNAVAILABLE", "EXECUTION_FAILED", "DEADLINE_EXCEEDED", "CLOUD_BUILD_REQUEST_FAILED" ], "readOnly": true }, "failureMessage": { "readOnly": true, "description": "Output only. Additional information about the predeploy failure, if available.", "type": "string" }, "build": { "description": "Output only. The resource name of the Cloud Build `Build` object that is used to execute the custom actions associated with the predeploy Job. Format is `projects/{project}/locations/{location}/builds/{build}`.", "readOnly": true, "type": "string" }, "metadata": { "readOnly": true, "$ref": "PredeployJobRunMetadata", "description": "Output only. Metadata containing information about the predeploy `JobRun`." } }, "id": "PredeployJobRun", "description": "PredeployJobRun contains information specific to a predeploy `JobRun`.", "type": "object" }, "CancelAutomationRunRequest": { "id": "CancelAutomationRunRequest", "description": "The request object used by `CancelAutomationRun`.", "type": "object", "properties": {} }, "Targets": { "properties": { "sourceTargetId": { "description": "Optional. The source target ID.", "type": "string" }, "destinationTargetId": { "type": "string", "description": "Optional. The destination target ID." } }, "id": "Targets", "description": "The targets involved in a single timed promotion.", "type": "object" }, "KubernetesRenderMetadata": { "id": "KubernetesRenderMetadata", "description": "KubernetesRenderMetadata contains Kubernetes information associated with a `Release` render.", "properties": { "kubernetesNamespace": { "description": "Output only. Namespace the Kubernetes resources will be applied to in the GKE cluster. Only set if applying resources to a single namespace.", "readOnly": true, "type": "string" }, "deployment": { "readOnly": true, "description": "Output only. Name of the Kubernetes Deployment that will be applied to the GKE cluster. Only set if a single Deployment was provided in the rendered manifest.", "type": "string" }, "canaryDeployment": { "description": "Output only. Name of the canary version of the Kubernetes Deployment that will be applied to the GKE cluster. Only set if a canary deployment strategy was configured.", "readOnly": true, "type": "string" } }, "type": "object" }, "IgnoreJobResponse": { "id": "IgnoreJobResponse", "description": "The response object from `IgnoreJob`.", "properties": {}, "type": "object" }, "PipelineCondition": { "type": "object", "description": "PipelineCondition contains all conditions relevant to a Delivery Pipeline.", "properties": { "targetsTypeCondition": { "description": "Details on the whether the targets enumerated in the pipeline are of the same type.", "$ref": "TargetsTypeCondition" }, "targetsPresentCondition": { "$ref": "TargetsPresentCondition", "description": "Details around targets enumerated in the pipeline." }, "pipelineReadyCondition": { "description": "Details around the Pipeline's overall status.", "$ref": "PipelineReadyCondition" } }, "id": "PipelineCondition" }, "RouteDestinations": { "id": "RouteDestinations", "description": "Information about route destinations for the Gateway API service mesh.", "type": "object", "properties": { "propagateService": { "description": "Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used to facilitate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified.", "type": "boolean" }, "destinationIds": { "items": { "type": "string" }, "type": "array", "description": "Required. The clusters where the Gateway API HTTPRoute resource will be deployed to. Valid entries include the associated entities IDs configured in the Target resource and \"@self\" to include the Target cluster." } } }, "DeliveryPipelineNotificationEvent": { "properties": { "type": { "enumDescriptions": [ "Type is unspecified.", "A Pub/Sub notification failed to be sent.", "Resource state changed.", "A process aborted.", "Restriction check failed.", "Resource deleted.", "Rollout updated.", "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "description": "Type of this notification, e.g. for a Pub/Sub failure.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_PUBSUB_NOTIFICATION_FAILURE", "TYPE_RESOURCE_STATE_CHANGE", "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ false, false, false, false, false, false, false, false, true ] }, "pipelineUid": { "type": "string", "description": "Unique identifier of the `DeliveryPipeline`." }, "deliveryPipeline": { "description": "The name of the `Delivery Pipeline`.", "type": "string" }, "message": { "type": "string", "description": "Debug message for when a notification fails to send." } }, "id": "DeliveryPipelineNotificationEvent", "description": "Payload proto for \"clouddeploy.googleapis.com/deliverypipeline_notification\" Platform Log event that describes the failure to send delivery pipeline status change Pub/Sub notification.", "type": "object" }, "PolicyViolation": { "description": "Returned from an action if one or more policies were violated, and therefore the action was prevented. Contains information about what policies were violated and why.", "type": "object", "properties": { "policyViolationDetails": { "items": { "$ref": "PolicyViolationDetails" }, "description": "Policy violation details.", "type": "array" } }, "id": "PolicyViolation" }, "DeliveryPipeline": { "id": "DeliveryPipeline", "type": "object", "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Time at which the pipeline was created.", "type": "string" }, "condition": { "$ref": "PipelineCondition", "description": "Output only. Information around the state of the Delivery Pipeline.", "readOnly": true }, "uid": { "type": "string", "readOnly": true, "description": "Output only. Unique identifier of the `DeliveryPipeline`." }, "description": { "description": "Optional. Description of the `DeliveryPipeline`. Max length is 255 characters.", "type": "string" }, "suspended": { "description": "Optional. When suspended, no new releases or rollouts can be created, but in-progress ones will complete.", "type": "boolean" }, "updateTime": { "description": "Output only. Most recent time at which the pipeline was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "serialPipeline": { "description": "Optional. SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.", "$ref": "SerialPipeline" }, "labels": { "type": "object", "description": "Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be \u003c= 128 bytes.", "additionalProperties": { "type": "string" } }, "name": { "description": "Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`", "type": "string" }, "etag": { "type": "string", "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding." }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy." } }, "description": "A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress." }, "Rollback": { "description": "Rolls back a `Rollout`.", "properties": { "destinationPhase": { "type": "string", "description": "Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase." }, "disableRollbackIfRolloutPending": { "type": "boolean", "description": "Optional. If pending rollout exists on the target, the rollback operation will be aborted." } }, "id": "Rollback", "type": "object" }, "DeployPolicyResourceSelector": { "description": "Contains information on the resources to select for a deploy policy. Attributes provided must all match the resource in order for policy restrictions to apply. For example, if delivery pipelines attributes given are an id \"prod\" and labels \"foo: bar\", a delivery pipeline resource must match both that id and have that label in order to be subject to the policy.", "type": "object", "properties": { "deliveryPipeline": { "description": "Optional. Contains attributes about a delivery pipeline.", "$ref": "DeliveryPipelineAttribute" }, "target": { "description": "Optional. Contains attributes about a target.", "$ref": "TargetAttribute" } }, "id": "DeployPolicyResourceSelector" }, "Job": { "description": "Job represents an operation for a `Rollout`.", "properties": { "jobRun": { "description": "Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.", "type": "string", "readOnly": true }, "skipMessage": { "readOnly": true, "description": "Output only. Additional information on why the Job was skipped, if available.", "type": "string" }, "id": { "description": "Output only. The ID of the Job.", "readOnly": true, "type": "string" }, "analysisJob": { "readOnly": true, "description": "Output only. An analysis Job.", "$ref": "AnalysisJob" }, "createChildRolloutJob": { "$ref": "CreateChildRolloutJob", "description": "Output only. A createChildRollout Job.", "readOnly": true }, "deployJob": { "readOnly": true, "$ref": "DeployJob", "description": "Output only. A deploy Job." }, "advanceChildRolloutJob": { "readOnly": true, "description": "Output only. An advanceChildRollout Job.", "$ref": "AdvanceChildRolloutJob" }, "verifyJob": { "readOnly": true, "$ref": "VerifyJob", "description": "Output only. A verify Job." }, "state": { "description": "Output only. The current state of the Job.", "readOnly": true, "enumDescriptions": [ "The Job has an unspecified state.", "The Job is waiting for an earlier Phase(s) or Job(s) to complete.", "The Job is disabled.", "The Job is in progress.", "The Job succeeded.", "The Job failed.", "The Job was aborted.", "The Job was skipped.", "The Job was ignored." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "DISABLED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "ABORTED", "SKIPPED", "IGNORED" ] }, "postdeployJob": { "$ref": "PostdeployJob", "readOnly": true, "description": "Output only. A postdeploy Job." }, "predeployJob": { "$ref": "PredeployJob", "description": "Output only. A predeploy Job.", "readOnly": true } }, "type": "object", "id": "Job" }, "PostdeployJob": { "id": "PostdeployJob", "description": "A postdeploy Job.", "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Output only. The custom actions that the postdeploy Job executes." }, "tasks": { "type": "array", "items": { "$ref": "Task" }, "readOnly": true, "description": "Output only. The tasks that are executed as part of the postdeploy Job." } } }, "DeployArtifact": { "description": "The artifacts produced by a deploy operation.", "type": "object", "id": "DeployArtifact", "properties": { "manifestPaths": { "type": "array", "items": { "type": "string" }, "description": "Output only. File paths of the manifests applied during the deploy operation relative to the URI.", "readOnly": true }, "artifactUri": { "readOnly": true, "description": "Output only. URI of a directory containing the artifacts. All paths are relative to this location.", "type": "string" } } }, "SkaffoldModules": { "description": "Skaffold Config modules and their remote source.", "properties": { "googleCloudStorage": { "$ref": "SkaffoldGCSSource", "description": "Optional. Cloud Storage bucket containing the Skaffold Config modules." }, "googleCloudBuildRepo": { "description": "Optional. Cloud Build V2 repository containing the Skaffold Config modules.", "$ref": "SkaffoldGCBRepoSource" }, "git": { "description": "Optional. Remote git repository containing the Skaffold Config modules.", "$ref": "SkaffoldGitSource" }, "configs": { "type": "array", "items": { "type": "string" }, "description": "Optional. The Skaffold Config modules to use from the specified source." } }, "type": "object", "id": "SkaffoldModules" }, "Postdeploy": { "description": "Postdeploy contains the postdeploy job configuration information.", "properties": { "tasks": { "description": "Optional. The tasks that will run as a part of the postdeploy job. The tasks are executed sequentially in the order specified. Only one of `actions` or `tasks` can be specified.", "items": { "$ref": "Task" }, "type": "array" }, "actions": { "type": "array", "description": "Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.", "items": { "type": "string" } } }, "type": "object", "id": "Postdeploy" }, "Release": { "type": "object", "description": "A `Release` resource in the Cloud Deploy API. A `Release` defines a specific Skaffold configuration instance that can be deployed.", "id": "Release", "properties": { "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be \u003c= 128 bytes." }, "deliveryPipelineSnapshot": { "$ref": "DeliveryPipeline", "description": "Output only. Snapshot of the parent pipeline taken at release creation time.", "readOnly": true }, "toolVersions": { "description": "Optional. The tool versions to use for this release and all subsequent operations involving this release. If unset, tool versions are frozen when the release is created.", "$ref": "ToolVersions" }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Time at which the `Release` was created." }, "name": { "description": "Identifier. Name of the `Release`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`. The `release` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`", "type": "string" }, "renderState": { "enumDescriptions": [ "The render state is unspecified.", "All rendering operations have completed successfully.", "All rendering operations have completed, and one or more have failed.", "Rendering has started and is not complete." ], "readOnly": true, "type": "string", "enum": [ "RENDER_STATE_UNSPECIFIED", "SUCCEEDED", "FAILED", "IN_PROGRESS" ], "description": "Output only. Current state of the render operation." }, "skaffoldConfigUri": { "description": "Optional. Cloud Storage URI of tar.gz archive containing Skaffold configuration.", "type": "string" }, "etag": { "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, "renderStartTime": { "type": "string", "format": "google-datetime", "description": "Output only. Time at which the render began.", "readOnly": true }, "uid": { "description": "Output only. Unique identifier of the `Release`.", "readOnly": true, "type": "string" }, "customTargetTypeSnapshots": { "readOnly": true, "type": "array", "description": "Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.", "items": { "$ref": "CustomTargetType" } }, "targetArtifacts": { "description": "Output only. Map from target ID to the target artifacts created during the render operation.", "additionalProperties": { "$ref": "TargetArtifact" }, "readOnly": true, "type": "object" }, "deployParameters": { "additionalProperties": { "type": "string" }, "description": "Optional. The deploy parameters to use for all targets in this release.", "type": "object" }, "description": { "description": "Optional. Description of the `Release`. Max length is 255 characters.", "type": "string" }, "buildArtifacts": { "description": "Optional. List of artifacts to pass through to Skaffold command.", "items": { "$ref": "BuildArtifact" }, "type": "array" }, "skaffoldVersion": { "description": "Optional. The Skaffold version to use when operating on this release, such as \"1.20.0\". Not all versions are valid; Cloud Deploy supports a specific set of versions. If unset, the most recent supported Skaffold version will be used.", "type": "string" }, "abandoned": { "description": "Output only. Indicates whether this is an abandoned release.", "type": "boolean", "readOnly": true }, "condition": { "readOnly": true, "$ref": "ReleaseCondition", "description": "Output only. Information around the state of the Release." }, "targetSnapshots": { "items": { "$ref": "Target" }, "readOnly": true, "description": "Output only. Snapshot of the targets taken at release creation time.", "type": "array" }, "targetRenders": { "readOnly": true, "additionalProperties": { "$ref": "TargetRender" }, "type": "object", "description": "Output only. Map from target ID to details of the render operation for that target." }, "skaffoldConfigPath": { "type": "string", "description": "Optional. Filepath of the Skaffold config inside of the config URI." }, "renderEndTime": { "description": "Output only. Time at which the render completed.", "type": "string", "readOnly": true, "format": "google-datetime" }, "annotations": { "description": "Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.", "additionalProperties": { "type": "string" }, "type": "object" } } }, "ToolVersions": { "properties": { "skaffold": { "description": "Optional. The Skaffold version to use for Cloud Deploy operations.", "type": "string" }, "kubectl": { "description": "Optional. The Kubectl version to use for Cloud Deploy operations.", "type": "string" }, "docker": { "description": "Optional. The Docker version to use for Cloud Deploy operations.", "type": "string" }, "kustomize": { "type": "string", "description": "Optional. The Kustomize version to use for Cloud Deploy operations." }, "kpt": { "description": "Optional. The kpt version to use for Cloud Deploy operations.", "type": "string" }, "helm": { "description": "Optional. The Helm version to use for Cloud Deploy operations.", "type": "string" } }, "description": "Details of ToolVersions for the release.", "id": "ToolVersions", "type": "object" }, "JobRunNotificationEvent": { "description": "Payload proto for \"clouddeploy.googleapis.com/jobrun_notification\" Platform Log event that describes the failure to send JobRun resource update Pub/Sub notification.", "properties": { "rollout": { "description": "The name of the `Rollout`.", "type": "string" }, "pipelineUid": { "type": "string", "description": "Unique identifier of the `DeliveryPipeline`." }, "release": { "description": "The name of the `Release`.", "type": "string" }, "jobRun": { "type": "string", "description": "The name of the `JobRun`." }, "targetId": { "description": "ID of the `Target`.", "type": "string" }, "releaseUid": { "description": "Unique identifier of the `Release`.", "type": "string" }, "rolloutUid": { "description": "Unique identifier of the `Rollout`.", "type": "string" }, "message": { "description": "Debug message for when a notification fails to send.", "type": "string" }, "type": { "description": "Type of this notification, e.g. for a Pub/Sub failure.", "enumDeprecated": [ false, false, false, false, false, false, false, false, true ], "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_PUBSUB_NOTIFICATION_FAILURE", "TYPE_RESOURCE_STATE_CHANGE", "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDescriptions": [ "Type is unspecified.", "A Pub/Sub notification failed to be sent.", "Resource state changed.", "A process aborted.", "Restriction check failed.", "Resource deleted.", "Rollout updated.", "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ] } }, "id": "JobRunNotificationEvent", "type": "object" }, "CloudRunMetadata": { "properties": { "previousRevision": { "type": "string", "readOnly": true, "description": "Output only. The previous Cloud Run Revision name associated with a `Rollout`. Only set when a canary deployment strategy is configured. Format for service is projects/{project}/locations/{location}/services/{service}/revisions/{revision}. Format for worker pool is projects/{project}/locations/{location}/workerPools/{workerpool}/revisions/{revision}." }, "workerPool": { "readOnly": true, "description": "Output only. The Cloud Run worker pool associated with a `Rollout`. Format is `projects/{project}/locations/{location}/workerPools/{worker_pool}`.", "type": "string" }, "job": { "readOnly": true, "description": "Output only. The name of the Cloud Run job that is associated with a `Rollout`. Format is `projects/{project}/locations/{location}/jobs/{job_name}`.", "type": "string" }, "service": { "description": "Output only. The name of the Cloud Run Service that is associated with a `Rollout`. Format is `projects/{project}/locations/{location}/services/{service}`.", "readOnly": true, "type": "string" }, "revision": { "readOnly": true, "description": "Output only. The Cloud Run Revision id associated with a `Rollout`.", "type": "string" }, "serviceUrls": { "readOnly": true, "type": "array", "description": "Output only. The Cloud Run Service urls that are associated with a `Rollout`.", "items": { "type": "string" } } }, "id": "CloudRunMetadata", "description": "CloudRunMetadata contains information from a Cloud Run deployment.", "type": "object" }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "properties": { "updateMask": { "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\"`", "format": "google-fieldmask", "type": "string" }, "policy": { "$ref": "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." } }, "id": "SetIamPolicyRequest", "type": "object" }, "Target": { "type": "object", "description": "A `Target` resource in the Cloud Deploy API. A `Target` defines a location to which a Skaffold configuration can be deployed.", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations." }, "requireApproval": { "type": "boolean", "description": "Optional. Whether or not the `Target` requires approval." }, "updateTime": { "readOnly": true, "description": "Output only. Most recent time at which the `Target` was updated.", "type": "string", "format": "google-datetime" }, "run": { "$ref": "CloudRunLocation", "description": "Optional. Information specifying a Cloud Run deployment target." }, "gke": { "description": "Optional. Information specifying a GKE Cluster.", "$ref": "GkeCluster" }, "associatedEntities": { "description": "Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", "additionalProperties": { "$ref": "AssociatedEntities" }, "type": "object" }, "labels": { "description": "Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be \u003c= 128 bytes.", "additionalProperties": { "type": "string" }, "type": "object" }, "deployParameters": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. The deploy parameters to use for this target." }, "customTarget": { "description": "Optional. Information specifying a Custom Target.", "$ref": "CustomTarget" }, "description": { "type": "string", "description": "Optional. Description of the `Target`. Max length is 255 characters." }, "multiTarget": { "$ref": "MultiTarget", "description": "Optional. Information specifying a multiTarget." }, "targetId": { "description": "Output only. Resource id of the `Target`.", "readOnly": true, "type": "string" }, "executionConfigs": { "type": "array", "description": "Optional. Configurations for all execution that relates to this `Target`. Each `ExecutionEnvironmentUsage` value may only be used in a single configuration; using the same value multiple times is an error. When one or more configurations are specified, they must include the `RENDER` and `DEPLOY` `ExecutionEnvironmentUsage` values. When no configurations are specified, execution will use the default specified in `DefaultPool`.", "items": { "$ref": "ExecutionConfig" } }, "etag": { "type": "string", "description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding." }, "name": { "description": "Identifier. Name of the `Target`. Format is `projects/{project}/locations/{location}/targets/{target}`. The `target` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`", "type": "string" }, "uid": { "description": "Output only. Unique identifier of the `Target`.", "readOnly": true, "type": "string" }, "anthosCluster": { "description": "Optional. Information specifying an Anthos Cluster.", "$ref": "AnthosCluster" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Time at which the `Target` was created.", "type": "string" } }, "id": "Target" }, "PredeployJobRunMetadata": { "description": "PredeployJobRunMetadata contains metadata about the predeploy `JobRun`.", "type": "object", "properties": { "custom": { "description": "Output only. Custom metadata provided by user-defined predeploy operation.", "$ref": "CustomMetadata", "readOnly": true } }, "id": "PredeployJobRunMetadata" }, "RetryJobRequest": { "type": "object", "id": "RetryJobRequest", "properties": { "jobId": { "type": "string", "description": "Required. The job ID for the Job to retry." }, "phaseId": { "description": "Required. The phase ID the Job to retry belongs to.", "type": "string" }, "overrideDeployPolicy": { "type": "array", "items": { "type": "string" }, "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`." } }, "description": "RetryJobRequest is the request object used by `RetryJob`." }, "AnalysisJobRun": { "type": "object", "id": "AnalysisJobRun", "properties": { "customCheckAnalyses": { "description": "Output only. The status of the running custom checks configured for this analysis.", "items": { "$ref": "CustomCheckStatus" }, "type": "array", "readOnly": true }, "failedCheckId": { "type": "string", "readOnly": true, "description": "Output only. The ID of the configured check that failed. This will always be blank while the analysis is in progress or if it succeeded." }, "alertPolicyAnalyses": { "readOnly": true, "items": { "$ref": "AlertPolicyCheckStatus" }, "description": "Output only. The status of the running alert policy checks configured for this analysis.", "type": "array" } }, "description": "AnalysisJobRun contains information specific to an analysis `JobRun`." }, "CustomMetadata": { "description": "CustomMetadata contains information from a user-defined operation.", "properties": { "values": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Output only. Key-value pairs provided by the user-defined operation.", "readOnly": true } }, "id": "CustomMetadata", "type": "object" }, "SerialPipeline": { "type": "object", "id": "SerialPipeline", "description": "SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.", "properties": { "stages": { "type": "array", "description": "Optional. Each stage specifies configuration for a `Target`. The ordering of this list defines the promotion flow.", "items": { "$ref": "Stage" } } } }, "TimedPromoteReleaseCondition": { "type": "object", "properties": { "nextPromotionTime": { "readOnly": true, "description": "Output only. When the next scheduled promotion(s) will occur.", "format": "google-datetime", "type": "string" }, "targetsList": { "description": "Output only. A list of targets involved in the upcoming timed promotion(s).", "items": { "$ref": "Targets" }, "readOnly": true, "type": "array" } }, "id": "TimedPromoteReleaseCondition", "description": "`TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined." }, "CustomTargetDeployMetadata": { "description": "CustomTargetDeployMetadata contains information from a Custom Target deploy operation.", "properties": { "skipMessage": { "description": "Output only. Skip message provided in the results of a custom deploy operation.", "readOnly": true, "type": "string" } }, "id": "CustomTargetDeployMetadata", "type": "object" }, "TargetNotificationEvent": { "id": "TargetNotificationEvent", "description": "Payload proto for \"clouddeploy.googleapis.com/target_notification\" Platform Log event that describes the failure to send target status change Pub/Sub notification.", "properties": { "target": { "description": "The name of the `Target`.", "type": "string" }, "type": { "enumDeprecated": [ false, false, false, false, false, false, false, false, true ], "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_PUBSUB_NOTIFICATION_FAILURE", "TYPE_RESOURCE_STATE_CHANGE", "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDescriptions": [ "Type is unspecified.", "A Pub/Sub notification failed to be sent.", "Resource state changed.", "A process aborted.", "Restriction check failed.", "Resource deleted.", "Rollout updated.", "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "description": "Type of this notification, e.g. for a Pub/Sub failure." }, "message": { "description": "Debug message for when a notification fails to send.", "type": "string" } }, "type": "object" }, "ListTargetsResponse": { "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "targets": { "type": "array", "items": { "$ref": "Target" }, "description": "The `Target` objects." } }, "description": "The response object from `ListTargets`.", "id": "ListTargetsResponse" }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "properties": {}, "type": "object", "id": "CancelOperationRequest" }, "AdvanceRolloutRule": { "id": "AdvanceRolloutRule", "type": "object", "description": "The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase.", "properties": { "wait": { "type": "string", "description": "Optional. How long to wait after a rollout is finished.", "format": "google-duration" }, "id": { "description": "Required. ID of the rule. This id must be unique in the `Automation` resource to which this rule belongs. The format is `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.", "type": "string" }, "sourcePhases": { "items": { "type": "string" }, "description": "Optional. Proceeds only after phase name matched any one in the list. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", "type": "array" }, "condition": { "readOnly": true, "$ref": "AutomationRuleCondition", "description": "Output only. Information around the state of the Automation rule." } } }, "AutomationRule": { "description": "`AutomationRule` defines the automation activities.", "properties": { "timedPromoteReleaseRule": { "description": "Optional. The `TimedPromoteReleaseRule` will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule.", "$ref": "TimedPromoteReleaseRule" }, "promoteReleaseRule": { "description": "Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.", "$ref": "PromoteReleaseRule" }, "advanceRolloutRule": { "description": "Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.", "$ref": "AdvanceRolloutRule" }, "repairRolloutRule": { "description": "Optional. The `RepairRolloutRule` will automatically repair a failed rollout.", "$ref": "RepairRolloutRule" } }, "type": "object", "id": "AutomationRule" }, "DeliveryPipelineAttribute": { "type": "object", "id": "DeliveryPipelineAttribute", "description": "Contains criteria for selecting DeliveryPipelines.", "properties": { "id": { "description": "Optional. ID of the `DeliveryPipeline`. The value of this field could be one of the following: * The last segment of a pipeline name * \"*\", all delivery pipelines in a location", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "DeliveryPipeline labels." } } }, "SkaffoldGCBRepoSource": { "description": "Cloud Build V2 Repository containing Skaffold Configs.", "properties": { "repository": { "description": "Required. Name of the Cloud Build V2 Repository. Format is projects/{project}/locations/{location}/connections/{connection}/repositories/{repository}.", "type": "string" }, "path": { "description": "Optional. Relative path from the repository root to the Skaffold Config file.", "type": "string" }, "ref": { "type": "string", "description": "Optional. Branch or tag to use when cloning the repository." } }, "type": "object", "id": "SkaffoldGCBRepoSource" }, "AdvanceRolloutResponse": { "id": "AdvanceRolloutResponse", "properties": {}, "type": "object", "description": "The response object from `AdvanceRollout`." }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "properties": { "locations": { "type": "array", "items": { "$ref": "Location" }, "description": "A list of locations that matches the specified filter in the request." }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "type": "object", "id": "ListLocationsResponse" }, "Binding": { "type": "object", "id": "Binding", "description": "Associates `members`, or principals, with a `role`.", "properties": { "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": { "$ref": "Expr", "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)." }, "members": { "type": "array", "items": { "type": "string" }, "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`." } } }, "ListAutomationRunsResponse": { "id": "ListAutomationRunsResponse", "description": "The response object from `ListAutomationRuns`.", "type": "object", "properties": { "automationRuns": { "items": { "$ref": "AutomationRun" }, "description": "The `AutomationRuns` objects.", "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Locations that could not be reached." } } }, "SkaffoldSupportedCondition": { "type": "object", "description": "SkaffoldSupportedCondition contains information about when support for the release's version of Skaffold ends.", "id": "SkaffoldSupportedCondition", "properties": { "supportExpirationTime": { "format": "google-datetime", "description": "The time at which this release's version of Skaffold will no longer be supported.", "type": "string" }, "skaffoldSupportState": { "description": "The Skaffold support state for this release's version of Skaffold.", "enumDescriptions": [ "Default value. This value is unused.", "This Skaffold version is currently supported.", "This Skaffold version is in maintenance mode.", "This Skaffold version is no longer supported." ], "type": "string", "enum": [ "SKAFFOLD_SUPPORT_STATE_UNSPECIFIED", "SKAFFOLD_SUPPORT_STATE_SUPPORTED", "SKAFFOLD_SUPPORT_STATE_MAINTENANCE_MODE", "SKAFFOLD_SUPPORT_STATE_UNSUPPORTED" ] }, "status": { "description": "True if the version of Skaffold used by this release is supported.", "type": "boolean" }, "maintenanceModeTime": { "format": "google-datetime", "type": "string", "description": "The time at which this release's version of Skaffold will enter maintenance mode." } } }, "TerminateJobRunResponse": { "description": "The response object from `TerminateJobRun`.", "type": "object", "id": "TerminateJobRunResponse", "properties": {} }, "CloudRunRenderMetadata": { "properties": { "service": { "readOnly": true, "type": "string", "description": "Output only. The name of the Cloud Run Service in the rendered manifest. Format is `projects/{project}/locations/{location}/services/{service}`." }, "job": { "readOnly": true, "description": "Output only. The name of the Cloud Run Job in the rendered manifest. Format is `projects/{project}/locations/{location}/jobs/{job}`.", "type": "string" }, "workerPool": { "description": "Output only. The name of the Cloud Run Worker Pool in the rendered manifest. Format is `projects/{project}/locations/{location}/workerPools/{worker_pool}`.", "readOnly": true, "type": "string" }, "revision": { "type": "string", "readOnly": true, "description": "Output only. The name of the Cloud Run Revision in the rendered manifest. Format is `projects/{project}/locations/{location}/services/{service}/revisions/{revision}`." } }, "id": "CloudRunRenderMetadata", "type": "object", "description": "CloudRunRenderMetadata contains Cloud Run information associated with a `Release` render." }, "TargetsTypeCondition": { "type": "object", "description": "TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type.", "properties": { "status": { "type": "boolean", "description": "True if the targets are all a comparable type. For example this is true if all targets are GKE clusters. This is false if some targets are Cloud Run targets and others are GKE clusters." }, "errorDetails": { "description": "Human readable error message.", "type": "string" } }, "id": "TargetsTypeCondition" }, "AbandonReleaseRequest": { "properties": {}, "description": "The request object used by `AbandonRelease`.", "type": "object", "id": "AbandonReleaseRequest" }, "RenderMetadata": { "id": "RenderMetadata", "type": "object", "properties": { "cloudRun": { "$ref": "CloudRunRenderMetadata", "description": "Output only. Metadata associated with rendering for Cloud Run.", "readOnly": true }, "custom": { "readOnly": true, "description": "Output only. Custom metadata provided by user-defined render operation.", "$ref": "CustomMetadata" }, "kubernetes": { "description": "Output only. Metadata associated with rendering for a Kubernetes cluster (GKE or GKE Enterprise target).", "readOnly": true, "$ref": "KubernetesRenderMetadata" } }, "description": "RenderMetadata includes information associated with a `Release` render." }, "Policy": { "type": "object", "id": "Policy", "properties": { "etag": { "type": "string", "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" }, "bindings": { "type": "array", "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`.", "items": { "$ref": "Binding" } }, "version": { "type": "integer", "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).", "format": "int32" }, "auditConfigs": { "description": "Specifies cloud audit logging configuration for this policy.", "items": { "$ref": "AuditConfig" }, "type": "array" } }, "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/)." }, "PipelineReadyCondition": { "type": "object", "properties": { "updateTime": { "format": "google-datetime", "type": "string", "description": "Last time the condition was updated." }, "status": { "description": "True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.", "type": "boolean" } }, "description": "PipelineReadyCondition contains information around the status of the Pipeline.", "id": "PipelineReadyCondition" }, "CustomCheckStatus": { "description": "CustomCheckStatus contains information specific to a single iteration of a custom analysis job.", "id": "CustomCheckStatus", "type": "object", "properties": { "failureCause": { "enumDescriptions": [ "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The analysis operation did not complete successfully; check Cloud Build logs.", "The analysis job run did not complete within the alloted time defined in the target's execution environment configuration.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details." ], "description": "Output only. The reason the analysis failed. This will always be unspecified while the analysis is in progress or if it succeeded.", "readOnly": true, "type": "string", "enum": [ "FAILURE_CAUSE_UNSPECIFIED", "CLOUD_BUILD_UNAVAILABLE", "EXECUTION_FAILED", "DEADLINE_EXCEEDED", "CLOUD_BUILD_REQUEST_FAILED" ] }, "id": { "readOnly": true, "description": "Output only. The ID of the custom check.", "type": "string" }, "task": { "readOnly": true, "$ref": "Task", "description": "Output only. The task that ran for this custom check." }, "frequency": { "format": "google-duration", "readOnly": true, "type": "string", "description": "Output only. The frequency in minutes at which the custom check is run." }, "latestBuild": { "type": "string", "readOnly": true, "description": "Output only. The resource name of the Cloud Build `Build` object that was used to execute the latest run of this custom action check. Format is `projects/{project}/locations/{location}/builds/{build}`." }, "metadata": { "description": "Output only. Custom metadata provided by the user-defined custom check operation. result.", "$ref": "CustomMetadata", "readOnly": true }, "failureMessage": { "readOnly": true, "description": "Output only. Additional information about the analysis failure, if available.", "type": "string" } } }, "RepairPhaseConfig": { "id": "RepairPhaseConfig", "description": "Configuration of the repair phase.", "properties": { "retry": { "description": "Optional. Retries a failed job.", "$ref": "Retry" }, "rollback": { "$ref": "Rollback", "description": "Optional. Rolls back a `Rollout`." } }, "type": "object" }, "Config": { "description": "Service-wide configuration.", "type": "object", "id": "Config", "properties": { "defaultToolVersions": { "readOnly": true, "description": "Output only. Default tool versions. These tool versions are assigned when a Release is created without specifying tool versions.", "$ref": "ToolVersions" }, "defaultSkaffoldVersion": { "description": "Default Skaffold version that is assigned when a Release is created without specifying a Skaffold version.", "type": "string" }, "name": { "type": "string", "description": "Name of the configuration." }, "supportedVersions": { "description": "All supported versions of Skaffold.", "type": "array", "items": { "$ref": "SkaffoldVersion" } } } }, "RollbackTargetConfig": { "type": "object", "properties": { "rollout": { "$ref": "Rollout", "description": "Optional. The rollback `Rollout` to create." }, "startingPhaseId": { "description": "Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase.", "type": "string" } }, "description": "Configs for the Rollback rollout.", "id": "RollbackTargetConfig" }, "CustomCheck": { "id": "CustomCheck", "properties": { "frequency": { "type": "string", "format": "google-duration", "description": "Optional. The frequency at which the custom check will be run, with a minimum and default of 5 minutes." }, "id": { "description": "Required. The ID of the custom Analysis check.", "type": "string" }, "task": { "description": "Required. The Task to be run for this custom check.", "$ref": "Task" } }, "type": "object", "description": "CustomCheck configures a third-party metric provider to run the analysis, via a Task that runs at a specified frequency." }, "Stage": { "properties": { "deployParameters": { "items": { "$ref": "DeployParameters" }, "description": "Optional. The deploy parameters to use for the target in this stage.", "type": "array" }, "strategy": { "description": "Optional. The strategy to use for a `Rollout` to this stage.", "$ref": "Strategy" }, "targetId": { "type": "string", "description": "Optional. The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be `my-target` (rather than `projects/project/locations/location/targets/my-target`). The location of the `Target` is inferred to be the same as the location of the `DeliveryPipeline` that contains this `Stage`." }, "profiles": { "description": "Optional. Skaffold profiles to use when rendering the manifest for this stage's `Target`.", "type": "array", "items": { "type": "string" } } }, "description": "Stage specifies a location to which to deploy.", "type": "object", "id": "Stage" }, "TargetsPresentCondition": { "type": "object", "description": "`TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist.", "properties": { "updateTime": { "format": "google-datetime", "description": "Last time the condition was updated.", "type": "string" }, "status": { "type": "boolean", "description": "True if there aren't any missing Targets." }, "missingTargets": { "description": "The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.", "type": "array", "items": { "type": "string" } } }, "id": "TargetsPresentCondition" }, "PromoteReleaseRule": { "type": "object", "id": "PromoteReleaseRule", "description": "The `PromoteRelease` rule will automatically promote a release from the current target to a specified target.", "properties": { "destinationPhase": { "type": "string", "description": "Optional. The starting phase of the rollout created by this operation. Default to the first phase." }, "id": { "description": "Required. ID of the rule. This id must be unique in the `Automation` resource to which this rule belongs. The format is `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.", "type": "string" }, "wait": { "format": "google-duration", "type": "string", "description": "Optional. How long the release need to be paused until being promoted to the next target." }, "condition": { "$ref": "AutomationRuleCondition", "readOnly": true, "description": "Output only. Information around the state of the Automation rule." }, "destinationTargetId": { "description": "Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name * \"@next\", the next target in the promotion sequence", "type": "string" } } }, "AnalysisJob": { "type": "object", "description": "An analysis Job.", "id": "AnalysisJob", "properties": { "duration": { "format": "google-duration", "description": "Output only. The amount of time in minutes the analysis Job will run, up to a maximum of 48 hours. If any check in this Job is still running when the duration ends, the Job keeps running until that check completes.", "readOnly": true, "type": "string" }, "googleCloud": { "description": "Output only. Google Cloud - based analysis checks that are run as part of the analysis Job.", "$ref": "GoogleCloudAnalysis", "readOnly": true }, "customChecks": { "type": "array", "readOnly": true, "items": { "$ref": "CustomCheck" }, "description": "Output only. Custom analysis checks from 3P metric providers that are run as part of the analysis Job." } } }, "DefaultPool": { "type": "object", "description": "Execution using the default Cloud Build pool.", "properties": { "artifactStorage": { "description": "Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket (\"gs://my-bucket\") or a path within a bucket (\"gs://my-bucket/my-dir\"). If unspecified, a default bucket located in the same region will be used.", "type": "string" }, "serviceAccount": { "description": "Optional. Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) will be used.", "type": "string" } }, "id": "DefaultPool" }, "Automation": { "description": "An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.", "properties": { "rules": { "type": "array", "description": "Required. List of Automation rules associated with the Automation resource. Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution.", "items": { "$ref": "AutomationRule" } }, "uid": { "type": "string", "description": "Output only. Unique identifier of the `Automation`.", "readOnly": true }, "selector": { "$ref": "AutomationResourceSelector", "description": "Required. Selected resources to which the automation will be applied." }, "suspended": { "type": "boolean", "description": "Optional. When Suspended, automation is deactivated from execution." }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details." }, "updateTime": { "format": "google-datetime", "description": "Output only. Time at which the automation was updated.", "readOnly": true, "type": "string" }, "description": { "type": "string", "description": "Optional. Description of the `Automation`. Max length is 255 characters." }, "serviceAccount": { "type": "string", "description": "Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources." }, "labels": { "description": "Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be \u003c= 63 characters.", "type": "object", "additionalProperties": { "type": "string" } }, "name": { "description": "Output only. Name of the `Automation`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}`.", "readOnly": true, "type": "string" }, "etag": { "description": "Optional. The weak etag of the `Automation` resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, "createTime": { "description": "Output only. Time at which the automation was created.", "readOnly": true, "format": "google-datetime", "type": "string" } }, "type": "object", "id": "Automation" }, "Strategy": { "properties": { "canary": { "$ref": "Canary", "description": "Optional. Canary deployment strategy provides progressive percentage based deployments to a Target." }, "standard": { "description": "Optional. Standard deployment strategy executes a single deploy and allows verifying the deployment.", "$ref": "Standard" } }, "id": "Strategy", "description": "Strategy contains deployment strategy information.", "type": "object" }, "TimeOfDay": { "id": "TimeOfDay", "type": "object", "properties": { "minutes": { "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "type": "integer", "format": "int32" }, "seconds": { "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "type": "integer", "format": "int32" }, "nanos": { "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "type": "integer", "format": "int32" }, "hours": { "type": "integer", "format": "int32", "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time." } }, "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`." }, "AdvanceChildRolloutJobRun": { "id": "AdvanceChildRolloutJobRun", "type": "object", "properties": { "rolloutPhaseId": { "readOnly": true, "description": "Output only. the ID of the ChildRollout's Phase.", "type": "string" }, "rollout": { "readOnly": true, "description": "Output only. Name of the `ChildRollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.", "type": "string" } }, "description": "AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout `JobRun`." }, "ExecutionConfig": { "type": "object", "properties": { "usages": { "items": { "type": "string", "enum": [ "EXECUTION_ENVIRONMENT_USAGE_UNSPECIFIED", "RENDER", "DEPLOY", "VERIFY", "PREDEPLOY", "POSTDEPLOY", "ANALYSIS" ], "enumDescriptions": [ "Default value. This value is unused.", "Use for rendering.", "Use for deploying and deployment hooks.", "Use for deployment verification.", "Use for predeploy job execution.", "Use for postdeploy job execution.", "Use for analysis job execution." ] }, "description": "Required. Usages when this configuration should be applied.", "type": "array" }, "verbose": { "description": "Optional. If true, additional logging will be enabled when running builds in this execution environment.", "type": "boolean" }, "workerPool": { "description": "Optional. The resource name of the `WorkerPool`, with the format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. If this optional field is unspecified, the default Cloud Build pool will be used.", "type": "string" }, "defaultPool": { "$ref": "DefaultPool", "description": "Optional. Use default Cloud Build pool." }, "serviceAccount": { "description": "Optional. Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) is used.", "type": "string" }, "executionTimeout": { "format": "google-duration", "description": "Optional. Execution timeout for a Cloud Build Execution. This must be between 10m and 24h in seconds format. If unspecified, a default timeout of 1h is used.", "type": "string" }, "privatePool": { "description": "Optional. Use private Cloud Build pool.", "$ref": "PrivatePool" }, "artifactStorage": { "description": "Optional. Cloud Storage location in which to store execution outputs. This can either be a bucket (\"gs://my-bucket\") or a path within a bucket (\"gs://my-bucket/my-dir\"). If unspecified, a default bucket located in the same region will be used.", "type": "string" } }, "id": "ExecutionConfig", "description": "Configuration of the environment to use when calling Skaffold." }, "DeployJob": { "id": "DeployJob", "type": "object", "properties": {}, "description": "A deploy Job." }, "CancelRolloutResponse": { "properties": {}, "description": "The response object from `CancelRollout`.", "id": "CancelRolloutResponse", "type": "object" }, "ReleaseNotificationEvent": { "description": "Payload proto for \"clouddeploy.googleapis.com/release_notification\" Platform Log event that describes the failure to send release status change Pub/Sub notification.", "type": "object", "id": "ReleaseNotificationEvent", "properties": { "releaseUid": { "type": "string", "description": "Unique identifier of the `Release`." }, "release": { "type": "string", "description": "The name of the `Release`." }, "pipelineUid": { "type": "string", "description": "Unique identifier of the `DeliveryPipeline`." }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_PUBSUB_NOTIFICATION_FAILURE", "TYPE_RESOURCE_STATE_CHANGE", "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ false, false, false, false, false, false, false, false, true ], "description": "Type of this notification, e.g. for a Pub/Sub failure.", "enumDescriptions": [ "Type is unspecified.", "A Pub/Sub notification failed to be sent.", "Resource state changed.", "A process aborted.", "Restriction check failed.", "Resource deleted.", "Rollout updated.", "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ] }, "message": { "type": "string", "description": "Debug message for when a notification fails to send." } } }, "ToolVersionSupportedCondition": { "description": "ToolVersionSupportedCondition contains information about when support for the release's version of a tool ends.", "properties": { "toolVersionSupportState": { "type": "string", "enum": [ "TOOL_VERSION_SUPPORT_STATE_UNSPECIFIED", "TOOL_VERSION_SUPPORT_STATE_SUPPORTED", "TOOL_VERSION_SUPPORT_STATE_MAINTENANCE_MODE", "TOOL_VERSION_SUPPORT_STATE_UNSUPPORTED" ], "description": "Output only. The tool support state for this release's version of the tool.", "enumDescriptions": [ "Default value. This value is unused.", "This tool version is currently supported.", "This tool version is in maintenance mode.", "This tool version is no longer supported." ], "readOnly": true }, "supportExpirationTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time at which this release's version of the tool will no longer be supported." }, "status": { "readOnly": true, "type": "boolean", "description": "Output only. True if the version of Tool used by this release is supported." }, "maintenanceModeTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time at which this release's version of the tool will enter maintenance mode.", "readOnly": true } }, "id": "ToolVersionSupportedCondition", "type": "object" }, "AdvanceChildRolloutJob": { "id": "AdvanceChildRolloutJob", "properties": {}, "type": "object", "description": "An advanceChildRollout Job." }, "SkaffoldVersion": { "properties": { "maintenanceModeTime": { "type": "string", "description": "The time at which this version of Skaffold will enter maintenance mode.", "format": "google-datetime" }, "version": { "type": "string", "description": "Release version number. For example, \"1.20.3\"." }, "supportEndDate": { "$ref": "Date", "description": "Date when this version is expected to no longer be supported." }, "supportExpirationTime": { "type": "string", "format": "google-datetime", "description": "The time at which this version of Skaffold will no longer be supported." } }, "description": "Details of a supported Skaffold version.", "id": "SkaffoldVersion", "type": "object" }, "TimedPromoteReleaseRule": { "type": "object", "id": "TimedPromoteReleaseRule", "properties": { "condition": { "$ref": "AutomationRuleCondition", "readOnly": true, "description": "Output only. Information around the state of the Automation rule." }, "schedule": { "type": "string", "description": "Required. Schedule in crontab format. e.g. \"0 9 * * 1\" for every Monday at 9am." }, "timeZone": { "type": "string", "description": "Required. The time zone in IANA format [IANA Time Zone Database](https://www.iana.org/time-zones) (e.g. America/New_York)." }, "destinationPhase": { "description": "Optional. The starting phase of the rollout created by this rule. Default to the first phase.", "type": "string" }, "destinationTargetId": { "description": "Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name * \"@next\", the next target in the promotion sequence", "type": "string" }, "id": { "type": "string", "description": "Required. ID of the rule. This ID must be unique in the `Automation` resource to which this rule belongs. The format is `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`." } }, "description": "The `TimedPromoteReleaseRule` will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule." }, "ListAutomationsResponse": { "description": "The response object from `ListAutomations`.", "properties": { "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "automations": { "type": "array", "description": "The `Automation` objects.", "items": { "$ref": "Automation" } } }, "id": "ListAutomationsResponse", "type": "object" }, "WeeklyWindow": { "id": "WeeklyWindow", "properties": { "daysOfWeek": { "description": "Optional. Days of week. If left empty, all days of the week will be included.", "type": "array", "items": { "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string", "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } }, "endTime": { "description": "Optional. End time (exclusive). Use 24:00 to indicate midnight. If you specify end_time you must also specify start_time. If left empty, this will block for the entire day for the days specified in days_of_week.", "$ref": "TimeOfDay" }, "startTime": { "description": "Optional. Start time (inclusive). Use 00:00 for the beginning of the day. If you specify start_time you must also specify end_time. If left empty, this will block for the entire day for the days specified in days_of_week.", "$ref": "TimeOfDay" } }, "description": "Weekly windows. For example, blocking actions every Saturday and Sunday. Another example would be blocking actions every weekday from 5pm to midnight.", "type": "object" }, "AutomationResourceSelector": { "properties": { "targets": { "type": "array", "items": { "$ref": "TargetAttribute" }, "description": "Optional. Contains attributes about a target." } }, "type": "object", "id": "AutomationResourceSelector", "description": "AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied." }, "DeployPolicyEvaluationEvent": { "properties": { "message": { "type": "string", "description": "Debug message for when a deploy policy event occurs." }, "overrides": { "type": "array", "description": "Things that could have overridden the policy verdict. Overrides together with verdict decide whether the request is allowed.", "items": { "enumDescriptions": [ "This should never happen.", "The policy was overridden.", "The policy was suspended." ], "type": "string", "enum": [ "POLICY_VERDICT_OVERRIDE_UNSPECIFIED", "POLICY_OVERRIDDEN", "POLICY_SUSPENDED" ] } }, "allowed": { "description": "Whether the request is allowed. Allowed is set as true if: (1) the request complies with the policy; or (2) the request doesn't comply with the policy but the policy was overridden; or (3) the request doesn't comply with the policy but the policy was suspended", "type": "boolean" }, "verdict": { "enumDescriptions": [ "This should never happen.", "Allowed by policy. This enum value is not currently used but may be used in the future. Currently logs are only generated when a request is denied by policy.", "Denied by policy." ], "type": "string", "enum": [ "POLICY_VERDICT_UNSPECIFIED", "ALLOWED_BY_POLICY", "DENIED_BY_POLICY" ], "description": "The policy verdict of the request." }, "deployPolicyUid": { "type": "string", "description": "Unique identifier of the `DeployPolicy`." }, "rule": { "type": "string", "description": "Rule id." }, "deliveryPipeline": { "type": "string", "description": "The name of the `Delivery Pipeline`." }, "targetUid": { "description": "Unique identifier of the `Target`. This is an optional field, as a `Target` may not always be applicable to a policy.", "type": "string" }, "pipelineUid": { "type": "string", "description": "Unique identifier of the `Delivery Pipeline`." }, "deployPolicy": { "description": "The name of the `DeployPolicy`.", "type": "string" }, "target": { "type": "string", "description": "The name of the `Target`. This is an optional field, as a `Target` may not always be applicable to a policy." }, "ruleType": { "type": "string", "description": "Rule type (e.g. Restrict Rollouts)." }, "invoker": { "type": "string", "enum": [ "INVOKER_UNSPECIFIED", "USER", "DEPLOY_AUTOMATION" ], "description": "What invoked the action (e.g. a user or automation).", "enumDescriptions": [ "Unspecified.", "The action is user-driven. For example, creating a rollout manually via a gcloud create command.", "Automated action by Cloud Deploy." ] } }, "type": "object", "description": "Payload proto for \"clouddeploy.googleapis.com/deploypolicy_evaluation\" Platform Log event that describes the deploy policy evaluation event.", "id": "DeployPolicyEvaluationEvent" }, "Expr": { "id": "Expr", "properties": { "title": { "type": "string", "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." }, "location": { "type": "string", "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file." }, "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "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." } }, "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.", "type": "object" }, "ListReleasesResponse": { "description": "The response object from `ListReleases`.", "type": "object", "id": "ListReleasesResponse", "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "releases": { "type": "array", "description": "The `Release` objects.", "items": { "$ref": "Release" } }, "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } } } }, "RollbackAttempt": { "type": "object", "description": "RollbackAttempt represents an action of rolling back a Cloud Deploy 'Target'.", "id": "RollbackAttempt", "properties": { "rolloutId": { "description": "Output only. ID of the rollback `Rollout` to create.", "type": "string", "readOnly": true }, "stateDesc": { "type": "string", "readOnly": true, "description": "Output only. Description of the state of the Rollback." }, "state": { "description": "Output only. Valid state of this rollback action.", "type": "string", "enum": [ "REPAIR_STATE_UNSPECIFIED", "REPAIR_STATE_SUCCEEDED", "REPAIR_STATE_CANCELLED", "REPAIR_STATE_FAILED", "REPAIR_STATE_IN_PROGRESS", "REPAIR_STATE_PENDING", "REPAIR_STATE_ABORTED" ], "readOnly": true, "enumDescriptions": [ "The `repair` has an unspecified state.", "The `repair` action has succeeded.", "The `repair` action was cancelled.", "The `repair` action has failed.", "The `repair` action is in progress.", "The `repair` action is pending.", "The `repair` action was aborted." ] }, "disableRollbackIfRolloutPending": { "description": "Output only. If active rollout exists on the target, abort this rollback.", "readOnly": true, "type": "boolean" }, "destinationPhase": { "type": "string", "description": "Output only. The phase to which the rollout will be rolled back to.", "readOnly": true } } }, "ReleaseRenderEvent": { "id": "ReleaseRenderEvent", "properties": { "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_PUBSUB_NOTIFICATION_FAILURE", "TYPE_RESOURCE_STATE_CHANGE", "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDescriptions": [ "Type is unspecified.", "A Pub/Sub notification failed to be sent.", "Resource state changed.", "A process aborted.", "Restriction check failed.", "Resource deleted.", "Rollout updated.", "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "description": "Type of this notification, e.g. for a release render state change event.", "enumDeprecated": [ false, false, false, false, false, false, false, false, true ] }, "release": { "type": "string", "description": "The name of the release. release_uid is not in this log message because we write some of these log messages at release creation time, before we've generated the uid." }, "message": { "type": "string", "description": "Debug message for when a render transition occurs. Provides further details as rendering progresses through render states." }, "releaseRenderState": { "description": "The state of the release render.", "type": "string", "enum": [ "RENDER_STATE_UNSPECIFIED", "SUCCEEDED", "FAILED", "IN_PROGRESS" ], "enumDescriptions": [ "The render state is unspecified.", "All rendering operations have completed successfully.", "All rendering operations have completed, and one or more have failed.", "Rendering has started and is not complete." ] }, "pipelineUid": { "description": "Unique identifier of the `DeliveryPipeline`.", "type": "string" } }, "description": "Payload proto for \"clouddeploy.googleapis.com/release_render\" Platform Log event that describes the render status change.", "type": "object" }, "RetryPhase": { "description": "RetryPhase contains the retry attempts and the metadata for initiating a new attempt.", "type": "object", "id": "RetryPhase", "properties": { "totalAttempts": { "description": "Output only. The number of attempts that have been made.", "type": "string", "format": "int64", "readOnly": true }, "backoffMode": { "description": "Output only. The pattern of how the wait time of the retry attempt is calculated.", "enumDescriptions": [ "No WaitMode is specified.", "Increases the wait time linearly.", "Increases the wait time exponentially." ], "readOnly": true, "type": "string", "enum": [ "BACKOFF_MODE_UNSPECIFIED", "BACKOFF_MODE_LINEAR", "BACKOFF_MODE_EXPONENTIAL" ] }, "attempts": { "description": "Output only. Detail of a retry action.", "readOnly": true, "type": "array", "items": { "$ref": "RetryAttempt" } } } }, "CancelAutomationRunResponse": { "id": "CancelAutomationRunResponse", "properties": {}, "type": "object", "description": "The response object from `CancelAutomationRun`." }, "ApproveRolloutRequest": { "description": "The request object used by `ApproveRollout`.", "id": "ApproveRolloutRequest", "properties": { "approved": { "type": "boolean", "description": "Required. True = approve; false = reject" }, "overrideDeployPolicy": { "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Analysis": { "properties": { "googleCloud": { "$ref": "GoogleCloudAnalysis", "description": "Optional. Google Cloud - based analysis checks." }, "duration": { "description": "Required. The amount of time in minutes the analysis on the target will last. If all analysis checks have successfully completed before the specified duration, the analysis is successful. If a check is still running while the specified duration passes, it will wait for that check to complete to determine if the analysis is successful. The maximum duration is 48 hours.", "format": "google-duration", "type": "string" }, "customChecks": { "type": "array", "items": { "$ref": "CustomCheck" }, "description": "Optional. Custom analysis checks from 3P metric providers." } }, "id": "Analysis", "type": "object", "description": "Analysis contains the configuration for the set of analyses to be performed on the target." }, "ReleaseCondition": { "properties": { "kubectlVersionSupportedCondition": { "description": "Output only. Details around the support state of the release's Kubectl version.", "$ref": "ToolVersionSupportedCondition", "readOnly": true }, "releaseReadyCondition": { "description": "Details around the Releases's overall status.", "$ref": "ReleaseReadyCondition" }, "skaffoldVersionSupportedCondition": { "readOnly": true, "$ref": "ToolVersionSupportedCondition", "description": "Output only. Details around the support state of the release's Skaffold version." }, "helmVersionSupportedCondition": { "$ref": "ToolVersionSupportedCondition", "description": "Output only. Details around the support state of the release's Helm version.", "readOnly": true }, "kustomizeVersionSupportedCondition": { "readOnly": true, "$ref": "ToolVersionSupportedCondition", "description": "Output only. Details around the support state of the release's Kustomize version." }, "kptVersionSupportedCondition": { "$ref": "ToolVersionSupportedCondition", "readOnly": true, "description": "Output only. Details around the support state of the release's kpt version." }, "skaffoldSupportedCondition": { "$ref": "SkaffoldSupportedCondition", "description": "Details around the support state of the release's Skaffold version." }, "dockerVersionSupportedCondition": { "readOnly": true, "$ref": "ToolVersionSupportedCondition", "description": "Output only. Details around the support state of the release's Docker version." } }, "type": "object", "description": "ReleaseCondition contains all conditions relevant to a Release.", "id": "ReleaseCondition" }, "Location": { "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}" }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata. For example the available capacity at the given location." }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" } }, "id": "Location" }, "OneTimeWindow": { "description": "One-time window within which actions are restricted. For example, blocking actions over New Year's Eve from December 31st at 5pm to January 1st at 9am.", "properties": { "endDate": { "description": "Required. End date.", "$ref": "Date" }, "endTime": { "$ref": "TimeOfDay", "description": "Required. End time (exclusive). You may use 24:00 for the end of the day." }, "startTime": { "description": "Required. Start time (inclusive). Use 00:00 for the beginning of the day.", "$ref": "TimeOfDay" }, "startDate": { "$ref": "Date", "description": "Required. Start date." } }, "id": "OneTimeWindow", "type": "object" }, "RepairRolloutRule": { "properties": { "repairPhases": { "items": { "$ref": "RepairPhaseConfig" }, "description": "Required. Defines the types of automatic repair phases for failed jobs.", "type": "array" }, "condition": { "readOnly": true, "description": "Output only. Information around the state of the 'Automation' rule.", "$ref": "AutomationRuleCondition" }, "phases": { "type": "array", "items": { "type": "string" }, "description": "Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`." }, "id": { "description": "Required. ID of the rule. This id must be unique in the `Automation` resource to which this rule belongs. The format is `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.", "type": "string" }, "jobs": { "description": "Optional. Jobs to repair. Proceeds only after job name matched any one in the list, or for all jobs if unspecified or empty. The phase that includes the job must match the phase ID specified in `source_phase`. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", "type": "array", "items": { "type": "string" } } }, "description": "The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`.", "id": "RepairRolloutRule", "type": "object" }, "AlertPolicyCheck": { "description": "AlertPolicyCheck configures a set of Cloud Monitoring alerting policies that will be periodically polled for alerts. If any of the listed policies have an active alert, the analysis check will fail.", "properties": { "alertPolicies": { "description": "Required. The Cloud Monitoring Alert Policies to check for active alerts. Format is `projects/{project}/alertPolicies/{alert_policy}`.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Required. The ID of the analysis check.", "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. A set of labels to filter active alerts. If set, only alerts having all of the specified labels will be considered. Otherwise, all active alerts will be considered." } }, "id": "AlertPolicyCheck", "type": "object" }, "JobRun": { "description": "A `JobRun` resource in the Cloud Deploy API. A `JobRun` contains information of a single `Rollout` job evaluation.", "properties": { "createChildRolloutJobRun": { "description": "Output only. Information specific to a createChildRollout `JobRun`.", "$ref": "CreateChildRolloutJobRun", "readOnly": true }, "startTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Time at which the `JobRun` was started.", "type": "string" }, "etag": { "description": "Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string", "readOnly": true }, "name": { "readOnly": true, "type": "string", "description": "Output only. Name of the `JobRun`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}`." }, "jobId": { "type": "string", "description": "Output only. ID of the `Rollout` job this `JobRun` corresponds to.", "readOnly": true }, "analysisJobRun": { "$ref": "AnalysisJobRun", "readOnly": true, "description": "Output only. Information specific to an analysis `JobRun`." }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. Time at which the `JobRun` was created.", "readOnly": true }, "state": { "enumDescriptions": [ "The `JobRun` has an unspecified state.", "The `JobRun` is in progress.", "The `JobRun` has succeeded.", "The `JobRun` has failed.", "The `JobRun` is terminating.", "The `JobRun` was terminated." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "TERMINATING", "TERMINATED" ], "readOnly": true, "description": "Output only. The current state of the `JobRun`." }, "phaseId": { "readOnly": true, "description": "Output only. ID of the `Rollout` phase this `JobRun` belongs in.", "type": "string" }, "verifyJobRun": { "$ref": "VerifyJobRun", "description": "Output only. Information specific to a verify `JobRun`.", "readOnly": true }, "predeployJobRun": { "description": "Output only. Information specific to a predeploy `JobRun`.", "$ref": "PredeployJobRun", "readOnly": true }, "advanceChildRolloutJobRun": { "description": "Output only. Information specific to an advanceChildRollout `JobRun`", "readOnly": true, "$ref": "AdvanceChildRolloutJobRun" }, "uid": { "description": "Output only. Unique identifier of the `JobRun`.", "type": "string", "readOnly": true }, "deployJobRun": { "readOnly": true, "description": "Output only. Information specific to a deploy `JobRun`.", "$ref": "DeployJobRun" }, "postdeployJobRun": { "$ref": "PostdeployJobRun", "description": "Output only. Information specific to a postdeploy `JobRun`.", "readOnly": true }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. Time at which the `JobRun` ended.", "readOnly": true } }, "id": "JobRun", "type": "object" }, "IgnoreJobRequest": { "type": "object", "description": "The request object used by `IgnoreJob`.", "id": "IgnoreJobRequest", "properties": { "jobId": { "description": "Required. The job ID for the Job to ignore.", "type": "string" }, "overrideDeployPolicy": { "type": "array", "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.", "items": { "type": "string" } }, "phaseId": { "description": "Required. The phase ID the Job to ignore belongs to.", "type": "string" } } }, "PrivatePool": { "description": "Execution using a private Cloud Build pool.", "id": "PrivatePool", "properties": { "workerPool": { "description": "Required. Resource name of the Cloud Build worker pool to use. The format is `projects/{project}/locations/{location}/workerPools/{pool}`.", "type": "string" }, "artifactStorage": { "description": "Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket (\"gs://my-bucket\") or a path within a bucket (\"gs://my-bucket/my-dir\"). If unspecified, a default bucket located in the same region will be used.", "type": "string" }, "serviceAccount": { "type": "string", "description": "Optional. Google service account to use for execution. If unspecified, the project execution service account (-compute@developer.gserviceaccount.com) will be used." } }, "type": "object" }, "AuditLogConfig": { "type": "object", "properties": { "exemptedMembers": { "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "type": "array", "items": { "type": "string" } }, "logType": { "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" ], "description": "The log type that this config enables." } }, "id": "AuditLogConfig", "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." }, "CloudRunLocation": { "type": "object", "properties": { "location": { "type": "string", "description": "Required. The location for the Cloud Run Service. Format must be `projects/{project}/locations/{location}`." } }, "id": "CloudRunLocation", "description": "Information specifying where to deploy a Cloud Run Service." }, "ListDeployPoliciesResponse": { "description": "The response object from `ListDeployPolicies`.", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "deployPolicies": { "items": { "$ref": "DeployPolicy" }, "description": "The `DeployPolicy` objects.", "type": "array" }, "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Locations that could not be reached." } }, "id": "ListDeployPoliciesResponse" }, "RetryAttempt": { "type": "object", "description": "RetryAttempt represents an action of retrying the failed Cloud Deploy job.", "id": "RetryAttempt", "properties": { "stateDesc": { "readOnly": true, "description": "Output only. Description of the state of the Retry.", "type": "string" }, "attempt": { "readOnly": true, "type": "string", "description": "Output only. The index of this retry attempt.", "format": "int64" }, "state": { "enumDescriptions": [ "The `repair` has an unspecified state.", "The `repair` action has succeeded.", "The `repair` action was cancelled.", "The `repair` action has failed.", "The `repair` action is in progress.", "The `repair` action is pending.", "The `repair` action was aborted." ], "readOnly": true, "type": "string", "enum": [ "REPAIR_STATE_UNSPECIFIED", "REPAIR_STATE_SUCCEEDED", "REPAIR_STATE_CANCELLED", "REPAIR_STATE_FAILED", "REPAIR_STATE_IN_PROGRESS", "REPAIR_STATE_PENDING", "REPAIR_STATE_ABORTED" ], "description": "Output only. Valid state of this retry action." }, "wait": { "description": "Output only. How long the operation will be paused.", "readOnly": true, "type": "string", "format": "google-duration" } } }, "BuildArtifact": { "id": "BuildArtifact", "type": "object", "description": "Description of an a image to use during Skaffold rendering.", "properties": { "tag": { "description": "Optional. Image tag to use. This will generally be the full path to an image, such as \"gcr.io/my-project/busybox:1.2.3\" or \"gcr.io/my-project/busybox@sha256:abc123\".", "type": "string" }, "image": { "description": "Optional. Image name in Skaffold configuration.", "type": "string" } } }, "CustomTargetTypeNotificationEvent": { "id": "CustomTargetTypeNotificationEvent", "type": "object", "description": "Payload proto for \"clouddeploy.googleapis.com/customtargettype_notification\" Platform Log event that describes the failure to send a custom target type status change Pub/Sub notification.", "properties": { "customTargetType": { "type": "string", "description": "The name of the `CustomTargetType`." }, "type": { "enumDeprecated": [ false, false, false, false, false, false, false, false, true ], "description": "Type of this notification, e.g. for a Pub/Sub failure.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_PUBSUB_NOTIFICATION_FAILURE", "TYPE_RESOURCE_STATE_CHANGE", "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDescriptions": [ "Type is unspecified.", "A Pub/Sub notification failed to be sent.", "Resource state changed.", "A process aborted.", "Restriction check failed.", "Resource deleted.", "Rollout updated.", "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ] }, "customTargetTypeUid": { "type": "string", "description": "Unique identifier of the `CustomTargetType`." }, "message": { "type": "string", "description": "Debug message for when a notification fails to send." } } }, "Canary": { "id": "Canary", "type": "object", "properties": { "customCanaryDeployment": { "description": "Optional. Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.", "$ref": "CustomCanaryDeployment" }, "canaryDeployment": { "$ref": "CanaryDeployment", "description": "Optional. Configures the progressive based deployment for a Target." }, "runtimeConfig": { "description": "Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.", "$ref": "RuntimeConfig" } }, "description": "Canary represents the canary deployment strategy." }, "AutomationEvent": { "id": "AutomationEvent", "description": "Payload proto for \"clouddeploy.googleapis.com/automation\" Platform Log event that describes the Automation related events.", "type": "object", "properties": { "type": { "description": "Type of this notification, e.g. for a Pub/Sub failure.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_PUBSUB_NOTIFICATION_FAILURE", "TYPE_RESOURCE_STATE_CHANGE", "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ false, false, false, false, false, false, false, false, true ], "enumDescriptions": [ "Type is unspecified.", "A Pub/Sub notification failed to be sent.", "Resource state changed.", "A process aborted.", "Restriction check failed.", "Resource deleted.", "Rollout updated.", "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ] }, "pipelineUid": { "description": "Unique identifier of the `DeliveryPipeline`.", "type": "string" }, "message": { "description": "Debug message for when there is an update on the AutomationRun. Provides further details about the resource creation or state change.", "type": "string" }, "automation": { "description": "The name of the `AutomationRun`.", "type": "string" } } }, "AutomationRun": { "description": "An `AutomationRun` resource in the Cloud Deploy API. An `AutomationRun` represents an execution instance of an automation rule.", "properties": { "automationId": { "type": "string", "readOnly": true, "description": "Output only. The ID of the automation that initiated the operation." }, "createTime": { "description": "Output only. Time at which the `AutomationRun` was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "CANCELLED", "FAILED", "IN_PROGRESS", "PENDING", "ABORTED" ], "enumDescriptions": [ "The `AutomationRun` has an unspecified state.", "The `AutomationRun` has succeeded.", "The `AutomationRun` was cancelled.", "The `AutomationRun` has failed.", "The `AutomationRun` is in progress.", "The `AutomationRun` is pending.", "The `AutomationRun` was aborted." ], "readOnly": true, "description": "Output only. Current state of the `AutomationRun`." }, "timedPromoteReleaseOperation": { "readOnly": true, "description": "Output only. Promotes a release to a specified 'Target' as defined in a Timed Promote Release rule.", "$ref": "TimedPromoteReleaseOperation" }, "waitUntilTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Earliest time the `AutomationRun` will attempt to resume. Wait-time is configured by `wait` in automation rule." }, "etag": { "description": "Output only. The weak etag of the `AutomationRun` resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string", "readOnly": true }, "uid": { "readOnly": true, "type": "string", "description": "Output only. Unique identifier of the `AutomationRun`." }, "repairRolloutOperation": { "$ref": "RepairRolloutOperation", "description": "Output only. Repairs a failed 'Rollout'.", "readOnly": true }, "name": { "description": "Output only. Name of the `AutomationRun`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.", "type": "string", "readOnly": true }, "automationSnapshot": { "readOnly": true, "$ref": "Automation", "description": "Output only. Snapshot of the Automation taken at AutomationRun creation time." }, "expireTime": { "description": "Output only. Time the `AutomationRun` expires. An `AutomationRun` expires after 14 days from its creation date.", "format": "google-datetime", "type": "string", "readOnly": true }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Time at which the automationRun was updated.", "type": "string" }, "advanceRolloutOperation": { "$ref": "AdvanceRolloutOperation", "description": "Output only. Advances a rollout to the next phase.", "readOnly": true }, "policyViolation": { "$ref": "PolicyViolation", "description": "Output only. Contains information about what policies prevented the `AutomationRun` from proceeding.", "readOnly": true }, "serviceAccount": { "type": "string", "description": "Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.", "readOnly": true }, "ruleId": { "description": "Output only. The ID of the automation rule that initiated the operation.", "readOnly": true, "type": "string" }, "promoteReleaseOperation": { "description": "Output only. Promotes a release to a specified 'Target'.", "readOnly": true, "$ref": "PromoteReleaseOperation" }, "targetId": { "description": "Output only. The ID of the source target that initiates the `AutomationRun`. The value of this field is the last segment of a target name.", "type": "string", "readOnly": true }, "stateDescription": { "type": "string", "description": "Output only. Explains the current state of the `AutomationRun`. Present only when an explanation is needed.", "readOnly": true } }, "id": "AutomationRun", "type": "object" }, "VerifyJobRunMetadata": { "id": "VerifyJobRunMetadata", "type": "object", "properties": { "custom": { "description": "Output only. Custom metadata provided by user-defined verify operation.", "readOnly": true, "$ref": "CustomMetadata" } }, "description": "VerifyJobRunMetadata contains metadata about the verify `JobRun`." }, "AbandonReleaseResponse": { "id": "AbandonReleaseResponse", "type": "object", "properties": {}, "description": "The response object for `AbandonRelease`." }, "DeploymentJobs": { "type": "object", "description": "Deployment job composition.", "id": "DeploymentJobs", "properties": { "analysisJob": { "readOnly": true, "description": "Output only. The analysis Job. Runs after a verify if there is a verify job and the verify job succeeds.", "$ref": "Job" }, "postdeployJob": { "description": "Output only. The postdeploy Job, which is the last job on the phase.", "readOnly": true, "$ref": "Job" }, "verifyJob": { "readOnly": true, "description": "Output only. The verify Job. Runs after a deploy if the deploy succeeds.", "$ref": "Job" }, "deployJob": { "description": "Output only. The deploy Job. This is the deploy job in the phase.", "readOnly": true, "$ref": "Job" }, "predeployJob": { "description": "Output only. The predeploy Job, which is the first job on the phase.", "readOnly": true, "$ref": "Job" } } }, "GoogleCloudAnalysis": { "description": "GoogleCloudAnalysis is a set of Google Cloud-based checks to perform on the deployment.", "type": "object", "properties": { "alertPolicyChecks": { "type": "array", "description": "Optional. A list of Cloud Monitoring Alert Policy checks to perform as part of the analysis.", "items": { "$ref": "AlertPolicyCheck" } } }, "id": "GoogleCloudAnalysis" }, "VerifyJobRun": { "properties": { "failureCause": { "readOnly": true, "type": "string", "enum": [ "FAILURE_CAUSE_UNSPECIFIED", "CLOUD_BUILD_UNAVAILABLE", "EXECUTION_FAILED", "DEADLINE_EXCEEDED", "VERIFICATION_CONFIG_NOT_FOUND", "CLOUD_BUILD_REQUEST_FAILED" ], "enumDescriptions": [ "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The verify operation did not complete successfully; check Cloud Build logs.", "The verify job run did not complete within the allotted time.", "No Skaffold verify configuration was found.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details." ], "description": "Output only. The reason the verify failed. This will always be unspecified while the verify is in progress or if it succeeded." }, "artifactUri": { "type": "string", "description": "Output only. URI of a directory containing the verify artifacts. This contains the Skaffold event log.", "readOnly": true }, "eventLogPath": { "readOnly": true, "description": "Output only. File path of the Skaffold event log relative to the artifact URI.", "type": "string" }, "build": { "description": "Output only. The resource name of the Cloud Build `Build` object that is used to verify. Format is `projects/{project}/locations/{location}/builds/{build}`.", "type": "string", "readOnly": true }, "failureMessage": { "readOnly": true, "type": "string", "description": "Output only. Additional information about the verify failure, if available." }, "metadata": { "$ref": "VerifyJobRunMetadata", "readOnly": true, "description": "Output only. Metadata containing information about the verify `JobRun`." } }, "id": "VerifyJobRun", "type": "object", "description": "VerifyJobRun contains information specific to a verify `JobRun`." }, "AutomationRunEvent": { "type": "object", "id": "AutomationRunEvent", "description": "Payload proto for \"clouddeploy.googleapis.com/automation_run\" Platform Log event that describes the AutomationRun related events.", "properties": { "message": { "description": "Debug message for when there is an update on the AutomationRun. Provides further details about the resource creation or state change.", "type": "string" }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_PUBSUB_NOTIFICATION_FAILURE", "TYPE_RESOURCE_STATE_CHANGE", "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "description": "Type of this notification, e.g. for a Pub/Sub failure.", "enumDescriptions": [ "Type is unspecified.", "A Pub/Sub notification failed to be sent.", "Resource state changed.", "A process aborted.", "Restriction check failed.", "Resource deleted.", "Rollout updated.", "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "enumDeprecated": [ false, false, false, false, false, false, false, false, true ] }, "destinationTargetId": { "description": "ID of the `Target` to which the `AutomationRun` is created.", "type": "string" }, "ruleId": { "description": "Identifier of the `Automation` rule.", "type": "string" }, "automationRun": { "description": "The name of the `AutomationRun`.", "type": "string" }, "automationId": { "type": "string", "description": "Identifier of the `Automation`." }, "pipelineUid": { "type": "string", "description": "Unique identifier of the `DeliveryPipeline`." } } }, "Metadata": { "id": "Metadata", "type": "object", "properties": { "custom": { "readOnly": true, "description": "Output only. Custom metadata provided by user-defined `Rollout` operations.", "$ref": "CustomMetadata" }, "automation": { "description": "Output only. AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.", "readOnly": true, "$ref": "AutomationRolloutMetadata" }, "cloudRun": { "description": "Output only. The name of the Cloud Run Service that is associated with a `Rollout`.", "readOnly": true, "$ref": "CloudRunMetadata" } }, "description": "Metadata includes information associated with a `Rollout`." }, "CreateChildRolloutJobRun": { "description": "CreateChildRolloutJobRun contains information specific to a createChildRollout `JobRun`.", "properties": { "rollout": { "type": "string", "description": "Output only. Name of the `ChildRollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.", "readOnly": true }, "rolloutPhaseId": { "readOnly": true, "type": "string", "description": "Output only. The ID of the childRollout Phase initiated by this JobRun." } }, "type": "object", "id": "CreateChildRolloutJobRun" }, "PostdeployJobRunMetadata": { "id": "PostdeployJobRunMetadata", "type": "object", "properties": { "custom": { "description": "Output only. Custom metadata provided by user-defined postdeploy operation.", "readOnly": true, "$ref": "CustomMetadata" } }, "description": "PostdeployJobRunMetadata contains metadata about the postdeploy `JobRun`." }, "PhaseArtifact": { "type": "object", "description": "Contains the paths to the artifacts, relative to the URI, for a phase.", "properties": { "manifestPath": { "description": "Output only. File path of the rendered manifest relative to the URI.", "readOnly": true, "type": "string" }, "jobManifestsPath": { "description": "Output only. File path of the directory of rendered job manifests relative to the URI. This is only set if it is applicable.", "type": "string", "readOnly": true }, "skaffoldConfigPath": { "type": "string", "description": "Output only. File path of the resolved Skaffold configuration relative to the URI.", "readOnly": true } }, "id": "PhaseArtifact" }, "PolicyViolationDetails": { "type": "object", "id": "PolicyViolationDetails", "properties": { "policy": { "description": "Name of the policy that was violated. Policy resource will be in the format of `projects/{project}/locations/{location}/policies/{policy}`.", "type": "string" }, "ruleId": { "type": "string", "description": "Id of the rule that triggered the policy violation." }, "failureMessage": { "type": "string", "description": "User readable message about why the request violated a policy. This is not intended for machine parsing." } }, "description": "Policy violation details." }, "Empty": { "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); }", "id": "Empty", "type": "object" }, "GatewayServiceMesh": { "type": "object", "properties": { "service": { "description": "Required. Name of the Kubernetes Service.", "type": "string" }, "httpRoute": { "description": "Required. Name of the Gateway API HTTPRoute.", "type": "string" }, "podSelectorLabel": { "description": "Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources.", "type": "string" }, "routeDestinations": { "$ref": "RouteDestinations", "description": "Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster." }, "routeUpdateWaitTime": { "type": "string", "format": "google-duration", "description": "Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time." }, "stableCutbackDuration": { "description": "Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time.", "format": "google-duration", "type": "string" }, "deployment": { "description": "Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service.", "type": "string" } }, "id": "GatewayServiceMesh", "description": "Information about the Kubernetes Gateway API service mesh configuration." }, "Task": { "description": "A Task represents a unit of work that is executed as part of a Job.", "type": "object", "properties": { "container": { "description": "Optional. This task is represented by a container that is executed in the Cloud Build execution environment.", "$ref": "ContainerTask" } }, "id": "Task" }, "ReleaseReadyCondition": { "properties": { "status": { "description": "True if the Release is in a valid state. Otherwise at least one condition in `ReleaseCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Release.", "type": "boolean" } }, "description": "ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release.", "id": "ReleaseReadyCondition", "type": "object" }, "CloudRunConfig": { "description": "CloudRunConfig contains the Cloud Run runtime configuration.", "type": "object", "properties": { "automaticTrafficControl": { "type": "boolean", "description": "Optional. Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments." }, "priorRevisionTags": { "items": { "type": "string" }, "description": "Optional. A list of tags that are added to the prior revision while the canary phase is in progress.", "type": "array" }, "canaryRevisionTags": { "type": "array", "description": "Optional. A list of tags that are added to the canary revision while the canary phase is in progress.", "items": { "type": "string" } }, "stableRevisionTags": { "description": "Optional. A list of tags that are added to the final stable revision when the stable phase is applied.", "items": { "type": "string" }, "type": "array" } }, "id": "CloudRunConfig" }, "ContainerTask": { "type": "object", "description": "This task is represented by a container that is executed in the Cloud Build execution environment.", "id": "ContainerTask", "properties": { "image": { "description": "Required. Image is the container image to use.", "type": "string" }, "args": { "description": "Optional. Args is the container arguments to use. This overrides the default arguments defined in the container image.", "type": "array", "items": { "type": "string" } }, "env": { "description": "Optional. Environment variables that are set in the container.", "additionalProperties": { "type": "string" }, "type": "object" }, "command": { "items": { "type": "string" }, "description": "Optional. Command is the container entrypoint to use. This overrides the default entrypoint defined in the container image.", "type": "array" } } }, "SkaffoldGCSSource": { "description": "Cloud Storage bucket containing Skaffold Config modules.", "type": "object", "properties": { "source": { "type": "string", "description": "Required. Cloud Storage source paths to copy recursively. For example, providing \"gs://my-bucket/dir/configs/*\" will result in Skaffold copying all files within the \"dir/configs\" directory in the bucket \"my-bucket\"." }, "path": { "description": "Optional. Relative path from the source to the Skaffold file.", "type": "string" } }, "id": "SkaffoldGCSSource" }, "DeployJobRunMetadata": { "id": "DeployJobRunMetadata", "properties": { "custom": { "$ref": "CustomMetadata", "readOnly": true, "description": "Output only. Custom metadata provided by user-defined deploy operation." }, "customTarget": { "description": "Output only. Custom Target metadata associated with a `DeployJobRun`.", "readOnly": true, "$ref": "CustomTargetDeployMetadata" }, "cloudRun": { "description": "Output only. The name of the Cloud Run Service that is associated with a `DeployJobRun`.", "readOnly": true, "$ref": "CloudRunMetadata" } }, "type": "object", "description": "DeployJobRunMetadata surfaces information associated with a `DeployJobRun` to the user." }, "CustomTargetTasks": { "type": "object", "description": "CustomTargetTasks represents the `CustomTargetType` configuration using tasks.", "id": "CustomTargetTasks", "properties": { "render": { "$ref": "Task", "description": "Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation." }, "deploy": { "$ref": "Task", "description": "Required. The task responsible for deploy operations." } } }, "DeployPolicy": { "description": "A `DeployPolicy` resource in the Cloud Deploy API. A `DeployPolicy` inhibits manual or automation-driven actions within a Delivery Pipeline or Target.", "type": "object", "properties": { "updateTime": { "description": "Output only. Most recent time at which the deploy policy was updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "rules": { "items": { "$ref": "PolicyRule" }, "type": "array", "description": "Required. Rules to apply. At least one rule must be present." }, "uid": { "description": "Output only. Unique identifier of the `DeployPolicy`.", "readOnly": true, "type": "string" }, "annotations": { "description": "Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.", "additionalProperties": { "type": "string" }, "type": "object" }, "selectors": { "items": { "$ref": "DeployPolicyResourceSelector" }, "description": "Required. Selected resources to which the policy will be applied. At least one selector is required. If one selector matches the resource the policy applies. For example, if there are two selectors and the action being attempted matches one of them, the policy will apply to that action.", "type": "array" }, "etag": { "type": "string", "description": "The weak etag of the `DeployPolicy` resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding." }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be \u003c= 128 bytes." }, "createTime": { "description": "Output only. Time at which the deploy policy was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "name": { "readOnly": true, "description": "Output only. Name of the `DeployPolicy`. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`. The `deployPolicy` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`", "type": "string" }, "suspended": { "description": "Optional. When suspended, the policy will not prevent actions from occurring, even if the action violates the policy.", "type": "boolean" }, "description": { "description": "Optional. Description of the `DeployPolicy`. Max length is 255 characters.", "type": "string" } }, "id": "DeployPolicy" }, "RollbackTargetResponse": { "properties": { "rollbackConfig": { "$ref": "RollbackTargetConfig", "description": "The config of the rollback `Rollout` created or will be created." } }, "id": "RollbackTargetResponse", "description": "The response object from `RollbackTarget`.", "type": "object" }, "ListJobRunsResponse": { "properties": { "jobRuns": { "type": "array", "description": "The `JobRun` objects.", "items": { "$ref": "JobRun" } }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "ListJobRunsResponse", "type": "object", "description": "ListJobRunsResponse is the response object returned by `ListJobRuns`." }, "AlertPolicyCheckStatus": { "type": "object", "properties": { "labels": { "description": "Output only. The resolved labels used to filter for specific incidents.", "readOnly": true, "type": "object", "additionalProperties": { "type": "string" } }, "id": { "description": "Output only. The ID of this analysis.", "readOnly": true, "type": "string" }, "failedAlertPolicies": { "items": { "$ref": "FailedAlertPolicy" }, "description": "Output only. The alert policies that were found to be firing during this check. This will be empty if no incidents were found.", "readOnly": true, "type": "array" }, "alertPolicies": { "items": { "type": "string" }, "description": "Output only. The alert policies that this analysis monitors. Format is `projects/{project}/locations/{location}/alertPolicies/{alertPolicy}`.", "type": "array", "readOnly": true }, "failureMessage": { "readOnly": true, "description": "Output only. Additional information about the alert policy check failure, if available. This will be empty if the alert policy check succeeded.", "type": "string" } }, "id": "AlertPolicyCheckStatus", "description": "AlertPolicyCheckStatus contains information specific to a single run of an alert policy check." }, "PostdeployJobRun": { "type": "object", "description": "PostdeployJobRun contains information specific to a postdeploy `JobRun`.", "properties": { "build": { "readOnly": true, "description": "Output only. The resource name of the Cloud Build `Build` object that is used to execute the custom actions associated with the postdeploy Job. Format is `projects/{project}/locations/{location}/builds/{build}`.", "type": "string" }, "failureCause": { "enumDescriptions": [ "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The postdeploy operation did not complete successfully; check Cloud Build logs.", "The postdeploy job run did not complete within the allotted time.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details." ], "readOnly": true, "type": "string", "enum": [ "FAILURE_CAUSE_UNSPECIFIED", "CLOUD_BUILD_UNAVAILABLE", "EXECUTION_FAILED", "DEADLINE_EXCEEDED", "CLOUD_BUILD_REQUEST_FAILED" ], "description": "Output only. The reason the postdeploy failed. This will always be unspecified while the postdeploy is in progress or if it succeeded." }, "metadata": { "readOnly": true, "description": "Output only. Metadata containing information about the postdeploy `JobRun`.", "$ref": "PostdeployJobRunMetadata" }, "failureMessage": { "description": "Output only. Additional information about the postdeploy failure, if available.", "type": "string", "readOnly": true } }, "id": "PostdeployJobRun" }, "TargetRender": { "description": "Details of rendering for a single target.", "id": "TargetRender", "properties": { "renderingBuild": { "description": "Output only. The resource name of the Cloud Build `Build` object that is used to render the manifest for this target. Format is `projects/{project}/locations/{location}/builds/{build}`.", "type": "string", "readOnly": true }, "renderingState": { "type": "string", "enum": [ "TARGET_RENDER_STATE_UNSPECIFIED", "SUCCEEDED", "FAILED", "IN_PROGRESS" ], "description": "Output only. Current state of the render operation for this Target.", "readOnly": true, "enumDescriptions": [ "The render operation state is unspecified.", "The render operation has completed successfully.", "The render operation has failed.", "The render operation is in progress." ] }, "metadata": { "$ref": "RenderMetadata", "description": "Output only. Metadata related to the `Release` render for this Target.", "readOnly": true }, "failureMessage": { "type": "string", "description": "Output only. Additional information about the render failure, if available.", "readOnly": true }, "failureCause": { "enumDescriptions": [ "No reason for failure is specified.", "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The render operation did not complete successfully; check Cloud Build logs.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details.", "The render operation did not complete successfully because the verification stanza required for verify was not found on the Skaffold configuration.", "The render operation did not complete successfully because the custom action(s) required for Rollout jobs were not found in the Skaffold configuration. See failure_message for additional details.", "Release failed during rendering because the release configuration is not supported with the specified deployment strategy.", "The render operation had a feature configured that is not supported." ], "type": "string", "enum": [ "FAILURE_CAUSE_UNSPECIFIED", "CLOUD_BUILD_UNAVAILABLE", "EXECUTION_FAILED", "CLOUD_BUILD_REQUEST_FAILED", "VERIFICATION_CONFIG_NOT_FOUND", "CUSTOM_ACTION_NOT_FOUND", "DEPLOYMENT_STRATEGY_NOT_SUPPORTED", "RENDER_FEATURE_NOT_SUPPORTED" ], "description": "Output only. Reason this render failed. This will always be unspecified while the render in progress.", "readOnly": true } }, "type": "object" }, "TestIamPermissionsResponse": { "type": "object", "properties": { "permissions": { "items": { "type": "string" }, "type": "array", "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed." } }, "description": "Response message for `TestIamPermissions` method.", "id": "TestIamPermissionsResponse" }, "RepairRolloutOperation": { "type": "object", "id": "RepairRolloutOperation", "description": "Contains the information for an automated `repair rollout` operation.", "properties": { "rollout": { "readOnly": true, "description": "Output only. The name of the rollout that initiates the `AutomationRun`.", "type": "string" }, "repairPhases": { "readOnly": true, "type": "array", "items": { "$ref": "RepairPhase" }, "description": "Output only. Records of the repair attempts. Each repair phase may have multiple retry attempts or single rollback attempt." }, "phaseId": { "description": "Output only. The phase ID of the phase that includes the job being repaired.", "readOnly": true, "type": "string" }, "currentRepairPhaseIndex": { "readOnly": true, "type": "string", "description": "Output only. The index of the current repair action in the repair sequence.", "format": "int64" }, "jobId": { "type": "string", "readOnly": true, "description": "Output only. The job ID for the Job to repair." } } }, "AutomationRuleCondition": { "id": "AutomationRuleCondition", "type": "object", "properties": { "timedPromoteReleaseCondition": { "$ref": "TimedPromoteReleaseCondition", "description": "Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined." }, "targetsPresentCondition": { "$ref": "TargetsPresentCondition", "description": "Optional. Details around targets enumerated in the rule." } }, "description": "`AutomationRuleCondition` contains conditions relevant to an `Automation` rule." }, "AutomationRolloutMetadata": { "type": "object", "id": "AutomationRolloutMetadata", "description": "AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout.", "properties": { "repairAutomationRuns": { "readOnly": true, "description": "Output only. The names of the AutomationRuns initiated by a repair rollout rule.", "type": "array", "items": { "type": "string" } }, "promoteAutomationRun": { "type": "string", "description": "Output only. The name of the AutomationRun initiated by a promote release rule.", "readOnly": true }, "advanceAutomationRuns": { "readOnly": true, "description": "Output only. The names of the AutomationRuns initiated by an advance rollout rule.", "type": "array", "items": { "type": "string" } } } }, "TimedPromoteReleaseOperation": { "description": "Contains the information of an automated timed promote-release operation.", "id": "TimedPromoteReleaseOperation", "properties": { "phase": { "description": "Output only. The starting phase of the rollout created by this operation.", "type": "string", "readOnly": true }, "targetId": { "description": "Output only. The ID of the target that represents the promotion stage to which the release will be promoted. The value of this field is the last segment of a target name.", "readOnly": true, "type": "string" }, "release": { "description": "Output only. The name of the release to be promoted.", "readOnly": true, "type": "string" } }, "type": "object" }, "ListOperationsResponse": { "type": "object", "description": "The response message for Operations.ListOperations.", "properties": { "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "unreachable": { "items": { "type": "string" }, "type": "array", "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." }, "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } } }, "id": "ListOperationsResponse" } }, "title": "Cloud Deploy API", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "discoveryVersion": "v1", "batchPath": "batch", "servicePath": "", "mtlsRootUrl": "https://clouddeploy.mtls.googleapis.com/" }