App Engine v1 API - Class Firewall.FirewallClient (2.2.0)

Version 2.2.0

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

public class Firewall.FirewallClient : ClientBase<Firewall.FirewallClient>

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

Client for Firewall

Inheritance

object > ClientBase > ClientBaseFirewallFirewallClient > Firewall.FirewallClient

Inherited Members

ClientBase<Firewall.FirewallClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Constructors

FirewallClient()

protected FirewallClient()

Protected parameterless constructor to allow creation of test doubles.

FirewallClient(CallInvoker)

public FirewallClient(CallInvoker callInvoker)

Creates a new client for Firewall that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

FirewallClient(ChannelBase)

public FirewallClient(ChannelBase channel)

Creates a new client for Firewall

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

FirewallClient(ClientBaseConfiguration)

protected FirewallClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

BatchUpdateIngressRules(BatchUpdateIngressRulesRequest, CallOptions)

public virtual BatchUpdateIngressRulesResponse BatchUpdateIngressRules(BatchUpdateIngressRulesRequest request, CallOptions options)

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
Name	Description
request	BatchUpdateIngressRulesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
BatchUpdateIngressRulesResponse	The response received from the server.

BatchUpdateIngressRules(BatchUpdateIngressRulesRequest, Metadata, DateTime?, CancellationToken)

