Compute Engine v1 API - Class OrganizationSecurityPoliciesClientImpl (3.18.0)

public sealed class OrganizationSecurityPoliciesClientImpl : OrganizationSecurityPoliciesClient

Reference documentation and code samples for the Compute Engine v1 API class OrganizationSecurityPoliciesClientImpl.

OrganizationSecurityPolicies client wrapper implementation, for convenient use.

Inheritance

object > OrganizationSecurityPoliciesClient > OrganizationSecurityPoliciesClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The OrganizationSecurityPolicies API.

Constructors

OrganizationSecurityPoliciesClientImpl(OrganizationSecurityPoliciesClient, OrganizationSecurityPoliciesSettings, ILogger)

public OrganizationSecurityPoliciesClientImpl(OrganizationSecurityPolicies.OrganizationSecurityPoliciesClient grpcClient, OrganizationSecurityPoliciesSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient OrganizationSecurityPoliciesOrganizationSecurityPoliciesClient

The underlying gRPC client.

settings OrganizationSecurityPoliciesSettings

The base OrganizationSecurityPoliciesSettings used within this client.

logger ILogger

Optional ILogger to use within this client.

Properties

AddAssociationOperationsClient

public override OperationsClient AddAssociationOperationsClient { get; }

The long-running operations client for AddAssociation.

Property Value
Type Description
OperationsClient
Overrides

AddRuleOperationsClient

public override OperationsClient AddRuleOperationsClient { get; }

The long-running operations client for AddRule.

Property Value
Type Description
OperationsClient
Overrides

CopyRulesOperationsClient

public override OperationsClient CopyRulesOperationsClient { get; }

The long-running operations client for CopyRules.

Property Value
Type Description
OperationsClient
Overrides

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override OrganizationSecurityPolicies.OrganizationSecurityPoliciesClient GrpcClient { get; }

The underlying gRPC OrganizationSecurityPolicies client

Property Value
Type Description
OrganizationSecurityPoliciesOrganizationSecurityPoliciesClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient
Overrides

MoveOperationsClient

public override OperationsClient MoveOperationsClient { get; }

The long-running operations client for Move.

Property Value
Type Description
OperationsClient
Overrides

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type Description
OperationsClient
Overrides

PatchRuleOperationsClient

public override OperationsClient PatchRuleOperationsClient { get; }

The long-running operations client for PatchRule.

Property Value
Type Description
OperationsClient
Overrides

RemoveAssociationOperationsClient

public override OperationsClient RemoveAssociationOperationsClient { get; }

The long-running operations client for RemoveAssociation.

Property Value
Type Description
OperationsClient
Overrides

RemoveRuleOperationsClient

public override OperationsClient RemoveRuleOperationsClient { get; }

The long-running operations client for RemoveRule.

Property Value
Type Description
OperationsClient
Overrides

Methods

AddAssociation(AddAssociationOrganizationSecurityPolicyRequest, CallSettings)

public override Operation<Operation, Operation> AddAssociation(AddAssociationOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Inserts an association for the specified security policy. This has billing implications. Projects in the hierarchy with effective hierarchical security policies will be automatically enrolled into Cloud Armor Enterprise if not already enrolled. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible.

Parameters
Name Description
request AddAssociationOrganizationSecurityPolicyRequest

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
OperationOperationOperation

The RPC response.

Overrides

AddAssociationAsync(AddAssociationOrganizationSecurityPolicyRequest, CallSettings)

public override Task<Operation<Operation, Operation>> AddAssociationAsync(AddAssociationOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Inserts an association for the specified security policy. This has billing implications. Projects in the hierarchy with effective hierarchical security policies will be automatically enrolled into Cloud Armor Enterprise if not already enrolled. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible.

Parameters
Name Description
request AddAssociationOrganizationSecurityPolicyRequest

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
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

AddRule(AddRuleOrganizationSecurityPolicyRequest, CallSettings)

public override Operation<Operation, Operation> AddRule(AddRuleOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Inserts a rule into a security policy.

Parameters
Name Description
request AddRuleOrganizationSecurityPolicyRequest

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
OperationOperationOperation

The RPC response.

Overrides

AddRuleAsync(AddRuleOrganizationSecurityPolicyRequest, CallSettings)

public override Task<Operation<Operation, Operation>> AddRuleAsync(AddRuleOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Inserts a rule into a security policy.

Parameters
Name Description
request AddRuleOrganizationSecurityPolicyRequest

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
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

CopyRules(CopyRulesOrganizationSecurityPolicyRequest, CallSettings)

public override Operation<Operation, Operation> CopyRules(CopyRulesOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead.

Parameters
Name Description
request CopyRulesOrganizationSecurityPolicyRequest

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
OperationOperationOperation

The RPC response.

Overrides

CopyRulesAsync(CopyRulesOrganizationSecurityPolicyRequest, CallSettings)

public override Task<Operation<Operation, Operation>> CopyRulesAsync(CopyRulesOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead.

Parameters
Name Description
request CopyRulesOrganizationSecurityPolicyRequest

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
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

Delete(DeleteOrganizationSecurityPolicyRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead.

Parameters
Name Description
request DeleteOrganizationSecurityPolicyRequest

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
OperationOperationOperation

The RPC response.

Overrides

DeleteAsync(DeleteOrganizationSecurityPolicyRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead.

Parameters
Name Description
request DeleteOrganizationSecurityPolicyRequest

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
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

Get(GetOrganizationSecurityPolicyRequest, CallSettings)

public override SecurityPolicy Get(GetOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead.

Parameters
Name Description
request GetOrganizationSecurityPolicyRequest

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
SecurityPolicy

The RPC response.

Overrides

GetAssociation(GetAssociationOrganizationSecurityPolicyRequest, CallSettings)

public override SecurityPolicyAssociation GetAssociation(GetAssociationOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible.

Parameters
Name Description
request GetAssociationOrganizationSecurityPolicyRequest

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
SecurityPolicyAssociation

The RPC response.

Overrides

GetAssociationAsync(GetAssociationOrganizationSecurityPolicyRequest, CallSettings)

public override Task<SecurityPolicyAssociation> GetAssociationAsync(GetAssociationOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible.

Parameters
Name Description
request GetAssociationOrganizationSecurityPolicyRequest

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
TaskSecurityPolicyAssociation

A Task containing the RPC response.

Overrides

GetAsync(GetOrganizationSecurityPolicyRequest, CallSettings)

public override Task<SecurityPolicy> GetAsync(GetOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead.

Parameters
Name Description
request GetOrganizationSecurityPolicyRequest

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
TaskSecurityPolicy

A Task containing the RPC response.

Overrides

GetRule(GetRuleOrganizationSecurityPolicyRequest, CallSettings)

public override SecurityPolicyRule GetRule(GetRuleOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead.

Parameters
Name Description
request GetRuleOrganizationSecurityPolicyRequest

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
SecurityPolicyRule

The RPC response.

Overrides

GetRuleAsync(GetRuleOrganizationSecurityPolicyRequest, CallSettings)

public override Task<SecurityPolicyRule> GetRuleAsync(GetRuleOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead.

Parameters
Name Description
request GetRuleOrganizationSecurityPolicyRequest

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
TaskSecurityPolicyRule

A Task containing the RPC response.

Overrides

Insert(InsertOrganizationSecurityPolicyRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Creates a new policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead.

Parameters
Name Description
request InsertOrganizationSecurityPolicyRequest

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
OperationOperationOperation

The RPC response.

Overrides

InsertAsync(InsertOrganizationSecurityPolicyRequest, CallSettings)

public override Task<Operation<Operation, Operation>> InsertAsync(InsertOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Creates a new policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead.

Parameters
Name Description
request InsertOrganizationSecurityPolicyRequest

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
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

List(ListOrganizationSecurityPoliciesRequest, CallSettings)

public override PagedEnumerable<SecurityPolicyList, SecurityPolicy> List(ListOrganizationSecurityPoliciesRequest request, CallSettings callSettings = null)

List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead.

Parameters
Name Description
request ListOrganizationSecurityPoliciesRequest

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
PagedEnumerableSecurityPolicyListSecurityPolicy

A pageable sequence of SecurityPolicy resources.

Overrides

ListAssociations(ListAssociationsOrganizationSecurityPolicyRequest, CallSettings)

public override OrganizationSecurityPoliciesListAssociationsResponse ListAssociations(ListAssociationsOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible.

Parameters
Name Description
request ListAssociationsOrganizationSecurityPolicyRequest

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
OrganizationSecurityPoliciesListAssociationsResponse

The RPC response.

Overrides

ListAssociationsAsync(ListAssociationsOrganizationSecurityPolicyRequest, CallSettings)

public override Task<OrganizationSecurityPoliciesListAssociationsResponse> ListAssociationsAsync(ListAssociationsOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible.

Parameters
Name Description
request ListAssociationsOrganizationSecurityPolicyRequest

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
TaskOrganizationSecurityPoliciesListAssociationsResponse

A Task containing the RPC response.

Overrides

ListAsync(ListOrganizationSecurityPoliciesRequest, CallSettings)

public override PagedAsyncEnumerable<SecurityPolicyList, SecurityPolicy> ListAsync(ListOrganizationSecurityPoliciesRequest request, CallSettings callSettings = null)

List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead.

Parameters
Name Description
request ListOrganizationSecurityPoliciesRequest

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
PagedAsyncEnumerableSecurityPolicyListSecurityPolicy

A pageable asynchronous sequence of SecurityPolicy resources.

Overrides

ListPreconfiguredExpressionSets(ListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest, CallSettings)

public override SecurityPoliciesListPreconfiguredExpressionSetsResponse ListPreconfiguredExpressionSets(ListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest request, CallSettings callSettings = null)

Gets the current list of preconfigured Web Application Firewall (WAF) expressions.

Parameters
Name Description
request ListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest

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
SecurityPoliciesListPreconfiguredExpressionSetsResponse

The RPC response.

Overrides

ListPreconfiguredExpressionSetsAsync(ListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest, CallSettings)

public override Task<SecurityPoliciesListPreconfiguredExpressionSetsResponse> ListPreconfiguredExpressionSetsAsync(ListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest request, CallSettings callSettings = null)

Gets the current list of preconfigured Web Application Firewall (WAF) expressions.

Parameters
Name Description
request ListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest

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
TaskSecurityPoliciesListPreconfiguredExpressionSetsResponse

A Task containing the RPC response.

Overrides

Move(MoveOrganizationSecurityPolicyRequest, CallSettings)

public override Operation<Operation, Operation> Move(MoveOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead.

Parameters
Name Description
request MoveOrganizationSecurityPolicyRequest

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
OperationOperationOperation

The RPC response.

Overrides

MoveAsync(MoveOrganizationSecurityPolicyRequest, CallSettings)

public override Task<Operation<Operation, Operation>> MoveAsync(MoveOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead.

Parameters
Name Description
request MoveOrganizationSecurityPolicyRequest

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
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

Patch(PatchOrganizationSecurityPolicyRequest, CallSettings)

public override Operation<Operation, Operation> Patch(PatchOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.

Parameters
Name Description
request PatchOrganizationSecurityPolicyRequest

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
OperationOperationOperation

The RPC response.

Overrides

PatchAsync(PatchOrganizationSecurityPolicyRequest, CallSettings)

public override Task<Operation<Operation, Operation>> PatchAsync(PatchOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.

Parameters
Name Description
request PatchOrganizationSecurityPolicyRequest

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
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

PatchRule(PatchRuleOrganizationSecurityPolicyRequest, CallSettings)

public override Operation<Operation, Operation> PatchRule(PatchRuleOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.

Parameters
Name Description
request PatchRuleOrganizationSecurityPolicyRequest

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
OperationOperationOperation

The RPC response.

Overrides

PatchRuleAsync(PatchRuleOrganizationSecurityPolicyRequest, CallSettings)

public override Task<Operation<Operation, Operation>> PatchRuleAsync(PatchRuleOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.

Parameters
Name Description
request PatchRuleOrganizationSecurityPolicyRequest

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
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

RemoveAssociation(RemoveAssociationOrganizationSecurityPolicyRequest, CallSettings)

public override Operation<Operation, Operation> RemoveAssociation(RemoveAssociationOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible.

Parameters
Name Description
request RemoveAssociationOrganizationSecurityPolicyRequest

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
OperationOperationOperation

The RPC response.

Overrides

RemoveAssociationAsync(RemoveAssociationOrganizationSecurityPolicyRequest, CallSettings)

public override Task<Operation<Operation, Operation>> RemoveAssociationAsync(RemoveAssociationOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible.

Parameters
Name Description
request RemoveAssociationOrganizationSecurityPolicyRequest

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
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides

RemoveRule(RemoveRuleOrganizationSecurityPolicyRequest, CallSettings)

public override Operation<Operation, Operation> RemoveRule(RemoveRuleOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Deletes a rule at the specified priority.

Parameters
Name Description
request RemoveRuleOrganizationSecurityPolicyRequest

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
OperationOperationOperation

The RPC response.

Overrides

RemoveRuleAsync(RemoveRuleOrganizationSecurityPolicyRequest, CallSettings)

public override Task<Operation<Operation, Operation>> RemoveRuleAsync(RemoveRuleOrganizationSecurityPolicyRequest request, CallSettings callSettings = null)

Deletes a rule at the specified priority.

Parameters
Name Description
request RemoveRuleOrganizationSecurityPolicyRequest

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
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides