Class Firewall.FirewallClient (2.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public class FirewallClient : ClientBase<Firewall.FirewallClient>

Client for Firewall

Inheritance

Object > ClientBase > ClientBase<Firewall.FirewallClient> > Firewall.FirewallClient

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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

FirewallClient(ChannelBase)

public FirewallClient(ChannelBase channel)

Creates a new client for Firewall

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

FirewallClient(ClientBase.ClientBaseConfiguration)

protected FirewallClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

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
NameDescription
requestBatchUpdateIngressRulesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
BatchUpdateIngressRulesResponse

The response received from the server.

BatchUpdateIngressRules(BatchUpdateIngressRulesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestBatchUpdateIngressRulesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<BatchUpdateIngressRulesResponse>

The call object.

BatchUpdateIngressRulesAsync(BatchUpdateIngressRulesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<BatchUpdateIngressRulesResponse>

The call object.

CreateIngressRule(CreateIngressRuleRequest, CallOptions)

public virtual FirewallRule CreateIngressRule(CreateIngressRuleRequest request, CallOptions options)

Creates a firewall rule for the application.

Parameters
NameDescription
requestCreateIngressRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
FirewallRule

The response received from the server.

CreateIngressRule(CreateIngressRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a firewall rule for the application.

Parameters
NameDescription
requestCreateIngressRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestCreateIngressRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<FirewallRule>

The call object.

CreateIngressRuleAsync(CreateIngressRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a firewall rule for the application.

Parameters
NameDescription
requestCreateIngressRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<FirewallRule>

The call object.

DeleteIngressRule(DeleteIngressRuleRequest, CallOptions)

public virtual Empty DeleteIngressRule(DeleteIngressRuleRequest request, CallOptions options)

Deletes the specified firewall rule.

Parameters
NameDescription
requestDeleteIngressRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteIngressRule(DeleteIngressRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified firewall rule.

Parameters
NameDescription
requestDeleteIngressRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestDeleteIngressRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteIngressRuleAsync(DeleteIngressRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified firewall rule.

Parameters
NameDescription
requestDeleteIngressRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

GetIngressRule(GetIngressRuleRequest, CallOptions)

public virtual FirewallRule GetIngressRule(GetIngressRuleRequest request, CallOptions options)

Gets the specified firewall rule.

Parameters
NameDescription
requestGetIngressRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
FirewallRule

The response received from the server.

GetIngressRule(GetIngressRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets the specified firewall rule.

Parameters
NameDescription
requestGetIngressRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestGetIngressRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<FirewallRule>

The call object.

GetIngressRuleAsync(GetIngressRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets the specified firewall rule.

Parameters
NameDescription
requestGetIngressRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<FirewallRule>

The call object.

ListIngressRules(ListIngressRulesRequest, CallOptions)

public virtual ListIngressRulesResponse ListIngressRules(ListIngressRulesRequest request, CallOptions options)

Lists the firewall rules of an application.

Parameters
NameDescription
requestListIngressRulesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListIngressRulesResponse

The response received from the server.

ListIngressRules(ListIngressRulesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists the firewall rules of an application.

Parameters
NameDescription
requestListIngressRulesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListIngressRulesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListIngressRulesResponse>

The call object.

ListIngressRulesAsync(ListIngressRulesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists the firewall rules of an application.

Parameters
NameDescription
requestListIngressRulesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListIngressRulesResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
Firewall.FirewallClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.AppEngine.V1.Firewall.FirewallClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateIngressRule(UpdateIngressRuleRequest, CallOptions)

public virtual FirewallRule UpdateIngressRule(UpdateIngressRuleRequest request, CallOptions options)

Updates the specified firewall rule.

Parameters
NameDescription
requestUpdateIngressRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
FirewallRule

The response received from the server.

UpdateIngressRule(UpdateIngressRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the specified firewall rule.

Parameters
NameDescription
requestUpdateIngressRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestUpdateIngressRuleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<FirewallRule>

The call object.

UpdateIngressRuleAsync(UpdateIngressRuleRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the specified firewall rule.

Parameters
NameDescription
requestUpdateIngressRuleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<FirewallRule>

The call object.