google_api_cloud_resource_manager v0.31.0 GoogleApi.CloudResourceManager.V1.Api.Projects View Source
API calls for all endpoints tagged Projects
.
Link to this section Summary
Functions
Clears a Policy
from a resource.
Request that a new Project be created. The result is an Operation which can be used to track the creation process. This process usually takes a few seconds, but can sometimes take much longer. The tracking Operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
Marks the Project identified by the specified
project_id
(for example, my-project-123
) for deletion.
This method will only affect the Project if it has a lifecycle state of
ACTIVE.
Retrieves the Project identified by the specified
project_id
(for example, my-project-123
).
Gets a list of ancestors in the resource hierarchy for the Project
identified by the specified project_id
(for example, my-project-123
).
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.
Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.
Gets a Policy
on a resource.
Lists Projects that the caller has the resourcemanager.projects.get
permission on and satisfy the specified filter.
Lists Constraints
that could be applied on the specified resource.
Lists all the Policies
set for a particular resource.
Sets the IAM access control policy for the specified Project.
Updates the specified Policy
on the resource. Creates a new Policy
for
that Constraint
on the resource if one does not exist.
Returns permissions that a caller has on the specified Project.
Restores the Project identified by the specified
project_id
(for example, my-project-123
).
You can only use this method for a Project that has a lifecycle state of
DELETE_REQUESTED.
After deletion starts, the Project cannot be restored.
Updates the attributes of the Project identified by the specified
project_id
(for example, my-project-123
).
Link to this section Functions
cloudresourcemanager_projects_clear_org_policy(connection, projects_id, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_clear_org_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Clears a Policy
from a resource.
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to server -
projects_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_projects_create(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_create(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Request that a new Project be created. The result is an Operation which can be used to track the creation process. This process usually takes a few seconds, but can sometimes take much longer. The tracking Operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
Authorization requires the Google IAM permission
resourcemanager.projects.create
on the specified parent for the new
project. The parent is identified by a specified ResourceId,
which must include both an ID and a type, such as organization.
This method does not associate the new project with a billing account.
You can set or update the billing account associated with a project using
the [projects.updateBillingInfo
]
(/billing/reference/rest/v1/projects/updateBillingInfo) method.
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to server -
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.Project.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudresourcemanager_projects_delete(connection, project_id, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Marks the Project identified by the specified
project_id
(for example, my-project-123
) for deletion.
This method will only affect the Project if it has a lifecycle state of
ACTIVE.
This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible.
Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project.
After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods.
The caller must have modify permissions for this Project.
Parameters
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to serverproject_id
(type:String.t
) - The Project ID (for example,foo-bar-123
).Required.
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").
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V1.Model.Empty{}}
on success -
{:error, info}
on failure
cloudresourcemanager_projects_get(connection, project_id, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.Project.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves the Project identified by the specified
project_id
(for example, my-project-123
).
The caller must have read permissions for this Project.
Parameters
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to serverproject_id
(type:String.t
) - The Project ID (for example,my-project-123
).Required.
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").
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V1.Model.Project{}}
on success -
{:error, info}
on failure
cloudresourcemanager_projects_get_ancestry(connection, project_id, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_get_ancestry( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.GetAncestryResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets a list of ancestors in the resource hierarchy for the Project
identified by the specified project_id
(for example, my-project-123
).
The caller must have read permissions for this Project.
Parameters
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to serverproject_id
(type:String.t
) - The Project ID (for example,my-project-123
).Required.
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.GetAncestryRequest.t
) -
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V1.Model.GetAncestryResponse{}}
on success -
{:error, info}
on failure
cloudresourcemanager_projects_get_effective_org_policy(connection, projects_id, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_get_effective_org_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.OrgPolicy.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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 server -
projects_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_projects_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.
Authorization requires the Google IAM permission
resourcemanager.projects.getIamPolicy
on the project.
For additional information about resource
(e.g. my-project-id) structure
and identification, see Resource Names.
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. -
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.GetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V1.Model.Policy{}}
on success -
{:error, info}
on failure
cloudresourcemanager_projects_get_org_policy(connection, projects_id, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_get_org_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.OrgPolicy.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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 server -
projects_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_projects_list(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.ListProjectsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists Projects that the caller has the resourcemanager.projects.get
permission on and satisfy the specified filter.
This method returns Projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method.
NOTE: If the request filter contains a parent.type
and parent.id
and
the caller has the resourcemanager.projects.list
permission on the
parent, the results will be drawn from an alternate index which provides
more consistent results. In future versions of this API, this List method
will be split into List and Search to properly capture the behavorial
difference.
Parameters
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to serveroptional_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").:filter
(type:String.t
) - An expression for filtering the results of the request. Filter rules are case insensitive. Some eligible fields for filtering are:name
id
labels.<key>
(where key is the name of a label)parent.type
parent.id
lifecycleState
Some examples of filter strings: | Filter | Description | |------------------|-----------------------------------------------------| | name:how | The project's name starts with "how". | | name:Howl | The project's name isHowl
orhowl
. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color: | The project has the labelcolor
. | | labels.color:red | The project's labelcolor
has the valuered
. | | labels.color:red labels.size:big | The project's labelcolor
| : : has the valuered
and its : : : labelsize
has the value : : :big
. : | lifecycleState:DELETE_REQUESTED | Only show projects that are | : : pending deletion. : If no filter is specified, the call will return projects for which the user has theresourcemanager.projects.get
permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have theresourcemanager.projects.list
permission on the parent and the filter must contain both aparent.type
and aparent.id
restriction (example: "parent.type:folder parent.id:123"). In this case an alternate search index is used which provides more consistent results. Optional.
:pageSize
(type:integer()
) - The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default. Optional.:pageToken
(type:String.t
) - A pagination token returned from a previous call to ListProjects that indicates from where listing should continue. Optional.
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V1.Model.ListProjectsResponse{}}
on success -
{:error, info}
on failure
cloudresourcemanager_projects_list_available_org_policy_constraints(connection, projects_id, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_list_available_org_policy_constraints( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.ListAvailableOrgPolicyConstraintsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists Constraints
that could be applied on the specified resource.
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to server -
projects_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_projects_list_org_policies(connection, projects_id, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_list_org_policies( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.ListOrgPoliciesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists all the Policies
set for a particular resource.
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to server -
projects_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_projects_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Sets the IAM access control policy for the specified Project.
CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings.
NOTE: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.
For additional information about resource
(e.g. my-project-id) structure
and identification, see Resource Names.
The following constraints apply when using setIamPolicy()
:
Project does not support
allUsers
andallAuthenticatedUsers
asmembers
in aBinding
of aPolicy
.The owner role can be granted to a
user
,serviceAccount
, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization.Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation.
A user cannot be granted the owner role using
setIamPolicy()
. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation.You can only grant ownership of a project to a member by using the GCP Console. Inviting a member will deliver an invitation email that they must accept. An invitation email is not generated if you are granting a role other than owner, or if both the member you are inviting and the project are part of your organization.
Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected.
If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling
setIamPolicy()
to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified.
Authorization requires the Google IAM permission
resourcemanager.projects.setIamPolicy
on the project
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. -
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.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V1.Model.Policy{}}
on success -
{:error, info}
on failure
cloudresourcemanager_projects_set_org_policy(connection, projects_id, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_set_org_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.OrgPolicy.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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 server -
projects_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
cloudresourcemanager_projects_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Returns permissions that a caller has on the specified Project.
For additional information about resource
(e.g. my-project-id) structure
and identification, see Resource Names.
There are no permissions required for making this API call.
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. -
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.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V1.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
cloudresourcemanager_projects_undelete(connection, project_id, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_undelete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Restores the Project identified by the specified
project_id
(for example, my-project-123
).
You can only use this method for a Project that has a lifecycle state of
DELETE_REQUESTED.
After deletion starts, the Project cannot be restored.
The caller must have modify permissions for this Project.
Parameters
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to serverproject_id
(type:String.t
) - The project ID (for example,foo-bar-123
).Required.
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.UndeleteProjectRequest.t
) -
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V1.Model.Empty{}}
on success -
{:error, info}
on failure
cloudresourcemanager_projects_update(connection, project_id, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudresourcemanager_projects_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V1.Model.Project.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates the attributes of the Project identified by the specified
project_id
(for example, my-project-123
).
The caller must have modify permissions for this Project.
Parameters
connection
(type:GoogleApi.CloudResourceManager.V1.Connection.t
) - Connection to serverproject_id
(type:String.t
) - The project ID (for example,my-project-123
).Required.
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.Project.t
) -
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V1.Model.Project{}}
on success -
{:error, info}
on failure