Method: googleapis.cloudresourcemanager.v1.projects.getEffectiveOrgPolicy

Preview

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Gets the effective Policy on a resource. This is the result of merging Policies in the resource hierarchy. The returned Policy will not have an etagset because it is a computed Policy across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.

Arguments

Parameters
resource	string Required. The name of the resource to start computing the effective Policy.
body	object (GetEffectiveOrgPolicyRequest) Required.

Raised exceptions

Exceptions
ConnectionError	In case of a network problem (such as DNS failure or refused connection).
HttpError	If the response status is >= 400 (excluding 429 and 503).
TimeoutError	If a long-running operation takes longer to finish than the specified timeout limit.
TypeError	If an operation or function receives an argument of the wrong type.
ValueError	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of OrgPolicy.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- getEffectiveOrgPolicy:
    call: googleapis.cloudresourcemanager.v1.projects.getEffectiveOrgPolicy
    args:
        resource: ...
        body:
            constraint: ...
    result: getEffectiveOrgPolicyResult

JSON

[
  {
    "getEffectiveOrgPolicy": {
      "call": "googleapis.cloudresourcemanager.v1.projects.getEffectiveOrgPolicy",
      "args": {
        "resource": "...",
        "body": {
          "constraint": "..."
        }
      },
      "result": "getEffectiveOrgPolicyResult"
    }
  }
]