google_api_cloud_resource_manager v0.7.1 GoogleApi.CloudResourceManager.V1.Api.Folders View Source

API calls for all endpoints tagged Folders.

Link to this section Summary

Functions

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.

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

Link to this function

cloudresourcemanager_folders_clear_org_policy(connection, folders_id, optional_params \\ [], opts \\ []) View Source

Clears a Policy from a resource.

Parameters

  • connection (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
  • folders_id (String.t): Part of resource. Name of the resource for the Policy to clear.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.CloudResourceManager.V1.Model.ClearOrgPolicyRequest.t):

Returns

{:ok, %GoogleApi.CloudResourceManager.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function

cloudresourcemanager_folders_get_effective_org_policy(connection, folders_id, optional_params \\ [], opts \\ []) View Source

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.

Parameters

  • connection (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
  • folders_id (String.t): Part of resource. The name of the resource to start computing the effective Policy.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.CloudResourceManager.V1.Model.GetEffectiveOrgPolicyRequest.t):

Returns

{:ok, %GoogleApi.CloudResourceManager.V1.Model.OrgPolicy{}} on success {:error, info} on failure

Link to this function

cloudresourcemanager_folders_get_org_policy(connection, folders_id, optional_params \\ [], opts \\ []) View Source

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 (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
  • folders_id (String.t): Part of resource. Name of the resource the Policy is set on.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.CloudResourceManager.V1.Model.GetOrgPolicyRequest.t):

Returns

{:ok, %GoogleApi.CloudResourceManager.V1.Model.OrgPolicy{}} on success {:error, info} on failure

Link to this function

cloudresourcemanager_folders_list_available_org_policy_constraints(connection, folders_id, optional_params \\ [], opts \\ []) View Source

Lists Constraints that could be applied on the specified resource.

Parameters

  • connection (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
  • folders_id (String.t): Part of resource. Name of the resource to list Constraints for.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.CloudResourceManager.V1.Model.ListAvailableOrgPolicyConstraintsRequest.t):

Returns

{:ok, %GoogleApi.CloudResourceManager.V1.Model.ListAvailableOrgPolicyConstraintsResponse{}} on success {:error, info} on failure

Link to this function

cloudresourcemanager_folders_list_org_policies(connection, folders_id, optional_params \\ [], opts \\ []) View Source

Lists all the Policies set for a particular resource.

Parameters

  • connection (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
  • folders_id (String.t): Part of resource. Name of the resource to list Policies for.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.CloudResourceManager.V1.Model.ListOrgPoliciesRequest.t):

Returns

{:ok, %GoogleApi.CloudResourceManager.V1.Model.ListOrgPoliciesResponse{}} on success {:error, info} on failure

Link to this function

cloudresourcemanager_folders_set_org_policy(connection, folders_id, optional_params \\ [], opts \\ []) View Source

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 (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
  • folders_id (String.t): Part of resource. Resource name of the resource to attach the Policy.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.CloudResourceManager.V1.Model.SetOrgPolicyRequest.t):

Returns

{:ok, %GoogleApi.CloudResourceManager.V1.Model.OrgPolicy{}} on success {:error, info} on failure