Compute Engine v1 API - Class FirewallPoliciesClientImpl (2.3.0)

public sealed class FirewallPoliciesClientImpl : FirewallPoliciesClient

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

FirewallPolicies client wrapper implementation, for convenient use.

Inheritance

Object > FirewallPoliciesClient > FirewallPoliciesClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The FirewallPolicies API.

Constructors

FirewallPoliciesClientImpl(FirewallPolicies.FirewallPoliciesClient, FirewallPoliciesSettings, ILogger)

public FirewallPoliciesClientImpl(FirewallPolicies.FirewallPoliciesClient grpcClient, FirewallPoliciesSettings settings, ILogger logger)

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

Parameters
NameDescription
grpcClientFirewallPolicies.FirewallPoliciesClient

The underlying gRPC client.

settingsFirewallPoliciesSettings

The base FirewallPoliciesSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

AddAssociationOperationsClient

public override OperationsClient AddAssociationOperationsClient { get; }

The long-running operations client for AddAssociation.

Property Value
TypeDescription
OperationsClient
Overrides

AddRuleOperationsClient

public override OperationsClient AddRuleOperationsClient { get; }

The long-running operations client for AddRule.

Property Value
TypeDescription
OperationsClient
Overrides

CloneRulesOperationsClient

public override OperationsClient CloneRulesOperationsClient { get; }

The long-running operations client for CloneRules.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override FirewallPolicies.FirewallPoliciesClient GrpcClient { get; }

The underlying gRPC FirewallPolicies client

Property Value
TypeDescription
FirewallPolicies.FirewallPoliciesClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
TypeDescription
OperationsClient
Overrides

MoveOperationsClient

public override OperationsClient MoveOperationsClient { get; }

The long-running operations client for Move.

Property Value
TypeDescription
OperationsClient
Overrides

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
TypeDescription
OperationsClient
Overrides

PatchRuleOperationsClient

public override OperationsClient PatchRuleOperationsClient { get; }

The long-running operations client for PatchRule.

Property Value
TypeDescription
OperationsClient
Overrides

RemoveAssociationOperationsClient

public override OperationsClient RemoveAssociationOperationsClient { get; }

The long-running operations client for RemoveAssociation.

Property Value
TypeDescription
OperationsClient
Overrides

RemoveRuleOperationsClient

public override OperationsClient RemoveRuleOperationsClient { get; }

The long-running operations client for RemoveRule.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

AddAssociation(AddAssociationFirewallPolicyRequest, CallSettings)

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

Inserts an association for the specified firewall policy.

Parameters
NameDescription
requestAddAssociationFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

AddAssociationAsync(AddAssociationFirewallPolicyRequest, CallSettings)

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

Inserts an association for the specified firewall policy.

Parameters
NameDescription
requestAddAssociationFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

AddRule(AddRuleFirewallPolicyRequest, CallSettings)

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

Inserts a rule into a firewall policy.

Parameters
NameDescription
requestAddRuleFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

AddRuleAsync(AddRuleFirewallPolicyRequest, CallSettings)

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

Inserts a rule into a firewall policy.

Parameters
NameDescription
requestAddRuleFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

CloneRules(CloneRulesFirewallPolicyRequest, CallSettings)

public override Operation<Operation, Operation> CloneRules(CloneRulesFirewallPolicyRequest request, CallSettings callSettings = null)

Copies rules to the specified firewall policy.

Parameters
NameDescription
requestCloneRulesFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

CloneRulesAsync(CloneRulesFirewallPolicyRequest, CallSettings)

public override async Task<Operation<Operation, Operation>> CloneRulesAsync(CloneRulesFirewallPolicyRequest request, CallSettings callSettings = null)

Copies rules to the specified firewall policy.

Parameters
NameDescription
requestCloneRulesFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

Delete(DeleteFirewallPolicyRequest, CallSettings)

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

Deletes the specified policy.

Parameters
NameDescription
requestDeleteFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

DeleteAsync(DeleteFirewallPolicyRequest, CallSettings)

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

Deletes the specified policy.

Parameters
NameDescription
requestDeleteFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

Get(GetFirewallPolicyRequest, CallSettings)

public override FirewallPolicy Get(GetFirewallPolicyRequest request, CallSettings callSettings = null)

Returns the specified firewall policy.

Parameters
NameDescription
requestGetFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
FirewallPolicy

The RPC response.

Overrides

GetAssociation(GetAssociationFirewallPolicyRequest, CallSettings)

public override FirewallPolicyAssociation GetAssociation(GetAssociationFirewallPolicyRequest request, CallSettings callSettings = null)

Gets an association with the specified name.

Parameters
NameDescription
requestGetAssociationFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
FirewallPolicyAssociation

The RPC response.

Overrides

GetAssociationAsync(GetAssociationFirewallPolicyRequest, CallSettings)

public override Task<FirewallPolicyAssociation> GetAssociationAsync(GetAssociationFirewallPolicyRequest request, CallSettings callSettings = null)

Gets an association with the specified name.

Parameters
NameDescription
requestGetAssociationFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<FirewallPolicyAssociation>

A Task containing the RPC response.

Overrides

GetAsync(GetFirewallPolicyRequest, CallSettings)

public override Task<FirewallPolicy> GetAsync(GetFirewallPolicyRequest request, CallSettings callSettings = null)

Returns the specified firewall policy.

Parameters
NameDescription
requestGetFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<FirewallPolicy>

A Task containing the RPC response.

Overrides

