Compute Engine v1 API - Class Firewalls.FirewallsClient (2.5.0)

public class FirewallsClient : ClientBase<Firewalls.FirewallsClient>

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

Client for Firewalls

Inheritance

Object > ClientBase > ClientBase<Firewalls.FirewallsClient> > Firewalls.FirewallsClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

FirewallsClient()

protected FirewallsClient()

Protected parameterless constructor to allow creation of test doubles.

FirewallsClient(CallInvoker)

public FirewallsClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

FirewallsClient(ChannelBase)

public FirewallsClient(ChannelBase channel)

Creates a new client for Firewalls

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

FirewallsClient(ClientBase.ClientBaseConfiguration)

protected FirewallsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateOperationsClientForGlobalOperations()

public virtual Operations.OperationsClient CreateOperationsClientForGlobalOperations()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to GlobalOperations.

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

Delete(DeleteFirewallRequest, CallOptions)

public virtual Operation Delete(DeleteFirewallRequest request, CallOptions options)

Deletes the specified firewall.

Parameters
NameDescription
requestDeleteFirewallRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeleteFirewallRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation Delete(DeleteFirewallRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified firewall.

Parameters
NameDescription
requestDeleteFirewallRequest

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
Operation

The response received from the server.

DeleteAsync(DeleteFirewallRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteFirewallRequest request, CallOptions options)

Deletes the specified firewall.

Parameters
NameDescription
requestDeleteFirewallRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteAsync(DeleteFirewallRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteFirewallRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified firewall.

Parameters
NameDescription
requestDeleteFirewallRequest

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

The call object.

Get(GetFirewallRequest, CallOptions)

public virtual Firewall Get(GetFirewallRequest request, CallOptions options)

Returns the specified firewall.

Parameters
NameDescription
requestGetFirewallRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Firewall

The response received from the server.

Get(GetFirewallRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Firewall Get(GetFirewallRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the specified firewall.

Parameters
NameDescription
requestGetFirewallRequest

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
Firewall

The response received from the server.

GetAsync(GetFirewallRequest, CallOptions)

public virtual AsyncUnaryCall<Firewall> GetAsync(GetFirewallRequest request, CallOptions options)

Returns the specified firewall.

Parameters
NameDescription
requestGetFirewallRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Firewall>

The call object.

GetAsync(GetFirewallRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Firewall> GetAsync(GetFirewallRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the specified firewall.

Parameters
NameDescription
requestGetFirewallRequest

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

The call object.

Insert(InsertFirewallRequest, CallOptions)

public virtual Operation Insert(InsertFirewallRequest request, CallOptions options)

Creates a firewall rule in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertFirewallRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertFirewallRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation Insert(InsertFirewallRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a firewall rule in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertFirewallRequest

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
Operation

The response received from the server.

InsertAsync(InsertFirewallRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertFirewallRequest request, CallOptions options)

Creates a firewall rule in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertFirewallRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

InsertAsync(InsertFirewallRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertFirewallRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a firewall rule in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertFirewallRequest

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

The call object.

List(ListFirewallsRequest, CallOptions)

public virtual FirewallList List(ListFirewallsRequest request, CallOptions options)

Retrieves the list of firewall rules available to the specified project.

Parameters
NameDescription
requestListFirewallsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
FirewallList

The response received from the server.

List(ListFirewallsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual FirewallList List(ListFirewallsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves the list of firewall rules available to the specified project.

Parameters
NameDescription
requestListFirewallsRequest

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
FirewallList

The response received from the server.

ListAsync(ListFirewallsRequest, CallOptions)

public virtual AsyncUnaryCall<FirewallList> ListAsync(ListFirewallsRequest request, CallOptions options)

Retrieves the list of firewall rules available to the specified project.

Parameters
NameDescription
requestListFirewallsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<FirewallList>

The call object.

ListAsync(ListFirewallsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<FirewallList> ListAsync(ListFirewallsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves the list of firewall rules available to the specified project.

Parameters
NameDescription
requestListFirewallsRequest

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

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Firewalls.FirewallsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
Firewalls.FirewallsClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.Firewalls.FirewallsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchFirewallRequest, CallOptions)

public virtual Operation Patch(PatchFirewallRequest request, CallOptions options)

Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchFirewallRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Patch(PatchFirewallRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation Patch(PatchFirewallRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchFirewallRequest

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
Operation

The response received from the server.

PatchAsync(PatchFirewallRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchFirewallRequest request, CallOptions options)

Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchFirewallRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

PatchAsync(PatchFirewallRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchFirewallRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchFirewallRequest

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

The call object.

Update(UpdateFirewallRequest, CallOptions)

public virtual Operation Update(UpdateFirewallRequest request, CallOptions options)

Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.

Parameters
NameDescription
requestUpdateFirewallRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Update(UpdateFirewallRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation Update(UpdateFirewallRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.

Parameters
NameDescription
requestUpdateFirewallRequest

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
Operation

The response received from the server.

UpdateAsync(UpdateFirewallRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateAsync(UpdateFirewallRequest request, CallOptions options)

Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.

Parameters
NameDescription
requestUpdateFirewallRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateAsync(UpdateFirewallRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateAsync(UpdateFirewallRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.

Parameters
NameDescription
requestUpdateFirewallRequest

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

The call object.