google_api_cloud_resource_manager v0.24.0 GoogleApi.CloudResourceManager.V1.Api.Folders View Source
API calls for all endpoints tagged Folders
.
Link to this section Summary
Functions
Clears a Policy
from a resource.
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 etag
set because it is a computed Policy
across multiple resources.
Subtrees of Resource Manager resource hierarchy with 'under:' prefix will
not be expanded.
Gets a Policy
on a resource.
Lists Constraints
that could be applied on the specified resource.
Lists all the Policies
set for a particular resource.
Updates the specified Policy
on the resource. Creates a new Policy
for
that Constraint
on the resource if one does not exist.
Link to this section Functions
cloudresourcemanager_folders_clear_org_policy(connection, folders_id, optional_params \\ [], opts \\ [])
View Sourcecloudresourcemanager_folders_clear_org_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
Clears a Policy
from a resource.
Parameters
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to serverfolders_id
(type:String.t
) - Part ofresource
. Name of the resource for thePolicy
to clear.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudResourceManager.V1.Model.ClearOrgPolicyRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.Empty{}}
on success{:error, info}
on failure
cloudresourcemanager_folders_get_effective_org_policy(connection, folders_id, optional_params \\ [], opts \\ [])
View Sourcecloudresourcemanager_folders_get_effective_org_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.OrgPolicy.t()} | {:error, Tesla.Env.t()}
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 etag
set because it is a computed Policy
across multiple resources.
Subtrees of Resource Manager resource hierarchy with 'under:' prefix will
not be expanded.
Parameters
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to serverfolders_id
(type:String.t
) - Part ofresource
. The name of the resource to start computing the effectivePolicy
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudResourceManager.V1.Model.GetEffectiveOrgPolicyRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.OrgPolicy{}}
on success{:error, info}
on failure
cloudresourcemanager_folders_get_org_policy(connection, folders_id, optional_params \\ [], opts \\ [])
View Sourcecloudresourcemanager_folders_get_org_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.OrgPolicy.t()} | {:error, Tesla.Env.t()}
Gets a Policy
on a resource.
If no Policy
is set on the resource, a Policy
is returned with default
values including POLICY_TYPE_NOT_SET
for the policy_type oneof
. The
etag
value can be used with SetOrgPolicy()
to create or update a
Policy
during read-modify-write.
Parameters
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to serverfolders_id
(type:String.t
) - Part ofresource
. Name of the resource thePolicy
is set on.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudResourceManager.V1.Model.GetOrgPolicyRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.OrgPolicy{}}
on success{:error, info}
on failure
cloudresourcemanager_folders_list_available_org_policy_constraints(connection, folders_id, optional_params \\ [], opts \\ [])
View Sourcecloudresourcemanager_folders_list_available_org_policy_constraints( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.ListAvailableOrgPolicyConstraintsResponse.t()} | {:error, Tesla.Env.t()}
Lists Constraints
that could be applied on the specified resource.
Parameters
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to serverfolders_id
(type:String.t
) - Part ofresource
. Name of the resource to listConstraints
for.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudResourceManager.V1.Model.ListAvailableOrgPolicyConstraintsRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.ListAvailableOrgPolicyConstraintsResponse{}}
on success{:error, info}
on failure
cloudresourcemanager_folders_list_org_policies(connection, folders_id, optional_params \\ [], opts \\ [])
View Sourcecloudresourcemanager_folders_list_org_policies( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.ListOrgPoliciesResponse.t()} | {:error, Tesla.Env.t()}
Lists all the Policies
set for a particular resource.
Parameters
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to serverfolders_id
(type:String.t
) - Part ofresource
. Name of the resource to list Policies for.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudResourceManager.V1.Model.ListOrgPoliciesRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.ListOrgPoliciesResponse{}}
on success{:error, info}
on failure
cloudresourcemanager_folders_set_org_policy(connection, folders_id, optional_params \\ [], opts \\ [])
View Sourcecloudresourcemanager_folders_set_org_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.OrgPolicy.t()} | {:error, Tesla.Env.t()}
Updates the specified Policy
on the resource. Creates a new Policy
for
that Constraint
on the resource if one does not exist.
Not supplying an etag
on the request Policy
results in an unconditional
write of the Policy
.
Parameters
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to serverfolders_id
(type:String.t
) - Part ofresource
. Resource name of the resource to attach thePolicy
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudResourceManager.V1.Model.SetOrgPolicyRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.OrgPolicy{}}
on success{:error, info}
on failure