Class ProjectsResource
The "projects" collection of methods.
Inherited Members
Namespace: Google.Apis.CloudResourceManager.v1beta1
Assembly: Google.Apis.CloudResourceManager.v1beta1.dll
Syntax
public class ProjectsResourceConstructors
ProjectsResource(IClientService)
Constructs a new resource.
Declaration
public ProjectsResource(IClientService service)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service |
Methods
Create(Project)
Creates a Project resource. Initially, the Project resource is owned by its creator exclusively. The creator
can later grant permission to others to read or update the Project. Several APIs are activated automatically
for the Project, including Google Cloud Storage. The parent is identified by a specified ResourceId, which
must include both an ID and a type, such as project, folder, or 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.
Declaration
public virtual ProjectsResource.CreateRequest Create(Project body)Parameters
| Type | Name | Description |
|---|---|---|
| Project | body | The body of the request. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.CreateRequest |
Delete(string)
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 delete permissions for this Project.
Declaration
public virtual ProjectsResource.DeleteRequest Delete(string projectId)Parameters
| Type | Name | Description |
|---|---|---|
| string | projectId | The Project ID (for example, |
Returns
| Type | Description |
|---|---|
| ProjectsResource.DeleteRequest |
Get(string)
Retrieves the Project identified by the specified project_id (for example, my-project-123). The caller
must have read permissions for this Project.
Declaration
public virtual ProjectsResource.GetRequest Get(string projectId)Parameters
| Type | Name | Description |
|---|---|---|
| string | projectId | Required. The Project ID (for example, |
Returns
| Type | Description |
|---|---|
| ProjectsResource.GetRequest |
GetAncestry(GetAncestryRequest, string)
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.
Declaration
public virtual ProjectsResource.GetAncestryRequest GetAncestry(GetAncestryRequest body, string projectId)Parameters
| Type | Name | Description |
|---|---|---|
| GetAncestryRequest | body | The body of the request. |
| string | projectId | Required. The Project ID (for example, |
Returns
| Type | Description |
|---|---|
| ProjectsResource.GetAncestryRequest |
GetIamPolicy(GetIamPolicyRequest, string)
Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist. For additional information about resource structure and identification, see Resource Names.
Declaration
public virtual ProjectsResource.GetIamPolicyRequest GetIamPolicy(GetIamPolicyRequest body, string resource)Parameters
| Type | Name | Description |
|---|---|---|
| GetIamPolicyRequest | body | The body of the request. |
| string | resource | REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.GetIamPolicyRequest |
List()
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 behavioral difference.
Declaration
public virtual ProjectsResource.ListRequest List()Returns
| Type | Description |
|---|---|
| ProjectsResource.ListRequest |
SetIamPolicy(SetIamPolicyRequest, string)
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. The following constraints apply when
using setIamPolicy(): + Project does not support allUsers and allAuthenticatedUsers as members in a
Binding of a Policy. + 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. + Invitations to grant the owner role cannot be
sent using setIamPolicy(); they must be sent only using the Cloud Platform Console. + 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
Declaration
public virtual ProjectsResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)Parameters
| Type | Name | Description |
|---|---|---|
| SetIamPolicyRequest | body | The body of the request. |
| string | resource | REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.SetIamPolicyRequest |
TestIamPermissions(TestIamPermissionsRequest, string)
Returns permissions that a caller has on the specified Project.
Declaration
public virtual ProjectsResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)Parameters
| Type | Name | Description |
|---|---|---|
| TestIamPermissionsRequest | body | The body of the request. |
| string | resource | REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.TestIamPermissionsRequest |
Undelete(UndeleteProjectRequest, string)
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 undelete permissions for this Project.
Declaration
public virtual ProjectsResource.UndeleteRequest Undelete(UndeleteProjectRequest body, string projectId)Parameters
| Type | Name | Description |
|---|---|---|
| UndeleteProjectRequest | body | The body of the request. |
| string | projectId | Required. The project ID (for example, |
Returns
| Type | Description |
|---|---|
| ProjectsResource.UndeleteRequest |
Update(Project, string)
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.
Declaration
public virtual ProjectsResource.UpdateRequest Update(Project body, string projectId)Parameters
| Type | Name | Description |
|---|---|---|
| Project | body | The body of the request. |
| string | projectId | The project ID (for example, |
Returns
| Type | Description |
|---|---|
| ProjectsResource.UpdateRequest |