App Engine v1 API - Class FirewallClientImpl (2.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class FirewallClientImpl : FirewallClient

Reference documentation and code samples for the App Engine v1 API class FirewallClientImpl.

Firewall client wrapper implementation, for convenient use.

Inheritance

Object > FirewallClient > FirewallClientImpl

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Remarks

Firewall resources are used to define a collection of access control rules for an Application. Each rule is defined with a position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests.

Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies an action that applies to all remaining IP addresses. The default final rule for a newly-created application will be set to "allow" if not otherwise specified by the user.

Constructors

FirewallClientImpl(Firewall.FirewallClient, FirewallSettings, ILogger)

public FirewallClientImpl(Firewall.FirewallClient grpcClient, FirewallSettings settings, ILogger logger)

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

Parameters
NameDescription
grpcClientFirewall.FirewallClient

The underlying gRPC client.

settingsFirewallSettings

The base FirewallSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override Firewall.FirewallClient GrpcClient { get; }

The underlying gRPC Firewall client

Property Value
TypeDescription
Firewall.FirewallClient
Overrides

Methods

BatchUpdateIngressRules(BatchUpdateIngressRulesRequest, CallSettings)

public override BatchUpdateIngressRulesResponse BatchUpdateIngressRules(BatchUpdateIngressRulesRequest request, CallSettings callSettings = null)

Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.

If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.

Parameters
NameDescription
requestBatchUpdateIngressRulesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
BatchUpdateIngressRulesResponse

The RPC response.

Overrides

BatchUpdateIngressRulesAsync(BatchUpdateIngressRulesRequest, CallSettings)

public override Task<BatchUpdateIngressRulesResponse> BatchUpdateIngressRulesAsync(BatchUpdateIngressRulesRequest request, CallSettings callSettings = null)

Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.

If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.

Parameters
NameDescription
requestBatchUpdateIngressRulesRequest

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

A Task containing the RPC response.

Overrides

CreateIngressRule(CreateIngressRuleRequest, CallSettings)

public override FirewallRule CreateIngressRule(CreateIngressRuleRequest request, CallSettings callSettings = null)

Creates a firewall rule for the application.

Parameters
NameDescription
requestCreateIngressRuleRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
FirewallRule

The RPC response.

Overrides

CreateIngressRuleAsync(CreateIngressRuleRequest, CallSettings)

public override Task<FirewallRule> CreateIngressRuleAsync(CreateIngressRuleRequest request, CallSettings callSettings = null)

Creates a firewall rule for the application.

Parameters
NameDescription
requestCreateIngressRuleRequest

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

A Task containing the RPC response.

Overrides

DeleteIngressRule(DeleteIngressRuleRequest, CallSettings)

public override void DeleteIngressRule(DeleteIngressRuleRequest request, CallSettings callSettings = null)

Deletes the specified firewall rule.

Parameters
NameDescription
requestDeleteIngressRuleRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteIngressRuleAsync(DeleteIngressRuleRequest, CallSettings)

public override Task DeleteIngressRuleAsync(DeleteIngressRuleRequest request, CallSettings callSettings = null)

Deletes the specified firewall rule.

Parameters
NameDescription
requestDeleteIngressRuleRequest

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

A Task containing the RPC response.

Overrides

GetIngressRule(GetIngressRuleRequest, CallSettings)

public override FirewallRule GetIngressRule(GetIngressRuleRequest request, CallSettings callSettings = null)

Gets the specified firewall rule.

Parameters
NameDescription
requestGetIngressRuleRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
FirewallRule

The RPC response.

Overrides

GetIngressRuleAsync(GetIngressRuleRequest, CallSettings)

public override Task<FirewallRule> GetIngressRuleAsync(GetIngressRuleRequest request, CallSettings callSettings = null)

Gets the specified firewall rule.

Parameters
NameDescription
requestGetIngressRuleRequest

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

A Task containing the RPC response.

Overrides

ListIngressRules(ListIngressRulesRequest, CallSettings)

public override PagedEnumerable<ListIngressRulesResponse, FirewallRule> ListIngressRules(ListIngressRulesRequest request, CallSettings callSettings = null)

Lists the firewall rules of an application.

Parameters
NameDescription
requestListIngressRulesRequest

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<ListIngressRulesResponse, FirewallRule>

A pageable sequence of FirewallRule resources.

Overrides

ListIngressRulesAsync(ListIngressRulesRequest, CallSettings)

public override PagedAsyncEnumerable<ListIngressRulesResponse, FirewallRule> ListIngressRulesAsync(ListIngressRulesRequest request, CallSettings callSettings = null)

Lists the firewall rules of an application.

Parameters
NameDescription
requestListIngressRulesRequest

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<ListIngressRulesResponse, FirewallRule>

A pageable asynchronous sequence of FirewallRule resources.

Overrides

UpdateIngressRule(UpdateIngressRuleRequest, CallSettings)

public override FirewallRule UpdateIngressRule(UpdateIngressRuleRequest request, CallSettings callSettings = null)

Updates the specified firewall rule.

Parameters
NameDescription
requestUpdateIngressRuleRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
FirewallRule

The RPC response.

Overrides

UpdateIngressRuleAsync(UpdateIngressRuleRequest, CallSettings)

public override Task<FirewallRule> UpdateIngressRuleAsync(UpdateIngressRuleRequest request, CallSettings callSettings = null)

Updates the specified firewall rule.

Parameters
NameDescription
requestUpdateIngressRuleRequest

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

A Task containing the RPC response.

Overrides