Sign in

v1

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

Update a single Enrollment.

patch/v1/{+name}

Path parameters

namestring required

Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}

Query parameters

allowMissingboolean

Optional. If set to true, and the Enrollment is not found, a new Enrollment will be created. In this situation, update_mask is ignored.

updateMaskstring

Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*".

validateOnlyboolean

Optional. If set, validate the request and preview the review, but do not post it.

Request body

etagstring

Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.

labelsobject

Optional. Resource labels.

annotationsobject

Optional. Resource annotations.

messageBusstring

Required. Immutable. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.

displayNamestring

Optional. Resource display name.

destinationstring

Required. Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"

uidstring

Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

createTimestring google-datetime

Output only. The creation time.

namestring

Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}

updateTimestring google-datetime

Output only. The last-modified time.

celMatchstring

Required. A CEL expression identifying which messages this enrollment applies to.

Response

Successful response