Cloud Resource Manager v3 API - Class OrganizationsClientImpl (2.5.0)

Version latest

• 2.5.0 (latest)
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class OrganizationsClientImpl : OrganizationsClient

Reference documentation and code samples for the Cloud Resource Manager v3 API class OrganizationsClientImpl.

Organizations client wrapper implementation, for convenient use.

Inheritance

object > OrganizationsClient > OrganizationsClientImpl

Inherited Members

OrganizationsClient.DefaultEndpoint

OrganizationsClient.DefaultScopes

OrganizationsClient.ServiceMetadata

OrganizationsClient.CreateAsync(CancellationToken)

OrganizationsClient.Create()

OrganizationsClient.ShutdownDefaultChannelsAsync()

OrganizationsClient.GetOrganizationAsync(GetOrganizationRequest, CancellationToken)

OrganizationsClient.GetOrganization(string, CallSettings)

OrganizationsClient.GetOrganizationAsync(string, CallSettings)

OrganizationsClient.GetOrganizationAsync(string, CancellationToken)

OrganizationsClient.GetOrganization(OrganizationName, CallSettings)

OrganizationsClient.GetOrganizationAsync(OrganizationName, CallSettings)

OrganizationsClient.GetOrganizationAsync(OrganizationName, CancellationToken)

OrganizationsClient.SearchOrganizations(string, string, int?, CallSettings)

OrganizationsClient.SearchOrganizationsAsync(string, string, int?, CallSettings)

OrganizationsClient.GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

OrganizationsClient.GetIamPolicy(string, CallSettings)

OrganizationsClient.GetIamPolicyAsync(string, CallSettings)

OrganizationsClient.GetIamPolicyAsync(string, CancellationToken)

OrganizationsClient.GetIamPolicy(IResourceName, CallSettings)

OrganizationsClient.GetIamPolicyAsync(IResourceName, CallSettings)

OrganizationsClient.GetIamPolicyAsync(IResourceName, CancellationToken)

OrganizationsClient.SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)

OrganizationsClient.SetIamPolicy(string, CallSettings)

OrganizationsClient.SetIamPolicyAsync(string, CallSettings)

OrganizationsClient.SetIamPolicyAsync(string, CancellationToken)

OrganizationsClient.SetIamPolicy(IResourceName, CallSettings)

OrganizationsClient.SetIamPolicyAsync(IResourceName, CallSettings)

OrganizationsClient.SetIamPolicyAsync(IResourceName, CancellationToken)

OrganizationsClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)

OrganizationsClient.TestIamPermissions(string, IEnumerable<string>, CallSettings)

OrganizationsClient.TestIamPermissionsAsync(string, IEnumerable<string>, CallSettings)

OrganizationsClient.TestIamPermissionsAsync(string, IEnumerable<string>, CancellationToken)

OrganizationsClient.TestIamPermissions(IResourceName, IEnumerable<string>, CallSettings)

OrganizationsClient.TestIamPermissionsAsync(IResourceName, IEnumerable<string>, CallSettings)

OrganizationsClient.TestIamPermissionsAsync(IResourceName, IEnumerable<string>, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.ResourceManager.V3

Assembly

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	OrganizationsOrganizationsClient The underlying gRPC client.
settings	OrganizationsSettings The base OrganizationsSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override Organizations.OrganizationsClient GrpcClient { get; }

The underlying gRPC Organizations client

Property Value
Type	Description
OrganizationsOrganizationsClient

Overrides

OrganizationsClient.GrpcClient

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	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.

Overrides

OrganizationsClient.GetIamPolicy(GetIamPolicyRequest, CallSettings)

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	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.

Overrides

OrganizationsClient.GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

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	GetOrganizationRequest 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
Organization	The RPC response.

Overrides

OrganizationsClient.GetOrganization(GetOrganizationRequest, CallSettings)

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	GetOrganizationRequest 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
TaskOrganization	A Task containing the RPC response.

Overrides

OrganizationsClient.GetOrganizationAsync(GetOrganizationRequest, CallSettings)

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	SearchOrganizationsRequest 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
PagedEnumerableSearchOrganizationsResponseOrganization	A pageable sequence of Organization resources.

Overrides

OrganizationsClient.SearchOrganizations(SearchOrganizationsRequest, CallSettings)

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	SearchOrganizationsRequest 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
PagedAsyncEnumerableSearchOrganizationsResponseOrganization	A pageable asynchronous sequence of Organization resources.

Overrides

OrganizationsClient.SearchOrganizationsAsync(SearchOrganizationsRequest, CallSettings)

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	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.

Overrides

OrganizationsClient.SetIamPolicy(SetIamPolicyRequest, CallSettings)

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	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.

Overrides

OrganizationsClient.SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

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	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.

Overrides

OrganizationsClient.TestIamPermissions(TestIamPermissionsRequest, CallSettings)

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	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.

Overrides

OrganizationsClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)