OrgPolicy

google.cloud.orgpolicy.v2. OrgPolicy

Represents an OrgPolicy

Constructor

new OrgPolicy(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new OrgPolicy 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

createPolicy(request, callback) → {undefined}

Calls CreatePolicy.

Parameters:
Name Type Description
request google.cloud.orgpolicy.v2.ICreatePolicyRequest

CreatePolicyRequest message or plain object
callback google.cloud.orgpolicy.v2.OrgPolicy.CreatePolicyCallback

Node-style callback called with the error, if any, and Policy
Returns:
Type Description
undefined

createPolicy(request) → {Promise.<google.cloud.orgpolicy.v2.Policy>}

Calls CreatePolicy.

Parameters:
Name Type Description
request google.cloud.orgpolicy.v2.ICreatePolicyRequest

CreatePolicyRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.orgpolicy.v2.Policy>

Promise

deletePolicy(request, callback) → {undefined}

Calls DeletePolicy.

Parameters:
Name Type Description
request google.cloud.orgpolicy.v2.IDeletePolicyRequest

DeletePolicyRequest message or plain object
callback google.cloud.orgpolicy.v2.OrgPolicy.DeletePolicyCallback

Node-style callback called with the error, if any, and Empty
Returns:
Type Description
undefined

deletePolicy(request) → {Promise.<google.protobuf.Empty>}

Calls DeletePolicy.

Parameters:
Name Type Description
request google.cloud.orgpolicy.v2.IDeletePolicyRequest

DeletePolicyRequest message or plain object
Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

getEffectivePolicy(request, callback) → {undefined}

Calls GetEffectivePolicy.

Parameters:
Name Type Description
request google.cloud.orgpolicy.v2.IGetEffectivePolicyRequest

GetEffectivePolicyRequest message or plain object
callback google.cloud.orgpolicy.v2.OrgPolicy.GetEffectivePolicyCallback

Node-style callback called with the error, if any, and Policy
Returns:
Type Description
undefined

getEffectivePolicy(request) → {Promise.<google.cloud.orgpolicy.v2.Policy>}

Calls GetEffectivePolicy.

Parameters:
Name Type Description
request google.cloud.orgpolicy.v2.IGetEffectivePolicyRequest

GetEffectivePolicyRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.orgpolicy.v2.Policy>

Promise

getPolicy(request, callback) → {undefined}

Calls GetPolicy.

Parameters:
Name Type Description
request google.cloud.orgpolicy.v2.IGetPolicyRequest

GetPolicyRequest message or plain object
callback google.cloud.orgpolicy.v2.OrgPolicy.GetPolicyCallback

Node-style callback called with the error, if any, and Policy
Returns:
Type Description
undefined

getPolicy(request) → {Promise.<google.cloud.orgpolicy.v2.Policy>}

Calls GetPolicy.

Parameters:
Name Type Description
request google.cloud.orgpolicy.v2.IGetPolicyRequest

GetPolicyRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.orgpolicy.v2.Policy>

Promise

listConstraints(request, callback) → {undefined}

Calls ListConstraints.

Parameters:
Name Type Description
request google.cloud.orgpolicy.v2.IListConstraintsRequest

ListConstraintsRequest message or plain object
callback google.cloud.orgpolicy.v2.OrgPolicy.ListConstraintsCallback

Node-style callback called with the error, if any, and ListConstraintsResponse
Returns:
Type Description
undefined

listConstraints(request) → {Promise.<google.cloud.orgpolicy.v2.ListConstraintsResponse>}

Calls ListConstraints.

Parameters:
Name Type Description
request google.cloud.orgpolicy.v2.IListConstraintsRequest

ListConstraintsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.orgpolicy.v2.ListConstraintsResponse>

Promise

listPolicies(request, callback) → {undefined}

Calls ListPolicies.

Parameters:
Name Type Description
request google.cloud.orgpolicy.v2.IListPoliciesRequest

ListPoliciesRequest message or plain object
callback google.cloud.orgpolicy.v2.OrgPolicy.ListPoliciesCallback

Node-style callback called with the error, if any, and ListPoliciesResponse
Returns:
Type Description
undefined

listPolicies(request) → {Promise.<google.cloud.orgpolicy.v2.ListPoliciesResponse>}

Calls ListPolicies.

Parameters:
Name Type Description
request google.cloud.orgpolicy.v2.IListPoliciesRequest

ListPoliciesRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.orgpolicy.v2.ListPoliciesResponse>

Promise

updatePolicy(request, callback) → {undefined}

Calls UpdatePolicy.

Parameters:
Name Type Description
request google.cloud.orgpolicy.v2.IUpdatePolicyRequest

UpdatePolicyRequest message or plain object
callback google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicyCallback

Node-style callback called with the error, if any, and Policy
Returns:
Type Description
undefined

updatePolicy(request) → {Promise.<google.cloud.orgpolicy.v2.Policy>}

Calls UpdatePolicy.

Parameters:
Name Type Description
request google.cloud.orgpolicy.v2.IUpdatePolicyRequest

UpdatePolicyRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.orgpolicy.v2.Policy>

Promise

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

Creates new OrgPolicy 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
OrgPolicy

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

Type Definitions

CreatePolicyCallback(error, responseopt)

Callback as used by createPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.orgpolicy.v2.Policy <optional>

Policy

DeletePolicyCallback(error, responseopt)

Callback as used by deletePolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.protobuf.Empty <optional>

Empty

GetEffectivePolicyCallback(error, responseopt)

Callback as used by getEffectivePolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.orgpolicy.v2.Policy <optional>

Policy

GetPolicyCallback(error, responseopt)

Callback as used by getPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.orgpolicy.v2.Policy <optional>

Policy

ListConstraintsCallback(error, responseopt)

Callback as used by listConstraints.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.orgpolicy.v2.ListConstraintsResponse <optional>

ListConstraintsResponse

ListPoliciesCallback(error, responseopt)

Callback as used by listPolicies.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.orgpolicy.v2.ListPoliciesResponse <optional>

ListPoliciesResponse

UpdatePolicyCallback(error, responseopt)

Callback as used by updatePolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.orgpolicy.v2.Policy <optional>

Policy