public sealed class ProjectsClientImpl : ProjectsClient
Reference documentation and code samples for the Cloud Resource Manager v3 API class ProjectsClientImpl.
Projects client wrapper implementation, for convenient use.
Namespace
Google.Cloud.ResourceManager.V3Assembly
Google.Cloud.ResourceManager.V3.dll
Remarks
Manages Google Cloud Projects.
Constructors
ProjectsClientImpl(ProjectsClient, ProjectsSettings, ILogger)
public ProjectsClientImpl(Projects.ProjectsClient grpcClient, ProjectsSettings settings, ILogger logger)
Constructs a client wrapper for the Projects service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient | ProjectsProjectsClient The underlying gRPC client. |
settings | ProjectsSettings The base ProjectsSettings used within this client. |
logger | ILogger Optional ILogger to use within this client. |
Properties
CreateProjectOperationsClient
public override OperationsClient CreateProjectOperationsClient { get; }
The long-running operations client for CreateProject
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteProjectOperationsClient
public override OperationsClient DeleteProjectOperationsClient { get; }
The long-running operations client for DeleteProject
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override Projects.ProjectsClient GrpcClient { get; }
The underlying gRPC Projects client
Property Value | |
---|---|
Type | Description |
ProjectsProjectsClient |
MoveProjectOperationsClient
public override OperationsClient MoveProjectOperationsClient { get; }
The long-running operations client for MoveProject
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UndeleteProjectOperationsClient
public override OperationsClient UndeleteProjectOperationsClient { get; }
The long-running operations client for UndeleteProject
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateProjectOperationsClient
public override OperationsClient UpdateProjectOperationsClient { get; }
The long-running operations client for UpdateProject
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
CreateProject(CreateProjectRequest, CallSettings)
public override Operation<Project, CreateProjectMetadata> CreateProject(CreateProjectRequest request, CallSettings callSettings = null)
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
.
Parameters | |
---|---|
Name | Description |
request | CreateProjectRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationProjectCreateProjectMetadata | The RPC response. |
CreateProjectAsync(CreateProjectRequest, CallSettings)
public override Task<Operation<Project, CreateProjectMetadata>> CreateProjectAsync(CreateProjectRequest request, CallSettings callSettings = null)
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
.
Parameters | |
---|---|
Name | Description |
request | CreateProjectRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationProjectCreateProjectMetadata | A Task containing the RPC response. |
DeleteProject(DeleteProjectRequest, CallSettings)
public override Operation<Project, DeleteProjectMetadata> DeleteProject(DeleteProjectRequest request, CallSettings callSettings = null)
Marks the project identified by the specified
name
(for example, projects/415104041262
) for deletion.
This method will only affect the project if it has a lifecycle state of [ACTIVE][google.cloud.resourcemanager.v3.Project.State.ACTIVE].
This method changes the Project's lifecycle state from [ACTIVE][google.cloud.resourcemanager.v3.Project.State.ACTIVE] to [DELETE_REQUESTED][google.cloud.resourcemanager.v3.Project.State.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] [google.cloud.resourcemanager.v3.Projects.GetProject], and the project remains visible to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects]. However, you cannot update the project.
After the deletion completes, the project is not retrievable by the [GetProject] [google.cloud.resourcemanager.v3.Projects.GetProject], [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects], and [SearchProjects][google.cloud.resourcemanager.v3.Projects.SearchProjects] methods.
This method behaves idempotently, such that deleting a DELETE_REQUESTED
project will not cause an error, but also won't do anything.
The caller must have resourcemanager.projects.delete
permissions for this
project.
Parameters | |
---|---|
Name | Description |
request | DeleteProjectRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationProjectDeleteProjectMetadata | The RPC response. |
DeleteProjectAsync(DeleteProjectRequest, CallSettings)
public override Task<Operation<Project, DeleteProjectMetadata>> DeleteProjectAsync(DeleteProjectRequest request, CallSettings callSettings = null)
Marks the project identified by the specified
name
(for example, projects/415104041262
) for deletion.
This method will only affect the project if it has a lifecycle state of [ACTIVE][google.cloud.resourcemanager.v3.Project.State.ACTIVE].
This method changes the Project's lifecycle state from [ACTIVE][google.cloud.resourcemanager.v3.Project.State.ACTIVE] to [DELETE_REQUESTED][google.cloud.resourcemanager.v3.Project.State.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] [google.cloud.resourcemanager.v3.Projects.GetProject], and the project remains visible to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects]. However, you cannot update the project.
After the deletion completes, the project is not retrievable by the [GetProject] [google.cloud.resourcemanager.v3.Projects.GetProject], [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects], and [SearchProjects][google.cloud.resourcemanager.v3.Projects.SearchProjects] methods.
This method behaves idempotently, such that deleting a DELETE_REQUESTED
project will not cause an error, but also won't do anything.
The caller must have resourcemanager.projects.delete
permissions for this
project.
Parameters | |
---|---|
Name | Description |
request | DeleteProjectRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationProjectDeleteProjectMetadata | A Task containing the RPC response. |
GetIamPolicy(GetIamPolicyRequest, CallSettings)
public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)
Returns the IAM access control policy for the specified project, in the
format projects/{ProjectIdOrNumber}
e.g. projects/123.
Permission is denied if the policy or the resource do not exist.
Parameters | |
---|---|
Name | Description |
request | GetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Policy | The RPC response. |
GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)
public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)
Returns the IAM access control policy for the specified project, in the
format projects/{ProjectIdOrNumber}
e.g. projects/123.
Permission is denied if the policy or the resource do not exist.
Parameters | |
---|---|
Name | Description |
request | GetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPolicy | A Task containing the RPC response. |
GetProject(GetProjectRequest, CallSettings)
public override Project GetProject(GetProjectRequest request, CallSettings callSettings = null)
Retrieves the project identified by the specified name
(for example,
projects/415104041262
).
The caller must have resourcemanager.projects.get
permission
for this project.
Parameters | |
---|---|
Name | Description |
request | GetProjectRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Project | The RPC response. |
GetProjectAsync(GetProjectRequest, CallSettings)
public override Task<Project> GetProjectAsync(GetProjectRequest request, CallSettings callSettings = null)
Retrieves the project identified by the specified name
(for example,
projects/415104041262
).
The caller must have resourcemanager.projects.get
permission
for this project.
Parameters | |
---|---|
Name | Description |
request | GetProjectRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskProject | A Task containing the RPC response. |
ListProjects(ListProjectsRequest, CallSettings)
public override PagedEnumerable<ListProjectsResponse, Project> ListProjects(ListProjectsRequest request, CallSettings callSettings = null)
Lists projects that are direct children of the specified folder or
organization resource. list()
provides a strongly consistent view of the
projects underneath the specified parent resource. list()
returns
projects sorted based upon the (ascending) lexical ordering of their
display_name
. The caller must have resourcemanager.projects.list
permission on the identified parent.
Parameters | |
---|---|
Name | Description |
request | ListProjectsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListProjectsResponseProject | A pageable sequence of Project resources. |
ListProjectsAsync(ListProjectsRequest, CallSettings)
public override PagedAsyncEnumerable<ListProjectsResponse, Project> ListProjectsAsync(ListProjectsRequest request, CallSettings callSettings = null)
Lists projects that are direct children of the specified folder or
organization resource. list()
provides a strongly consistent view of the
projects underneath the specified parent resource. list()
returns
projects sorted based upon the (ascending) lexical ordering of their
display_name
. The caller must have resourcemanager.projects.list
permission on the identified parent.
Parameters | |
---|---|
Name | Description |
request | ListProjectsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListProjectsResponseProject | A pageable asynchronous sequence of Project resources. |
MoveProject(MoveProjectRequest, CallSettings)
public override Operation<Project, MoveProjectMetadata> MoveProject(MoveProjectRequest request, CallSettings callSettings = null)
Move a project to another place in your resource hierarchy, under a new resource parent.
Returns an operation which can be used to track the process of the project
move workflow.
Upon success, the Operation.response
field will be populated with the
moved project.
The caller must have resourcemanager.projects.move
permission on the
project, on the project's current and proposed new parent.
If project has no current parent, or it currently does not have an
associated organization resource, you will also need the
resourcemanager.projects.setIamPolicy
permission in the project.
Parameters | |
---|---|
Name | Description |
request | MoveProjectRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationProjectMoveProjectMetadata | The RPC response. |
MoveProjectAsync(MoveProjectRequest, CallSettings)
public override Task<Operation<Project, MoveProjectMetadata>> MoveProjectAsync(MoveProjectRequest request, CallSettings callSettings = null)
Move a project to another place in your resource hierarchy, under a new resource parent.
Returns an operation which can be used to track the process of the project
move workflow.
Upon success, the Operation.response
field will be populated with the
moved project.
The caller must have resourcemanager.projects.move
permission on the
project, on the project's current and proposed new parent.
If project has no current parent, or it currently does not have an
associated organization resource, you will also need the
resourcemanager.projects.setIamPolicy
permission in the project.
Parameters | |
---|---|
Name | Description |
request | MoveProjectRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationProjectMoveProjectMetadata | A Task containing the RPC response. |
SearchProjects(SearchProjectsRequest, CallSettings)
public override PagedEnumerable<SearchProjectsResponse, Project> SearchProjects(SearchProjectsRequest request, CallSettings callSettings = null)
Search for projects that the caller has both resourcemanager.projects.get
permission on, and also satisfy the specified query.
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][google.cloud.resourcemanager.v3.Projects.GetProject] method.
Parameters | |
---|---|
Name | Description |
request | SearchProjectsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableSearchProjectsResponseProject | A pageable sequence of Project resources. |
SearchProjectsAsync(SearchProjectsRequest, CallSettings)
public override PagedAsyncEnumerable<SearchProjectsResponse, Project> SearchProjectsAsync(SearchProjectsRequest request, CallSettings callSettings = null)
Search for projects that the caller has both resourcemanager.projects.get
permission on, and also satisfy the specified query.
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][google.cloud.resourcemanager.v3.Projects.GetProject] method.
Parameters | |
---|---|
Name | Description |
request | SearchProjectsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableSearchProjectsResponseProject | A pageable asynchronous sequence of Project resources. |
SetIamPolicy(SetIamPolicyRequest, CallSettings)
public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)
Sets the IAM access control policy for the specified project, in the
format projects/{ProjectIdOrNumber}
e.g. projects/123.
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
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 using the 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.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. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible.
Parameters | |
---|---|
Name | Description |
request | SetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Policy | The RPC response. |
SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)
public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)
Sets the IAM access control policy for the specified project, in the
format projects/{ProjectIdOrNumber}
e.g. projects/123.
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
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 using the 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.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. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible.
Parameters | |
---|---|
Name | Description |
request | SetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPolicy | A Task containing the RPC response. |
TestIamPermissions(TestIamPermissionsRequest, CallSettings)
public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)
Returns permissions that a caller has on the specified project, in the
format projects/{ProjectIdOrNumber}
e.g. projects/123..
Parameters | |
---|---|
Name | Description |
request | TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TestIamPermissionsResponse | The RPC response. |
TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)
public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)
Returns permissions that a caller has on the specified project, in the
format projects/{ProjectIdOrNumber}
e.g. projects/123..
Parameters | |
---|---|
Name | Description |
request | TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTestIamPermissionsResponse | A Task containing the RPC response. |
UndeleteProject(UndeleteProjectRequest, CallSettings)
public override Operation<Project, UndeleteProjectMetadata> UndeleteProject(UndeleteProjectRequest request, CallSettings callSettings = null)
Restores the project identified by the specified
name
(for example, projects/415104041262
).
You can only use this method for a project that has a lifecycle state of
[DELETE_REQUESTED]
[Projects.State.DELETE_REQUESTED].
After deletion starts, the project cannot be restored.
The caller must have resourcemanager.projects.undelete
permission for
this project.
Parameters | |
---|---|
Name | Description |
request | UndeleteProjectRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationProjectUndeleteProjectMetadata | The RPC response. |
UndeleteProjectAsync(UndeleteProjectRequest, CallSettings)
public override Task<Operation<Project, UndeleteProjectMetadata>> UndeleteProjectAsync(UndeleteProjectRequest request, CallSettings callSettings = null)
Restores the project identified by the specified
name
(for example, projects/415104041262
).
You can only use this method for a project that has a lifecycle state of
[DELETE_REQUESTED]
[Projects.State.DELETE_REQUESTED].
After deletion starts, the project cannot be restored.
The caller must have resourcemanager.projects.undelete
permission for
this project.
Parameters | |
---|---|
Name | Description |
request | UndeleteProjectRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationProjectUndeleteProjectMetadata | A Task containing the RPC response. |
UpdateProject(UpdateProjectRequest, CallSettings)
public override Operation<Project, UpdateProjectMetadata> UpdateProject(UpdateProjectRequest request, CallSettings callSettings = null)
Updates the display_name
and labels of the project identified by the
specified name
(for example, projects/415104041262
). Deleting all
labels requires an update mask for labels field.
The caller must have resourcemanager.projects.update
permission for this
project.
Parameters | |
---|---|
Name | Description |
request | UpdateProjectRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationProjectUpdateProjectMetadata | The RPC response. |
UpdateProjectAsync(UpdateProjectRequest, CallSettings)
public override Task<Operation<Project, UpdateProjectMetadata>> UpdateProjectAsync(UpdateProjectRequest request, CallSettings callSettings = null)
Updates the display_name
and labels of the project identified by the
specified name
(for example, projects/415104041262
). Deleting all
labels requires an update mask for labels field.
The caller must have resourcemanager.projects.update
permission for this
project.
Parameters | |
---|---|
Name | Description |
request | UpdateProjectRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationProjectUpdateProjectMetadata | A Task containing the RPC response. |