2024-07-27
▼ ▲ clouddeploy.projects.locations.deliveryPipelines.releases.create
Parameters:
overrideDeployPolicy
Description: Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
Location: query
Repeated: Yes
Type: string
▼ ▲ clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.create
Parameters:
overrideDeployPolicy
Description: Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
Location: query
Repeated: Yes
Type: string
▼ ▲ clouddeploy.projects.locations.deployPolicies.create
Path: v1/{+parent}/deployPolicies
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployPolicies
HTTP Method: POST
Parameters:
parent
Description: Required. The parent collection in which the `DeployPolicy` must be created. The format is `projects/{project_id}/locations/{location_name}`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
deployPolicyId
Description: Required. ID of the `DeployPolicy`.
Location: query
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
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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new DeployPolicy in a given project and location.
▼ ▲ clouddeploy.projects.locations.deployPolicies.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployPolicies/{deployPoliciesId}
HTTP Method: PATCH
Parameters:
name
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])?`
Pattern: ^projects/[^/]+/locations/[^/]+/deployPolicies/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
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.
Location: query
Type: string
Format: google-fieldmask
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
allowMissing
Description: Optional. If set to true, updating a `DeployPolicy` that does not exist will result in the creation of a new `DeployPolicy`.
Location: query
Type: boolean
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
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single DeployPolicy.
▼ ▲ clouddeploy.projects.locations.deployPolicies.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployPolicies/{deployPoliciesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the `DeployPolicy` to delete. The format is `projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}`.
Pattern: ^projects/[^/]+/locations/[^/]+/deployPolicies/[^/]+$
Location: path
Required: Yes
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
allowMissing
Description: Optional. If set to true, then deleting an already deleted or non-existing `DeployPolicy` will succeed.
Location: query
Type: boolean
validateOnly
Description: Optional. If set, validate the request and preview the review, but do not actually post it.
Location: query
Type: boolean
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
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single DeployPolicy.
▼ ▲ clouddeploy.projects.locations.deployPolicies.list
Path: v1/{+parent}/deployPolicies
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployPolicies
HTTP Method: GET
Parameters:
parent
Description: Required. The parent, which owns this collection of deploy policies. Format must be `projects/{project_id}/locations/{location_name}`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
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.
Location: query
Type: integer
Format: int32
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.
Location: query
Type: string
filter
Description: Filter deploy policies to be returned. See https://google.aip.dev/160 for more details. All fields can be used in the filter.
Location: query
Type: string
orderBy
Description: Field to sort by. See https://google.aip.dev/132#ordering for more details.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists DeployPolicies in a given project and location.
▼ ▲ clouddeploy.projects.locations.deployPolicies.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployPolicies/{deployPoliciesId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the `DeployPolicy`. Format must be `projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}`.
Pattern: ^projects/[^/]+/locations/[^/]+/deployPolicies/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single DeployPolicy.