Compute Engine v1 API - Class SecurityPoliciesClientImpl (2.16.0)

public sealed class SecurityPoliciesClientImpl : SecurityPoliciesClient

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

SecurityPolicies client wrapper implementation, for convenient use.

Inheritance

object > SecurityPoliciesClient > SecurityPoliciesClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The SecurityPolicies API.

Constructors

SecurityPoliciesClientImpl(SecurityPoliciesClient, SecurityPoliciesSettings, ILogger)

public SecurityPoliciesClientImpl(SecurityPolicies.SecurityPoliciesClient grpcClient, SecurityPoliciesSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient SecurityPoliciesSecurityPoliciesClient

The underlying gRPC client.
settings SecurityPoliciesSettings

The base SecurityPoliciesSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

AddRuleOperationsClient

public override OperationsClient AddRuleOperationsClient { get; }

The long-running operations client for AddRule.

Property Value
Type Description
OperationsClient
Overrides

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override SecurityPolicies.SecurityPoliciesClient GrpcClient { get; }

The underlying gRPC SecurityPolicies client

Property Value
Type Description
SecurityPoliciesSecurityPoliciesClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient
Overrides

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type Description
OperationsClient
Overrides

PatchRuleOperationsClient

public override OperationsClient PatchRuleOperationsClient { get; }

The long-running operations client for PatchRule.

Property Value
Type Description
OperationsClient
Overrides

RemoveRuleOperationsClient

public override OperationsClient RemoveRuleOperationsClient { get; }

The long-running operations client for RemoveRule.

Property Value
Type Description
OperationsClient
Overrides

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type Description
OperationsClient
Overrides

Methods

AddRule(AddRuleSecurityPolicyRequest, CallSettings)

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

Inserts a rule into a security policy.

Parameters
Name Description
request AddRuleSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

AddRuleAsync(AddRuleSecurityPolicyRequest, CallSettings)

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

Inserts a rule into a security policy.

Parameters
Name Description
request AddRuleSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

AggregatedList(AggregatedListSecurityPoliciesRequest, CallSettings)

public override PagedEnumerable<SecurityPoliciesAggregatedList, KeyValuePair<string, SecurityPoliciesScopedList>> AggregatedList(AggregatedListSecurityPoliciesRequest request, CallSettings callSettings = null)

Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListSecurityPoliciesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableSecurityPoliciesAggregatedListKeyValuePairstringSecurityPoliciesScopedList

A pageable sequence of KeyValuePair<TKey, TValue> resources.
Overrides

AggregatedListAsync(AggregatedListSecurityPoliciesRequest, CallSettings)

public override PagedAsyncEnumerable<SecurityPoliciesAggregatedList, KeyValuePair<string, SecurityPoliciesScopedList>> AggregatedListAsync(AggregatedListSecurityPoliciesRequest request, CallSettings callSettings = null)

Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListSecurityPoliciesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableSecurityPoliciesAggregatedListKeyValuePairstringSecurityPoliciesScopedList

A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.
Overrides

Delete(DeleteSecurityPolicyRequest, CallSettings)

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

Deletes the specified policy.

Parameters
Name Description
request DeleteSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

DeleteAsync(DeleteSecurityPolicyRequest, CallSettings)

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

Deletes the specified policy.

Parameters
Name Description
request DeleteSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

Get(GetSecurityPolicyRequest, CallSettings)

public override SecurityPolicy Get(GetSecurityPolicyRequest request, CallSettings callSettings = null)

List all of the ordered rules present in a single specified policy.

Parameters
Name Description
request GetSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
SecurityPolicy

The RPC response.
Overrides

GetAsync(GetSecurityPolicyRequest, CallSettings)

public override Task<SecurityPolicy> GetAsync(GetSecurityPolicyRequest request, CallSettings callSettings = null)

List all of the ordered rules present in a single specified policy.

Parameters
Name Description
request GetSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSecurityPolicy

A Task containing the RPC response.
Overrides

GetRule(GetRuleSecurityPolicyRequest, CallSettings)

public override SecurityPolicyRule GetRule(GetRuleSecurityPolicyRequest request, CallSettings callSettings = null)

Gets a rule at the specified priority.

Parameters
Name Description
request GetRuleSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
SecurityPolicyRule

The RPC response.
Overrides

GetRuleAsync(GetRuleSecurityPolicyRequest, CallSettings)

public override Task<SecurityPolicyRule> GetRuleAsync(GetRuleSecurityPolicyRequest request, CallSettings callSettings = null)

Gets a rule at the specified priority.

Parameters
Name Description
request GetRuleSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSecurityPolicyRule

A Task containing the RPC response.
Overrides

Insert(InsertSecurityPolicyRequest, CallSettings)

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

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

Parameters
Name Description
request InsertSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

InsertAsync(InsertSecurityPolicyRequest, CallSettings)

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

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

Parameters
Name Description
request InsertSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

List(ListSecurityPoliciesRequest, CallSettings)

public override PagedEnumerable<SecurityPolicyList, SecurityPolicy> List(ListSecurityPoliciesRequest request, CallSettings callSettings = null)

List all the policies that have been configured for the specified project.

Parameters
Name Description
request ListSecurityPoliciesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableSecurityPolicyListSecurityPolicy

A pageable sequence of SecurityPolicy resources.
Overrides

ListAsync(ListSecurityPoliciesRequest, CallSettings)

public override PagedAsyncEnumerable<SecurityPolicyList, SecurityPolicy> ListAsync(ListSecurityPoliciesRequest request, CallSettings callSettings = null)

List all the policies that have been configured for the specified project.

Parameters
Name Description
request ListSecurityPoliciesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableSecurityPolicyListSecurityPolicy

A pageable asynchronous sequence of SecurityPolicy resources.
Overrides

ListPreconfiguredExpressionSets(ListPreconfiguredExpressionSetsSecurityPoliciesRequest, CallSettings)

public override SecurityPoliciesListPreconfiguredExpressionSetsResponse ListPreconfiguredExpressionSets(ListPreconfiguredExpressionSetsSecurityPoliciesRequest request, CallSettings callSettings = null)

Gets the current list of preconfigured Web Application Firewall (WAF) expressions.

Parameters
Name Description
request ListPreconfiguredExpressionSetsSecurityPoliciesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
SecurityPoliciesListPreconfiguredExpressionSetsResponse

The RPC response.
Overrides

ListPreconfiguredExpressionSetsAsync(ListPreconfiguredExpressionSetsSecurityPoliciesRequest, CallSettings)

public override Task<SecurityPoliciesListPreconfiguredExpressionSetsResponse> ListPreconfiguredExpressionSetsAsync(ListPreconfiguredExpressionSetsSecurityPoliciesRequest request, CallSettings callSettings = null)

Gets the current list of preconfigured Web Application Firewall (WAF) expressions.

Parameters
Name Description
request ListPreconfiguredExpressionSetsSecurityPoliciesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSecurityPoliciesListPreconfiguredExpressionSetsResponse

A Task containing the RPC response.
Overrides

Patch(PatchSecurityPolicyRequest, CallSettings)

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

Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.

Parameters
Name Description
request PatchSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

PatchAsync(PatchSecurityPolicyRequest, CallSettings)

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

Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.

Parameters
Name Description
request PatchSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

PatchRule(PatchRuleSecurityPolicyRequest, CallSettings)

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

Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.

Parameters
Name Description
request PatchRuleSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

PatchRuleAsync(PatchRuleSecurityPolicyRequest, CallSettings)

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

Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.

Parameters
Name Description
request PatchRuleSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

RemoveRule(RemoveRuleSecurityPolicyRequest, CallSettings)

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

Deletes a rule at the specified priority.

Parameters
Name Description
request RemoveRuleSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

RemoveRuleAsync(RemoveRuleSecurityPolicyRequest, CallSettings)

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

Deletes a rule at the specified priority.

Parameters
Name Description
request RemoveRuleSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

SetLabels(SetLabelsSecurityPolicyRequest, CallSettings)

public override Operation<Operation, Operation> SetLabels(SetLabelsSecurityPolicyRequest request, CallSettings callSettings = null)

Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name Description
request SetLabelsSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

SetLabelsAsync(SetLabelsSecurityPolicyRequest, CallSettings)

public override Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsSecurityPolicyRequest request, CallSettings callSettings = null)

Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name Description
request SetLabelsSecurityPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides