Organization Policy v2 API - Class OrgPolicyClientImpl (2.1.0)

Version 2.1.0

• 2.7.0 (latest)
• 2.6.0
• 2.5.0
• 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 OrgPolicyClientImpl : OrgPolicyClient

Reference documentation and code samples for the Organization Policy v2 API class OrgPolicyClientImpl.

OrgPolicy client wrapper implementation, for convenient use.

Inheritance

Object > OrgPolicyClient > OrgPolicyClientImpl

Inherited Members

OrgPolicyClient.DefaultEndpoint

OrgPolicyClient.DefaultScopes

OrgPolicyClient.ServiceMetadata

OrgPolicyClient.CreateAsync(CancellationToken)

OrgPolicyClient.Create()

OrgPolicyClient.ShutdownDefaultChannelsAsync()

OrgPolicyClient.ListConstraints(String, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.ListConstraintsAsync(String, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.ListConstraints(ProjectName, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.ListConstraintsAsync(ProjectName, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.ListConstraints(FolderName, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.ListConstraintsAsync(FolderName, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.ListConstraints(OrganizationName, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.ListConstraintsAsync(OrganizationName, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.ListPolicies(String, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.ListPoliciesAsync(String, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.ListPolicies(ProjectName, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.ListPoliciesAsync(ProjectName, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.ListPolicies(FolderName, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.ListPoliciesAsync(FolderName, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.ListPolicies(OrganizationName, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.ListPoliciesAsync(OrganizationName, String, Nullable<Int32>, CallSettings)

OrgPolicyClient.GetPolicyAsync(GetPolicyRequest, CancellationToken)

OrgPolicyClient.GetPolicy(String, CallSettings)

OrgPolicyClient.GetPolicyAsync(String, CallSettings)

OrgPolicyClient.GetPolicyAsync(String, CancellationToken)

OrgPolicyClient.GetPolicy(PolicyName, CallSettings)

OrgPolicyClient.GetPolicyAsync(PolicyName, CallSettings)

OrgPolicyClient.GetPolicyAsync(PolicyName, CancellationToken)

OrgPolicyClient.GetEffectivePolicyAsync(GetEffectivePolicyRequest, CancellationToken)

OrgPolicyClient.GetEffectivePolicy(String, CallSettings)

OrgPolicyClient.GetEffectivePolicyAsync(String, CallSettings)

OrgPolicyClient.GetEffectivePolicyAsync(String, CancellationToken)

OrgPolicyClient.GetEffectivePolicy(PolicyName, CallSettings)

OrgPolicyClient.GetEffectivePolicyAsync(PolicyName, CallSettings)

OrgPolicyClient.GetEffectivePolicyAsync(PolicyName, CancellationToken)

OrgPolicyClient.CreatePolicyAsync(CreatePolicyRequest, CancellationToken)

OrgPolicyClient.CreatePolicy(String, Policy, CallSettings)

OrgPolicyClient.CreatePolicyAsync(String, Policy, CallSettings)

OrgPolicyClient.CreatePolicyAsync(String, Policy, CancellationToken)

OrgPolicyClient.CreatePolicy(ProjectName, Policy, CallSettings)

OrgPolicyClient.CreatePolicyAsync(ProjectName, Policy, CallSettings)

OrgPolicyClient.CreatePolicyAsync(ProjectName, Policy, CancellationToken)

OrgPolicyClient.CreatePolicy(FolderName, Policy, CallSettings)

OrgPolicyClient.CreatePolicyAsync(FolderName, Policy, CallSettings)

OrgPolicyClient.CreatePolicyAsync(FolderName, Policy, CancellationToken)

OrgPolicyClient.CreatePolicy(OrganizationName, Policy, CallSettings)

OrgPolicyClient.CreatePolicyAsync(OrganizationName, Policy, CallSettings)

OrgPolicyClient.CreatePolicyAsync(OrganizationName, Policy, CancellationToken)

OrgPolicyClient.UpdatePolicyAsync(UpdatePolicyRequest, CancellationToken)

OrgPolicyClient.UpdatePolicy(Policy, CallSettings)

OrgPolicyClient.UpdatePolicyAsync(Policy, CallSettings)

OrgPolicyClient.UpdatePolicyAsync(Policy, CancellationToken)

OrgPolicyClient.DeletePolicyAsync(DeletePolicyRequest, CancellationToken)

OrgPolicyClient.DeletePolicy(String, CallSettings)

OrgPolicyClient.DeletePolicyAsync(String, CallSettings)

OrgPolicyClient.DeletePolicyAsync(String, CancellationToken)

OrgPolicyClient.DeletePolicy(PolicyName, CallSettings)

OrgPolicyClient.DeletePolicyAsync(PolicyName, CallSettings)

OrgPolicyClient.DeletePolicyAsync(PolicyName, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.OrgPolicy.V2

Assembly

Google.Cloud.OrgPolicy.V2.dll

Remarks

An interface for managing organization policies.

The Cloud Org Policy service provides a simple mechanism for organizations to restrict the allowed configurations across their entire Cloud Resource hierarchy.

You can use a policy to configure restrictions in Cloud resources. For example, you can enforce a policy that restricts which Google Cloud Platform APIs can be activated in a certain part of your resource hierarchy, or prevents serial port access to VM instances in a particular folder.

Policies are inherited down through the resource hierarchy. A policy applied to a parent resource automatically applies to all its child resources unless overridden with a policy lower in the hierarchy.

A constraint defines an aspect of a resource's configuration that can be controlled by an organization's policy administrator. Policies are a collection of constraints that defines their allowable configuration on a particular resource and its child resources.

Constructors

OrgPolicyClientImpl(OrgPolicy.OrgPolicyClient, OrgPolicySettings, ILogger)

public OrgPolicyClientImpl(OrgPolicy.OrgPolicyClient grpcClient, OrgPolicySettings settings, ILogger logger)

Constructs a client wrapper for the OrgPolicy service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	OrgPolicy.OrgPolicyClient The underlying gRPC client.
settings	OrgPolicySettings The base OrgPolicySettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override OrgPolicy.OrgPolicyClient GrpcClient { get; }

The underlying gRPC OrgPolicy client

Property Value
Type	Description
OrgPolicy.OrgPolicyClient

Overrides

OrgPolicyClient.GrpcClient

Methods

CreatePolicy(CreatePolicyRequest, CallSettings)

public override Policy CreatePolicy(CreatePolicyRequest request, CallSettings callSettings = null)

Creates a Policy.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the policy already exists on the given Cloud resource.

Parameters
Name	Description
request	CreatePolicyRequest 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

OrgPolicyClient.CreatePolicy(CreatePolicyRequest, CallSettings)

CreatePolicyAsync(CreatePolicyRequest, CallSettings)

public override Task<Policy> CreatePolicyAsync(CreatePolicyRequest request, CallSettings callSettings = null)

Creates a Policy.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the policy already exists on the given Cloud resource.

Parameters
Name	Description
request	CreatePolicyRequest 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
Task<Policy>	A Task containing the RPC response.

Overrides

OrgPolicyClient.CreatePolicyAsync(CreatePolicyRequest, CallSettings)

DeletePolicy(DeletePolicyRequest, CallSettings)

public override void DeletePolicy(DeletePolicyRequest request, CallSettings callSettings = null)

Deletes a Policy.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or Org Policy does not exist.

Parameters
Name	Description
request	DeletePolicyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

OrgPolicyClient.DeletePolicy(DeletePolicyRequest, CallSettings)

DeletePolicyAsync(DeletePolicyRequest, CallSettings)

public override Task DeletePolicyAsync(DeletePolicyRequest request, CallSettings callSettings = null)

Deletes a Policy.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or Org Policy does not exist.

Parameters
Name	Description
request	DeletePolicyRequest 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
Task	A Task containing the RPC response.

Overrides

OrgPolicyClient.DeletePolicyAsync(DeletePolicyRequest, CallSettings)

GetEffectivePolicy(GetEffectivePolicyRequest, CallSettings)

public override Policy GetEffectivePolicy(GetEffectivePolicyRequest request, CallSettings callSettings = null)

Gets the effective Policy on a resource. This is the result of merging Policies in the resource hierarchy and evaluating conditions. The returned Policy will not have an etag or condition set because it is a computed Policy across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.

Parameters
Name	Description
request	GetEffectivePolicyRequest 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

OrgPolicyClient.GetEffectivePolicy(GetEffectivePolicyRequest, CallSettings)

GetEffectivePolicyAsync(GetEffectivePolicyRequest, CallSettings)

public override Task<Policy> GetEffectivePolicyAsync(GetEffectivePolicyRequest request, CallSettings callSettings = null)

Gets the effective Policy on a resource. This is the result of merging Policies in the resource hierarchy and evaluating conditions. The returned Policy will not have an etag or condition set because it is a computed Policy across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.

Parameters
Name	Description
request	GetEffectivePolicyRequest 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
Task<Policy>	A Task containing the RPC response.

Overrides

OrgPolicyClient.GetEffectivePolicyAsync(GetEffectivePolicyRequest, CallSettings)

GetPolicy(GetPolicyRequest, CallSettings)

public override Policy GetPolicy(GetPolicyRequest request, CallSettings callSettings = null)

Gets a Policy on a resource.

If no Policy is set on the resource, NOT_FOUND is returned. The etag value can be used with UpdatePolicy() to update a Policy during read-modify-write.

Parameters
Name	Description
request	GetPolicyRequest 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

OrgPolicyClient.GetPolicy(GetPolicyRequest, CallSettings)

GetPolicyAsync(GetPolicyRequest, CallSettings)

public override Task<Policy> GetPolicyAsync(GetPolicyRequest request, CallSettings callSettings = null)

Gets a Policy on a resource.

If no Policy is set on the resource, NOT_FOUND is returned. The etag value can be used with UpdatePolicy() to update a Policy during read-modify-write.

Parameters
Name	Description
request	GetPolicyRequest 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
Task<Policy>	A Task containing the RPC response.

Overrides

OrgPolicyClient.GetPolicyAsync(GetPolicyRequest, CallSettings)

ListConstraints(ListConstraintsRequest, CallSettings)

public override PagedEnumerable<ListConstraintsResponse, Constraint> ListConstraints(ListConstraintsRequest request, CallSettings callSettings = null)

Lists Constraints that could be applied on the specified resource.

Parameters
Name	Description
request	ListConstraintsRequest 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
PagedEnumerable<ListConstraintsResponse, Constraint>	A pageable sequence of Constraint resources.

Overrides

OrgPolicyClient.ListConstraints(ListConstraintsRequest, CallSettings)

ListConstraintsAsync(ListConstraintsRequest, CallSettings)

public override PagedAsyncEnumerable<ListConstraintsResponse, Constraint> ListConstraintsAsync(ListConstraintsRequest request, CallSettings callSettings = null)

Lists Constraints that could be applied on the specified resource.

Parameters
Name	Description
request	ListConstraintsRequest 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
PagedAsyncEnumerable<ListConstraintsResponse, Constraint>	A pageable asynchronous sequence of Constraint resources.

Overrides

OrgPolicyClient.ListConstraintsAsync(ListConstraintsRequest, CallSettings)

ListPolicies(ListPoliciesRequest, CallSettings)

public override PagedEnumerable<ListPoliciesResponse, Policy> ListPolicies(ListPoliciesRequest request, CallSettings callSettings = null)

Retrieves all of the Policies that exist on a particular resource.

Parameters
Name	Description
request	ListPoliciesRequest 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
PagedEnumerable<ListPoliciesResponse, Policy>	A pageable sequence of Policy resources.

Overrides

OrgPolicyClient.ListPolicies(ListPoliciesRequest, CallSettings)

ListPoliciesAsync(ListPoliciesRequest, CallSettings)

public override PagedAsyncEnumerable<ListPoliciesResponse, Policy> ListPoliciesAsync(ListPoliciesRequest request, CallSettings callSettings = null)

Retrieves all of the Policies that exist on a particular resource.

Parameters
Name	Description
request	ListPoliciesRequest 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
PagedAsyncEnumerable<ListPoliciesResponse, Policy>	A pageable asynchronous sequence of Policy resources.

Overrides

OrgPolicyClient.ListPoliciesAsync(ListPoliciesRequest, CallSettings)

UpdatePolicy(UpdatePolicyRequest, CallSettings)

public override Policy UpdatePolicy(UpdatePolicyRequest request, CallSettings callSettings = null)

Updates a Policy.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or the policy do not exist. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the policy

Note: the supplied policy will perform a full overwrite of all fields.

Parameters
Name	Description
request	UpdatePolicyRequest 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

OrgPolicyClient.UpdatePolicy(UpdatePolicyRequest, CallSettings)

UpdatePolicyAsync(UpdatePolicyRequest, CallSettings)

public override Task<Policy> UpdatePolicyAsync(UpdatePolicyRequest request, CallSettings callSettings = null)

Updates a Policy.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or the policy do not exist. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the policy

Note: the supplied policy will perform a full overwrite of all fields.

Parameters
Name	Description
request	UpdatePolicyRequest 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
Task<Policy>	A Task containing the RPC response.

Overrides

OrgPolicyClient.UpdatePolicyAsync(UpdatePolicyRequest, CallSettings)