Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1332185209.7 KB
projects

Creates a new Target in a given project and location.

post/v1/{+parent}/targets

Path parameters

parentstring required

Required. The parent collection in which the Target must be created. The format is projects/{project_id}/locations/{location_name}.

Query parameters

requestIdstring

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).

targetIdstring

Required. ID of the Target.

validateOnlyboolean

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Request body

deployParametersobject

Optional. The deploy parameters to use for this target.

uidstring

Output only. Unique identifier of the Target.

etagstring

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.

namestring

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])?

annotationsobject

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.

createTimestring google-datetime

Output only. Time at which the Target was created.

labelsobject

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 <= 128 bytes.

associatedEntitiesobject

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])?$.

descriptionstring

Optional. Description of the Target. Max length is 255 characters.

targetIdstring

Output only. Resource id of the Target.

updateTimestring google-datetime

Output only. Most recent time at which the Target was updated.

requireApprovalboolean

Optional. Whether or not the Target requires approval.

Response

Successful response