Organization Policy V2 API - Module Google::Cloud::OrgPolicy::V2::OrgPolicy::Paths (v1.1.0)

Reference documentation and code samples for the Organization Policy V2 API module Google::Cloud::OrgPolicy::V2::OrgPolicy::Paths.

Path helper methods for the OrgPolicy API.

Extended By

Methods

#custom_constraint_path

def custom_constraint_path(organization:, custom_constraint:) -> ::String

Create a fully-qualified CustomConstraint resource string.

The resource will be in the following format:

organizations/{organization}/customConstraints/{custom_constraint}

Parameters
  • organization (String)
  • custom_constraint (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#folder_path

def folder_path(folder:) -> ::String

Create a fully-qualified Folder resource string.

The resource will be in the following format:

folders/{folder}

Parameter
  • folder (String)
Returns
  • (::String)

#organization_path

def organization_path(organization:) -> ::String

Create a fully-qualified Organization resource string.

The resource will be in the following format:

organizations/{organization}

Parameter
  • organization (String)
Returns
  • (::String)

#policy_path

def policy_path(project:, policy:) -> ::String
def policy_path(folder:, policy:) -> ::String
def policy_path(organization:, policy:) -> ::String

Create a fully-qualified Policy resource string.

Overloads 
def policy_path(project:, policy:) -> ::String
The resource will be in the following format:

projects/{project}/policies/{policy}

Parameters
  • project (String)
  • policy (String) 
def policy_path(folder:, policy:) -> ::String
The resource will be in the following format:

folders/{folder}/policies/{policy}

Parameters
  • folder (String)
  • policy (String) 
def policy_path(organization:, policy:) -> ::String
The resource will be in the following format:

organizations/{organization}/policies/{policy}

Parameters
  • organization (String)
  • policy (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#project_path

def project_path(project:) -> ::String

Create a fully-qualified Project resource string.

The resource will be in the following format:

projects/{project}

Parameter
  • project (String)
Returns
  • (::String)