v4

latestOpenAPI 3.1.0MIT2026-08-04193459793.6 KB

ShadowExperimentService

Update a shadow experiment target

Updates a shadow target's name, deployment, or description. updateMask is required and must select at least one mutable field.

patch/projects/{projectId}/endpoints/{endpointId}/shadowExperiments/{experimentId}/targets/{id}

Path parameters

projectIdstring required

Project identifier.

endpointIdstring required

Endpoint identifier.

experimentIdstring required

Shadow experiment identifier.

idstring required

Shadow experiment target identifier.

Query parameters

updateMaskstring required

Comma-separated fields to update. Supported fields are name, targetDeploymentId, and description.

Request body

namestring

Updated human-readable target name.

targetDeploymentIdstring

Replacement deployment under the parent endpoint. It must not be a live traffic-split member or the source or target of an active rollout; traffic-split weight 0 warm-up targets are allowed.

descriptionstring

Updated free-form target description.

etagstring

Opaque version tag from a prior read for optimistic concurrency.

Response

idstring required

Output only. Unique shadow experiment target identifier.

experimentIdstring required

Output only. Shadow experiment this target belongs to.

namestring required

Human-readable target name, unique within the shadow experiment. At most 256 characters.

targetDeploymentIdstring required

Deployment under the parent endpoint that receives mirrored traffic. It must not be a live traffic-split member or the source or target of an active rollout; traffic-split weight 0 warm-up targets are allowed.

descriptionstring

Optional free-form target description.

createdAtstring date-time required

Output only. Timestamp when the target was created.

updatedAtstring date-time required

Output only. Timestamp when the target was last updated.

etagstring required

Opaque version tag for optimistic concurrency control. Returned on read; set it on update or delete requests for consistent read-modify-write.