Compute Engine v1 API - Class RegionSecurityPolicies.RegionSecurityPoliciesClient (2.13.0)

public class RegionSecurityPolicies.RegionSecurityPoliciesClient : ClientBase<RegionSecurityPolicies.RegionSecurityPoliciesClient>

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

Client for RegionSecurityPolicies

Inheritance

object > ClientBase > ClientBaseRegionSecurityPoliciesRegionSecurityPoliciesClient > RegionSecurityPolicies.RegionSecurityPoliciesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RegionSecurityPoliciesClient()

protected RegionSecurityPoliciesClient()

Protected parameterless constructor to allow creation of test doubles.

RegionSecurityPoliciesClient(CallInvoker)

public RegionSecurityPoliciesClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

RegionSecurityPoliciesClient(ChannelBase)

public RegionSecurityPoliciesClient(ChannelBase channel)

Creates a new client for RegionSecurityPolicies

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

RegionSecurityPoliciesClient(ClientBaseConfiguration)

protected RegionSecurityPoliciesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

AddRule(AddRuleRegionSecurityPolicyRequest, CallOptions)

public virtual Operation AddRule(AddRuleRegionSecurityPolicyRequest request, CallOptions options)

Inserts a rule into a security policy.

Parameters
NameDescription
requestAddRuleRegionSecurityPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

