Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1374955.2 KB
folders

Updates an existing policy orchestrator, parented by a folder.

patch/v2/{+name}

Path parameters

namestring required

Immutable. Identifier. In the following format: * organizations/{organization_id}/locations/global/policyOrchestrators/{orchestrator_id} * folders/{folder_id}/locations/global/policyOrchestrators/{orchestrator_id} * projects/{project_id_or_number}/locations/global/policyOrchestrators/{orchestrator_id}

Query parameters

updateMaskstring

Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask (or its paths) is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * google.protobuf.Any fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.

Request body

actionstring

Required. Action to be done by the orchestrator in projects/{project_id}/zones/{zone_id} locations defined by the orchestration_scope. Allowed values: - UPSERT - Orchestrator will create or update target resources. - DELETE - Orchestrator will delete target resources, if they exist

namestring

Immutable. Identifier. In the following format: * organizations/{organization_id}/locations/global/policyOrchestrators/{orchestrator_id} * folders/{folder_id}/locations/global/policyOrchestrators/{orchestrator_id} * projects/{project_id_or_number}/locations/global/policyOrchestrators/{orchestrator_id}

createTimestring google-datetime

Output only. Timestamp when the policy orchestrator resource was created.

descriptionstring

Optional. Freeform text describing the purpose of the resource.

updateTimestring google-datetime

Output only. Timestamp when the policy orchestrator resource was last modified.

etagstring

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.

labelsobject

Optional. Labels as key value pairs

reconcilingboolean

Output only. Set to true, if there are ongoing changes being applied by the orchestrator.

statestring

Optional. State of the orchestrator. Can be updated to change orchestrator behaviour. Allowed values: - ACTIVE - orchestrator is actively looking for actions to be taken. - STOPPED - orchestrator won't make any changes. Note: There might be more states added in the future. We use string here instead of an enum, to avoid the need of propagating new states to all the client code.

Response

Successful response