public sealed class OrganizationsClientImpl : OrganizationsClientReference documentation and code samples for the Cloud Resource Manager v3 API class OrganizationsClientImpl.
Organizations client wrapper implementation, for convenient use.
Namespace
Google.Cloud.ResourceManager.V3Assembly
Google.Cloud.ResourceManager.V3.dll
Remarks
Allows users to manage their organization resources.
Constructors
OrganizationsClientImpl(OrganizationsClient, OrganizationsSettings, ILogger)
public OrganizationsClientImpl(Organizations.OrganizationsClient grpcClient, OrganizationsSettings settings, ILogger logger)Constructs a client wrapper for the Organizations service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient |
OrganizationsOrganizationsClientThe underlying gRPC client. |
settings |
OrganizationsSettingsThe base OrganizationsSettings used within this client. |
logger |
ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override Organizations.OrganizationsClient GrpcClient { get; }The underlying gRPC Organizations client
| Property Value | |
|---|---|
| Type | Description |
OrganizationsOrganizationsClient |
|
Methods
GetIamPolicy(GetIamPolicyRequest, CallSettings)
public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)Gets the access control policy for an organization resource. The policy may
be empty if no such policy or resource exists. The resource field should
be the organization's resource name, for example: "organizations/123".
Authorization requires the IAM permission
resourcemanager.organizations.getIamPolicy on the specified organization.
| Parameters | |
|---|---|
| Name | Description |
request |
GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf 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)Gets the access control policy for an organization resource. The policy may
be empty if no such policy or resource exists. The resource field should
be the organization's resource name, for example: "organizations/123".
Authorization requires the IAM permission
resourcemanager.organizations.getIamPolicy on the specified organization.
| Parameters | |
|---|---|
| Name | Description |
request |
GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy |
A Task containing the RPC response. |
GetOrganization(GetOrganizationRequest, CallSettings)
public override Organization GetOrganization(GetOrganizationRequest request, CallSettings callSettings = null)Fetches an organization resource identified by the specified resource name.
| Parameters | |
|---|---|
| Name | Description |
request |
GetOrganizationRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Organization |
The RPC response. |
GetOrganizationAsync(GetOrganizationRequest, CallSettings)
public override Task<Organization> GetOrganizationAsync(GetOrganizationRequest request, CallSettings callSettings = null)Fetches an organization resource identified by the specified resource name.
| Parameters | |
|---|---|
| Name | Description |
request |
GetOrganizationRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOrganization |
A Task containing the RPC response. |
SearchOrganizations(SearchOrganizationsRequest, CallSettings)
public override PagedEnumerable<SearchOrganizationsResponse, Organization> SearchOrganizations(SearchOrganizationsRequest request, CallSettings callSettings = null)Searches organization resources that are visible to the user and satisfy the specified filter. This method returns organizations in an unspecified order. New organizations do not necessarily appear at the end of the results, and may take a small amount of time to appear.
Search will only return organizations on which the user has the permission
resourcemanager.organizations.get
| Parameters | |
|---|---|
| Name | Description |
request |
SearchOrganizationsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableSearchOrganizationsResponseOrganization |
A pageable sequence of Organization resources. |
SearchOrganizationsAsync(SearchOrganizationsRequest, CallSettings)
public override PagedAsyncEnumerable<SearchOrganizationsResponse, Organization> SearchOrganizationsAsync(SearchOrganizationsRequest request, CallSettings callSettings = null)Searches organization resources that are visible to the user and satisfy the specified filter. This method returns organizations in an unspecified order. New organizations do not necessarily appear at the end of the results, and may take a small amount of time to appear.
Search will only return organizations on which the user has the permission
resourcemanager.organizations.get
| Parameters | |
|---|---|
| Name | Description |
request |
SearchOrganizationsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableSearchOrganizationsResponseOrganization |
A pageable asynchronous sequence of Organization resources. |
SetIamPolicy(SetIamPolicyRequest, CallSettings)
public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)Sets the access control policy on an organization resource. Replaces any
existing policy. The resource field should be the organization's resource
name, for example: "organizations/123".
Authorization requires the IAM permission
resourcemanager.organizations.setIamPolicy on the specified organization.
| Parameters | |
|---|---|
| Name | Description |
request |
SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf 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 access control policy on an organization resource. Replaces any
existing policy. The resource field should be the organization's resource
name, for example: "organizations/123".
Authorization requires the IAM permission
resourcemanager.organizations.setIamPolicy on the specified organization.
| Parameters | |
|---|---|
| Name | Description |
request |
SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf 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 the permissions that a caller has on the specified organization.
The resource field should be the organization's resource name,
for example: "organizations/123".
There are no permissions required for making this API call.
| Parameters | |
|---|---|
| Name | Description |
request |
TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf 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 the permissions that a caller has on the specified organization.
The resource field should be the organization's resource name,
for example: "organizations/123".
There are no permissions required for making this API call.
| Parameters | |
|---|---|
| Name | Description |
request |
TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTestIamPermissionsResponse |
A Task containing the RPC response. |