public virtual BatchUpdateIngressRulesResponse BatchUpdateIngressRules(BatchUpdateIngressRulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
Name	Description
request	BatchUpdateIngressRulesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
BatchUpdateIngressRulesResponse	The response received from the server.

BatchUpdateIngressRulesAsync(BatchUpdateIngressRulesRequest, CallOptions)

public virtual AsyncUnaryCall<BatchUpdateIngressRulesResponse> BatchUpdateIngressRulesAsync(BatchUpdateIngressRulesRequest request, CallOptions options)

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
Name	Description
request	BatchUpdateIngressRulesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallBatchUpdateIngressRulesResponse	The call object.

BatchUpdateIngressRulesAsync(BatchUpdateIngressRulesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BatchUpdateIngressRulesResponse> BatchUpdateIngressRulesAsync(BatchUpdateIngressRulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
Name	Description
request	BatchUpdateIngressRulesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallBatchUpdateIngressRulesResponse	The call object.

CreateIngressRule(CreateIngressRuleRequest, CallOptions)

public virtual FirewallRule CreateIngressRule(CreateIngressRuleRequest request, CallOptions options)

Creates a firewall rule for the application.

Parameters
Name	Description
request	CreateIngressRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
FirewallRule	The response received from the server.

CreateIngressRule(CreateIngressRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual FirewallRule CreateIngressRule(CreateIngressRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a firewall rule for the application.

Parameters
Name	Description
request	CreateIngressRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
FirewallRule	The response received from the server.

CreateIngressRuleAsync(CreateIngressRuleRequest, CallOptions)

public virtual AsyncUnaryCall<FirewallRule> CreateIngressRuleAsync(CreateIngressRuleRequest request, CallOptions options)

Creates a firewall rule for the application.

Parameters
Name	Description
request	CreateIngressRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallFirewallRule	The call object.

CreateIngressRuleAsync(CreateIngressRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FirewallRule> CreateIngressRuleAsync(CreateIngressRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a firewall rule for the application.

Parameters
Name	Description
request	CreateIngressRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallFirewallRule	The call object.

DeleteIngressRule(DeleteIngressRuleRequest, CallOptions)

public virtual Empty DeleteIngressRule(DeleteIngressRuleRequest request, CallOptions options)

Deletes the specified firewall rule.

Parameters
Name	Description
request	DeleteIngressRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteIngressRule(DeleteIngressRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteIngressRule(DeleteIngressRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified firewall rule.

Parameters
Name	Description
request	DeleteIngressRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteIngressRuleAsync(DeleteIngressRuleRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteIngressRuleAsync(DeleteIngressRuleRequest request, CallOptions options)

Deletes the specified firewall rule.

Parameters
Name	Description
request	DeleteIngressRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteIngressRuleAsync(DeleteIngressRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteIngressRuleAsync(DeleteIngressRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified firewall rule.

Parameters
Name	Description
request	DeleteIngressRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

GetIngressRule(GetIngressRuleRequest, CallOptions)

public virtual FirewallRule GetIngressRule(GetIngressRuleRequest request, CallOptions options)

Gets the specified firewall rule.

Parameters
Name	Description
request	GetIngressRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
FirewallRule	The response received from the server.

GetIngressRule(GetIngressRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual FirewallRule GetIngressRule(GetIngressRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the specified firewall rule.

Parameters
Name	Description
request	GetIngressRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
FirewallRule	The response received from the server.

GetIngressRuleAsync(GetIngressRuleRequest, CallOptions)

public virtual AsyncUnaryCall<FirewallRule> GetIngressRuleAsync(GetIngressRuleRequest request, CallOptions options)

Gets the specified firewall rule.

Parameters
Name	Description
request	GetIngressRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallFirewallRule	The call object.

GetIngressRuleAsync(GetIngressRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FirewallRule> GetIngressRuleAsync(GetIngressRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the specified firewall rule.

Parameters
Name	Description
request	GetIngressRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallFirewallRule	The call object.

ListIngressRules(ListIngressRulesRequest, CallOptions)

public virtual ListIngressRulesResponse ListIngressRules(ListIngressRulesRequest request, CallOptions options)

Lists the firewall rules of an application.

Parameters
Name	Description
request	ListIngressRulesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListIngressRulesResponse	The response received from the server.

ListIngressRules(ListIngressRulesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListIngressRulesResponse ListIngressRules(ListIngressRulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the firewall rules of an application.

Parameters
Name	Description
request	ListIngressRulesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListIngressRulesResponse	The response received from the server.

ListIngressRulesAsync(ListIngressRulesRequest, CallOptions)

public virtual AsyncUnaryCall<ListIngressRulesResponse> ListIngressRulesAsync(ListIngressRulesRequest request, CallOptions options)

Lists the firewall rules of an application.

Parameters
Name	Description
request	ListIngressRulesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListIngressRulesResponse	The call object.

ListIngressRulesAsync(ListIngressRulesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListIngressRulesResponse> ListIngressRulesAsync(ListIngressRulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the firewall rules of an application.

Parameters
Name	Description
request	ListIngressRulesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListIngressRulesResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override Firewall.FirewallClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
FirewallFirewallClient

Overrides

ClientBase<Firewall.FirewallClient>.NewInstance(ClientBase.ClientBaseConfiguration)

UpdateIngressRule(UpdateIngressRuleRequest, CallOptions)

public virtual FirewallRule UpdateIngressRule(UpdateIngressRuleRequest request, CallOptions options)

Updates the specified firewall rule.

Parameters
Name	Description
request	UpdateIngressRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
FirewallRule	The response received from the server.

UpdateIngressRule(UpdateIngressRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual FirewallRule UpdateIngressRule(UpdateIngressRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified firewall rule.

Parameters
Name	Description
request	UpdateIngressRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
FirewallRule	The response received from the server.

UpdateIngressRuleAsync(UpdateIngressRuleRequest, CallOptions)

public virtual AsyncUnaryCall<FirewallRule> UpdateIngressRuleAsync(UpdateIngressRuleRequest request, CallOptions options)

Updates the specified firewall rule.

Parameters
Name	Description
request	UpdateIngressRuleRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallFirewallRule	The call object.

UpdateIngressRuleAsync(UpdateIngressRuleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FirewallRule> UpdateIngressRuleAsync(UpdateIngressRuleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified firewall rule.

Parameters
Name	Description
request	UpdateIngressRuleRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallFirewallRule	The call object.