AddRule(AddRuleRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Inserts a rule into a security policy.

Parameters
NameDescription
requestAddRuleRegionSecurityPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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.

AddRuleAsync(AddRuleRegionSecurityPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> AddRuleAsync(AddRuleRegionSecurityPolicyRequest request, CallOptions options)

Inserts a rule into a security policy.

Parameters
NameDescription
requestAddRuleRegionSecurityPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

AddRuleAsync(AddRuleRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Inserts a rule into a security policy.

Parameters
NameDescription
requestAddRuleRegionSecurityPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.

CreateOperationsClientForRegionOperations()

public virtual Operations.OperationsClient CreateOperationsClientForRegionOperations()

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

Returns
TypeDescription
OperationsOperationsClient

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

Delete(DeleteRegionSecurityPolicyRequest, CallOptions)

public virtual Operation Delete(DeleteRegionSecurityPolicyRequest request, CallOptions options)

Deletes the specified policy.

Parameters
NameDescription
requestDeleteRegionSecurityPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeleteRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified policy.

Parameters
NameDescription
requestDeleteRegionSecurityPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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(DeleteRegionSecurityPolicyRequest, CallOptions)

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

Deletes the specified policy.

Parameters
NameDescription
requestDeleteRegionSecurityPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeleteRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified policy.

Parameters
NameDescription
requestDeleteRegionSecurityPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.

Get(GetRegionSecurityPolicyRequest, CallOptions)

public virtual SecurityPolicy Get(GetRegionSecurityPolicyRequest request, CallOptions options)

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

Parameters
NameDescription
requestGetRegionSecurityPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
SecurityPolicy

The response received from the server.

Get(GetRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestGetRegionSecurityPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
SecurityPolicy

The response received from the server.

GetAsync(GetRegionSecurityPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<SecurityPolicy> GetAsync(GetRegionSecurityPolicyRequest request, CallOptions options)

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

Parameters
NameDescription
requestGetRegionSecurityPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallSecurityPolicy

The call object.

GetAsync(GetRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestGetRegionSecurityPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallSecurityPolicy

The call object.

GetRule(GetRuleRegionSecurityPolicyRequest, CallOptions)

public virtual SecurityPolicyRule GetRule(GetRuleRegionSecurityPolicyRequest request, CallOptions options)

Gets a rule at the specified priority.

Parameters
NameDescription
requestGetRuleRegionSecurityPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
SecurityPolicyRule

The response received from the server.

GetRule(GetRuleRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual SecurityPolicyRule GetRule(GetRuleRegionSecurityPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a rule at the specified priority.

Parameters
NameDescription
requestGetRuleRegionSecurityPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
SecurityPolicyRule

The response received from the server.

GetRuleAsync(GetRuleRegionSecurityPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<SecurityPolicyRule> GetRuleAsync(GetRuleRegionSecurityPolicyRequest request, CallOptions options)

Gets a rule at the specified priority.

Parameters
NameDescription
requestGetRuleRegionSecurityPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallSecurityPolicyRule

The call object.

GetRuleAsync(GetRuleRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SecurityPolicyRule> GetRuleAsync(GetRuleRegionSecurityPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a rule at the specified priority.

Parameters
NameDescription
requestGetRuleRegionSecurityPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallSecurityPolicyRule

The call object.

Insert(InsertRegionSecurityPolicyRequest, CallOptions)

public virtual Operation Insert(InsertRegionSecurityPolicyRequest request, CallOptions options)

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

Parameters
NameDescription
requestInsertRegionSecurityPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestInsertRegionSecurityPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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(InsertRegionSecurityPolicyRequest, CallOptions)

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

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

Parameters
NameDescription
requestInsertRegionSecurityPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestInsertRegionSecurityPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.

List(ListRegionSecurityPoliciesRequest, CallOptions)

public virtual SecurityPolicyList List(ListRegionSecurityPoliciesRequest request, CallOptions options)

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

Parameters
NameDescription
requestListRegionSecurityPoliciesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
SecurityPolicyList

The response received from the server.

List(ListRegionSecurityPoliciesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestListRegionSecurityPoliciesRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
SecurityPolicyList

The response received from the server.

ListAsync(ListRegionSecurityPoliciesRequest, CallOptions)

public virtual AsyncUnaryCall<SecurityPolicyList> ListAsync(ListRegionSecurityPoliciesRequest request, CallOptions options)

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

Parameters
NameDescription
requestListRegionSecurityPoliciesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallSecurityPolicyList

The call object.

ListAsync(ListRegionSecurityPoliciesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestListRegionSecurityPoliciesRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallSecurityPolicyList

The call object.

NewInstance(ClientBaseConfiguration)

protected override RegionSecurityPolicies.RegionSecurityPoliciesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
RegionSecurityPoliciesRegionSecurityPoliciesClient
Overrides

Patch(PatchRegionSecurityPolicyRequest, CallOptions)

public virtual Operation Patch(PatchRegionSecurityPolicyRequest request, CallOptions options)

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Patch(PatchRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

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

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

The request to send to the server.

headersMetadata

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

deadlineDateTime

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(PatchRegionSecurityPolicyRequest, CallOptions)

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

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

PatchAsync(PatchRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

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

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

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.

PatchRule(PatchRuleRegionSecurityPolicyRequest, CallOptions)

public virtual Operation PatchRule(PatchRuleRegionSecurityPolicyRequest request, CallOptions options)

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

Parameters
NameDescription
requestPatchRuleRegionSecurityPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

PatchRule(PatchRuleRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestPatchRuleRegionSecurityPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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.

PatchRuleAsync(PatchRuleRegionSecurityPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchRuleAsync(PatchRuleRegionSecurityPolicyRequest request, CallOptions options)

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

Parameters
NameDescription
requestPatchRuleRegionSecurityPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

PatchRuleAsync(PatchRuleRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestPatchRuleRegionSecurityPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.

RemoveRule(RemoveRuleRegionSecurityPolicyRequest, CallOptions)

public virtual Operation RemoveRule(RemoveRuleRegionSecurityPolicyRequest request, CallOptions options)

Deletes a rule at the specified priority.

Parameters
NameDescription
requestRemoveRuleRegionSecurityPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RemoveRule(RemoveRuleRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a rule at the specified priority.

Parameters
NameDescription
requestRemoveRuleRegionSecurityPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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.

RemoveRuleAsync(RemoveRuleRegionSecurityPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RemoveRuleAsync(RemoveRuleRegionSecurityPolicyRequest request, CallOptions options)

Deletes a rule at the specified priority.

Parameters
NameDescription
requestRemoveRuleRegionSecurityPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

RemoveRuleAsync(RemoveRuleRegionSecurityPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a rule at the specified priority.

Parameters
NameDescription
requestRemoveRuleRegionSecurityPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.