FirewallPolicies

google.cloud.compute.v1. FirewallPolicies

Represents a FirewallPolicies

Constructor

new FirewallPolicies(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new FirewallPolicies service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

addAssociation(request, callback) → {undefined}

Calls AddAssociation.

Parameters:
Name Type Description
request google.cloud.compute.v1.IAddAssociationFirewallPolicyRequest

AddAssociationFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.AddAssociationCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

addAssociation(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls AddAssociation.

Parameters:
Name Type Description
request google.cloud.compute.v1.IAddAssociationFirewallPolicyRequest

AddAssociationFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

addRule(request, callback) → {undefined}

Calls AddRule.

Parameters:
Name Type Description
request google.cloud.compute.v1.IAddRuleFirewallPolicyRequest

AddRuleFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.AddRuleCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

addRule(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls AddRule.

Parameters:
Name Type Description
request google.cloud.compute.v1.IAddRuleFirewallPolicyRequest

AddRuleFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

cloneRules(request, callback) → {undefined}

Calls CloneRules.

Parameters:
Name Type Description
request google.cloud.compute.v1.ICloneRulesFirewallPolicyRequest

CloneRulesFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.CloneRulesCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

cloneRules(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls CloneRules.

Parameters:
Name Type Description
request google.cloud.compute.v1.ICloneRulesFirewallPolicyRequest

CloneRulesFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

delete(request, callback) → {undefined}

Calls Delete.

Parameters:
Name Type Description
request google.cloud.compute.v1.IDeleteFirewallPolicyRequest

DeleteFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.DeleteCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

delete(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Delete.

Parameters:
Name Type Description
request google.cloud.compute.v1.IDeleteFirewallPolicyRequest

DeleteFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

get(request, callback) → {undefined}

Calls Get.

Parameters:
Name Type Description
request google.cloud.compute.v1.IGetFirewallPolicyRequest

GetFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.GetCallback

Node-style callback called with the error, if any, and FirewallPolicy

Returns:
Type Description
undefined

get(request) → {Promise.<google.cloud.compute.v1.FirewallPolicy>}

Calls Get.

Parameters:
Name Type Description
request google.cloud.compute.v1.IGetFirewallPolicyRequest

GetFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.FirewallPolicy>

Promise

getAssociation(request, callback) → {undefined}

Calls GetAssociation.

Parameters:
Name Type Description
request google.cloud.compute.v1.IGetAssociationFirewallPolicyRequest

GetAssociationFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.GetAssociationCallback

Node-style callback called with the error, if any, and FirewallPolicyAssociation

Returns:
Type Description
undefined

getAssociation(request) → {Promise.<google.cloud.compute.v1.FirewallPolicyAssociation>}

Calls GetAssociation.

Parameters:
Name Type Description
request google.cloud.compute.v1.IGetAssociationFirewallPolicyRequest

GetAssociationFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.FirewallPolicyAssociation>

Promise

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.cloud.compute.v1.IGetIamPolicyFirewallPolicyRequest

GetIamPolicyFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.GetIamPolicyCallback

Node-style callback called with the error, if any, and Policy

Returns:
Type Description
undefined

getIamPolicy(request) → {Promise.<google.cloud.compute.v1.Policy>}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.cloud.compute.v1.IGetIamPolicyFirewallPolicyRequest

GetIamPolicyFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Policy>

Promise

getRule(request, callback) → {undefined}

Calls GetRule.

Parameters:
Name Type Description
request google.cloud.compute.v1.IGetRuleFirewallPolicyRequest

GetRuleFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.GetRuleCallback

Node-style callback called with the error, if any, and FirewallPolicyRule

Returns:
Type Description
undefined

getRule(request) → {Promise.<google.cloud.compute.v1.FirewallPolicyRule>}

Calls GetRule.

Parameters:
Name Type Description
request google.cloud.compute.v1.IGetRuleFirewallPolicyRequest

GetRuleFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.FirewallPolicyRule>

Promise

insert(request, callback) → {undefined}

Calls Insert.

Parameters:
Name Type Description
request google.cloud.compute.v1.IInsertFirewallPolicyRequest

InsertFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.InsertCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

insert(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Insert.

Parameters:
Name Type Description
request google.cloud.compute.v1.IInsertFirewallPolicyRequest

InsertFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

list(request, callback) → {undefined}

Calls List.

Parameters:
Name Type Description
request google.cloud.compute.v1.IListFirewallPoliciesRequest

ListFirewallPoliciesRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.ListCallback

Node-style callback called with the error, if any, and FirewallPolicyList

Returns:
Type Description
undefined

list(request) → {Promise.<google.cloud.compute.v1.FirewallPolicyList>}

Calls List.

Parameters:
Name Type Description
request google.cloud.compute.v1.IListFirewallPoliciesRequest

ListFirewallPoliciesRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.FirewallPolicyList>

Promise

listAssociations(request, callback) → {undefined}

Calls ListAssociations.

Parameters:
Name Type Description
request google.cloud.compute.v1.IListAssociationsFirewallPolicyRequest

ListAssociationsFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.ListAssociationsCallback

Node-style callback called with the error, if any, and FirewallPoliciesListAssociationsResponse

Returns:
Type Description
undefined

listAssociations(request) → {Promise.<google.cloud.compute.v1.FirewallPoliciesListAssociationsResponse>}

Calls ListAssociations.

Parameters:
Name Type Description
request google.cloud.compute.v1.IListAssociationsFirewallPolicyRequest

ListAssociationsFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.FirewallPoliciesListAssociationsResponse>

Promise

move(request, callback) → {undefined}

Calls Move.

Parameters:
Name Type Description
request google.cloud.compute.v1.IMoveFirewallPolicyRequest

MoveFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.MoveCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

move(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Move.

Parameters:
Name Type Description
request google.cloud.compute.v1.IMoveFirewallPolicyRequest

MoveFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

patch(request, callback) → {undefined}

Calls Patch.

Parameters:
Name Type Description
request google.cloud.compute.v1.IPatchFirewallPolicyRequest

PatchFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.PatchCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

patch(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Patch.

Parameters:
Name Type Description
request google.cloud.compute.v1.IPatchFirewallPolicyRequest

PatchFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

patchRule(request, callback) → {undefined}

Calls PatchRule.

Parameters:
Name Type Description
request google.cloud.compute.v1.IPatchRuleFirewallPolicyRequest

PatchRuleFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.PatchRuleCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

patchRule(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls PatchRule.

Parameters:
Name Type Description
request google.cloud.compute.v1.IPatchRuleFirewallPolicyRequest

PatchRuleFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

removeAssociation(request, callback) → {undefined}

Calls RemoveAssociation.

Parameters:
Name Type Description
request google.cloud.compute.v1.IRemoveAssociationFirewallPolicyRequest

RemoveAssociationFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.RemoveAssociationCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

removeAssociation(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls RemoveAssociation.

Parameters:
Name Type Description
request google.cloud.compute.v1.IRemoveAssociationFirewallPolicyRequest

RemoveAssociationFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

removeRule(request, callback) → {undefined}

Calls RemoveRule.

Parameters:
Name Type Description
request google.cloud.compute.v1.IRemoveRuleFirewallPolicyRequest

RemoveRuleFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.RemoveRuleCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

removeRule(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls RemoveRule.

Parameters:
Name Type Description
request google.cloud.compute.v1.IRemoveRuleFirewallPolicyRequest

RemoveRuleFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Operation>

Promise

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.cloud.compute.v1.ISetIamPolicyFirewallPolicyRequest

SetIamPolicyFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.SetIamPolicyCallback

Node-style callback called with the error, if any, and Policy

Returns:
Type Description
undefined

setIamPolicy(request) → {Promise.<google.cloud.compute.v1.Policy>}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.cloud.compute.v1.ISetIamPolicyFirewallPolicyRequest

SetIamPolicyFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.Policy>

Promise

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.cloud.compute.v1.ITestIamPermissionsFirewallPolicyRequest

TestIamPermissionsFirewallPolicyRequest message or plain object

callback google.cloud.compute.v1.FirewallPolicies.TestIamPermissionsCallback

Node-style callback called with the error, if any, and TestPermissionsResponse

Returns:
Type Description
undefined

testIamPermissions(request) → {Promise.<google.cloud.compute.v1.TestPermissionsResponse>}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.cloud.compute.v1.ITestIamPermissionsFirewallPolicyRequest

TestIamPermissionsFirewallPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.compute.v1.TestPermissionsResponse>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {FirewallPolicies}

Creates new FirewallPolicies service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
FirewallPolicies

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

AddAssociationCallback(error, responseopt)

Callback as used by addAssociation.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

AddRuleCallback(error, responseopt)

Callback as used by addRule.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

CloneRulesCallback(error, responseopt)

Callback as used by cloneRules.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

DeleteCallback(error, responseopt)

Callback as used by delete_.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

GetAssociationCallback(error, responseopt)

Callback as used by getAssociation.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.FirewallPolicyAssociation <optional>

FirewallPolicyAssociation

GetCallback(error, responseopt)

Callback as used by get.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.FirewallPolicy <optional>

FirewallPolicy

GetIamPolicyCallback(error, responseopt)

Callback as used by getIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Policy <optional>

Policy

GetRuleCallback(error, responseopt)

Callback as used by getRule.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.FirewallPolicyRule <optional>

FirewallPolicyRule

InsertCallback(error, responseopt)

Callback as used by insert.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

ListAssociationsCallback(error, responseopt)

Callback as used by listAssociations.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.FirewallPoliciesListAssociationsResponse <optional>

FirewallPoliciesListAssociationsResponse

ListCallback(error, responseopt)

Callback as used by list.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.FirewallPolicyList <optional>

FirewallPolicyList

MoveCallback(error, responseopt)

Callback as used by move.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

PatchCallback(error, responseopt)

Callback as used by patch.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

PatchRuleCallback(error, responseopt)

Callback as used by patchRule.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

RemoveAssociationCallback(error, responseopt)

Callback as used by removeAssociation.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

RemoveRuleCallback(error, responseopt)

Callback as used by removeRule.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Operation <optional>

Operation

SetIamPolicyCallback(error, responseopt)

Callback as used by setIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.Policy <optional>

Policy

TestIamPermissionsCallback(error, responseopt)

Callback as used by testIamPermissions.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.compute.v1.TestPermissionsResponse <optional>

TestPermissionsResponse