GetIamPolicy(GetIamPolicyFirewallPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyFirewallPolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
requestGetIamPolicyFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Overrides

GetIamPolicyAsync(GetIamPolicyFirewallPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyFirewallPolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
requestGetIamPolicyFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Policy>

A Task containing the RPC response.

Overrides

GetRule(GetRuleFirewallPolicyRequest, CallSettings)

public override FirewallPolicyRule GetRule(GetRuleFirewallPolicyRequest request, CallSettings callSettings = null)

Gets a rule of the specified priority.

Parameters
NameDescription
requestGetRuleFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
FirewallPolicyRule

The RPC response.

Overrides

GetRuleAsync(GetRuleFirewallPolicyRequest, CallSettings)

public override Task<FirewallPolicyRule> GetRuleAsync(GetRuleFirewallPolicyRequest request, CallSettings callSettings = null)

Gets a rule of the specified priority.

Parameters
NameDescription
requestGetRuleFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<FirewallPolicyRule>

A Task containing the RPC response.

Overrides

Insert(InsertFirewallPolicyRequest, CallSettings)

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

Creates a new policy in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

InsertAsync(InsertFirewallPolicyRequest, CallSettings)

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

Creates a new policy in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

List(ListFirewallPoliciesRequest, CallSettings)

public override PagedEnumerable<FirewallPolicyList, FirewallPolicy> List(ListFirewallPoliciesRequest request, CallSettings callSettings = null)

Lists all the policies that have been configured for the specified folder or organization.

Parameters
NameDescription
requestListFirewallPoliciesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<FirewallPolicyList, FirewallPolicy>

A pageable sequence of FirewallPolicy resources.

Overrides

ListAssociations(ListAssociationsFirewallPolicyRequest, CallSettings)

public override FirewallPoliciesListAssociationsResponse ListAssociations(ListAssociationsFirewallPolicyRequest request, CallSettings callSettings = null)

Lists associations of a specified target, i.e., organization or folder.

Parameters
NameDescription
requestListAssociationsFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
FirewallPoliciesListAssociationsResponse

The RPC response.

Overrides

ListAssociationsAsync(ListAssociationsFirewallPolicyRequest, CallSettings)

public override Task<FirewallPoliciesListAssociationsResponse> ListAssociationsAsync(ListAssociationsFirewallPolicyRequest request, CallSettings callSettings = null)

Lists associations of a specified target, i.e., organization or folder.

Parameters
NameDescription
requestListAssociationsFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<FirewallPoliciesListAssociationsResponse>

A Task containing the RPC response.

Overrides

ListAsync(ListFirewallPoliciesRequest, CallSettings)

public override PagedAsyncEnumerable<FirewallPolicyList, FirewallPolicy> ListAsync(ListFirewallPoliciesRequest request, CallSettings callSettings = null)

Lists all the policies that have been configured for the specified folder or organization.

Parameters
NameDescription
requestListFirewallPoliciesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<FirewallPolicyList, FirewallPolicy>

A pageable asynchronous sequence of FirewallPolicy resources.

Overrides

Move(MoveFirewallPolicyRequest, CallSettings)

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

Moves the specified firewall policy.

Parameters
NameDescription
requestMoveFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

MoveAsync(MoveFirewallPolicyRequest, CallSettings)

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

Moves the specified firewall policy.

Parameters
NameDescription
requestMoveFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

Patch(PatchFirewallPolicyRequest, CallSettings)

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

Patches the specified policy with the data included in the request.

Parameters
NameDescription
requestPatchFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

PatchAsync(PatchFirewallPolicyRequest, CallSettings)

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

Patches the specified policy with the data included in the request.

Parameters
NameDescription
requestPatchFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

PatchRule(PatchRuleFirewallPolicyRequest, CallSettings)

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

Patches a rule of the specified priority.

Parameters
NameDescription
requestPatchRuleFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

PatchRuleAsync(PatchRuleFirewallPolicyRequest, CallSettings)

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

Patches a rule of the specified priority.

Parameters
NameDescription
requestPatchRuleFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

RemoveAssociation(RemoveAssociationFirewallPolicyRequest, CallSettings)

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

Removes an association for the specified firewall policy.

Parameters
NameDescription
requestRemoveAssociationFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

RemoveAssociationAsync(RemoveAssociationFirewallPolicyRequest, CallSettings)

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

Removes an association for the specified firewall policy.

Parameters
NameDescription
requestRemoveAssociationFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

RemoveRule(RemoveRuleFirewallPolicyRequest, CallSettings)

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

Deletes a rule of the specified priority.

Parameters
NameDescription
requestRemoveRuleFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

RemoveRuleAsync(RemoveRuleFirewallPolicyRequest, CallSettings)

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

Deletes a rule of the specified priority.

Parameters
NameDescription
requestRemoveRuleFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

SetIamPolicy(SetIamPolicyFirewallPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyFirewallPolicyRequest request, CallSettings callSettings = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Overrides

SetIamPolicyAsync(SetIamPolicyFirewallPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyFirewallPolicyRequest request, CallSettings callSettings = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Policy>

A Task containing the RPC response.

Overrides

TestIamPermissions(TestIamPermissionsFirewallPolicyRequest, CallSettings)

public override TestPermissionsResponse TestIamPermissions(TestIamPermissionsFirewallPolicyRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TestPermissionsResponse

The RPC response.

Overrides

TestIamPermissionsAsync(TestIamPermissionsFirewallPolicyRequest, CallSettings)

public override Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsFirewallPolicyRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TestPermissionsResponse>

A Task containing the RPC response.

Overrides