google_api_cloud_resource_manager v0.0.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 `etag`set because it is a computed `Policy` across multiple resources

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

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. Not supplying an `etag` on the request `Policy` results in an unconditional write of the `Policy`

Link to this section Functions

Link to this function cloudresourcemanager_folders_clear_org_policy(connection, folders_id, opts \\ []) View Source
cloudresourcemanager_folders_clear_org_policy(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.CloudResourceManager.V1.Model.Empty.t} |
  {:error, Tesla.Env.t}

Clears a `Policy` from a resource.

Parameters

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

    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :body (ClearOrgPolicyRequest):

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, opts \\ []) View Source
cloudresourcemanager_folders_get_effective_org_policy(Tesla.Env.client, String.t, 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.

Parameters

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

    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :body (GetEffectiveOrgPolicyRequest):

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, opts \\ []) View Source
cloudresourcemanager_folders_get_org_policy(Tesla.Env.client, String.t, 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 (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
  • folders_id (String): Part of `resource`. Name of the resource the `Policy` is set on.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :body (GetOrgPolicyRequest):

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, opts \\ []) View Source
cloudresourcemanager_folders_list_available_org_policy_constraints(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.CloudResourceManager.V1.Model.ListAvailableOrgPolicyConstraintsResponse.t} |
  {:error, Tesla.Env.t}

Lists `Constraints` that could be applied on the specified resource.

Parameters

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

    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :body (ListAvailableOrgPolicyConstraintsRequest):

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, opts \\ []) View Source
cloudresourcemanager_folders_list_org_policies(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.CloudResourceManager.V1.Model.ListOrgPoliciesResponse.t} |
  {:error, Tesla.Env.t}

Lists all the `Policies` set for a particular resource.

Parameters

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

    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :body (ListOrgPoliciesRequest):

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, opts \\ []) View Source
cloudresourcemanager_folders_set_org_policy(Tesla.Env.client, String.t, 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 (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
  • folders_id (String): Part of `resource`. Resource name of the resource to attach the `Policy`.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :__/xgafv (String): V1 error format.
    • :callback (String): JSONP
    • :alt (String): Data format for response.
    • :key (String): 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.
    • :access_token (String): OAuth access token.
    • :quota_user (String): 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.
    • :pp (Boolean): Pretty-print response.
    • :bearer_token (String): OAuth bearer token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :body (SetOrgPolicyRequest):

Returns

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