Class protos.google.cloud.orgpolicy.v2.OrgPolicy (3.1.0)

Version latest

• 3.1.0 (latest)
• 2.1.2
• 2.0.3
• 1.1.2
• 1.0.7

Represents an OrgPolicy

Inheritance

$protobuf.rpc.Service > protos.google.cloud.orgpolicy.v2.OrgPolicy

Package

@google-cloud/org-policy

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new OrgPolicy service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): OrgPolicy;

Creates new OrgPolicy service using the specified rpc implementation.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns
Type	Description
OrgPolicy	RPC service. Useful where requests and/or responses are streamed.

createCustomConstraint(request, callback)

public createCustomConstraint(request: google.cloud.orgpolicy.v2.ICreateCustomConstraintRequest, callback: google.cloud.orgpolicy.v2.OrgPolicy.CreateCustomConstraintCallback): void;

Calls CreateCustomConstraint.

Parameters
Name	Description
request	ICreateCustomConstraintRequest CreateCustomConstraintRequest message or plain object
callback	CreateCustomConstraintCallback Node-style callback called with the error, if any, and CustomConstraint

Returns
Type	Description
void

createCustomConstraint(request)

public createCustomConstraint(request: google.cloud.orgpolicy.v2.ICreateCustomConstraintRequest): Promise<google.cloud.orgpolicy.v2.CustomConstraint>;

Calls CreateCustomConstraint.

Parameter
Name	Description
request	ICreateCustomConstraintRequest CreateCustomConstraintRequest message or plain object

Returns
Type	Description
Promise<google.cloud.orgpolicy.v2.CustomConstraint>	Promise

createPolicy(request, callback)

public createPolicy(request: google.cloud.orgpolicy.v2.ICreatePolicyRequest, callback: google.cloud.orgpolicy.v2.OrgPolicy.CreatePolicyCallback): void;

Calls CreatePolicy.

Parameters
Name	Description
request	ICreatePolicyRequest CreatePolicyRequest message or plain object
callback	CreatePolicyCallback Node-style callback called with the error, if any, and Policy

Returns
Type	Description
void

createPolicy(request)

public createPolicy(request: google.cloud.orgpolicy.v2.ICreatePolicyRequest): Promise<google.cloud.orgpolicy.v2.Policy>;

Calls CreatePolicy.

Parameter
Name	Description
request	ICreatePolicyRequest CreatePolicyRequest message or plain object

Returns
Type	Description
Promise<google.cloud.orgpolicy.v2.Policy>	Promise

deleteCustomConstraint(request, callback)

public deleteCustomConstraint(request: google.cloud.orgpolicy.v2.IDeleteCustomConstraintRequest, callback: google.cloud.orgpolicy.v2.OrgPolicy.DeleteCustomConstraintCallback): void;

Calls DeleteCustomConstraint.

Parameters
Name	Description
request	IDeleteCustomConstraintRequest DeleteCustomConstraintRequest message or plain object
callback	DeleteCustomConstraintCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deleteCustomConstraint(request)

public deleteCustomConstraint(request: google.cloud.orgpolicy.v2.IDeleteCustomConstraintRequest): Promise<google.protobuf.Empty>;

Calls DeleteCustomConstraint.

Parameter
Name	Description
request	IDeleteCustomConstraintRequest DeleteCustomConstraintRequest message or plain object

Returns
Type	Description
Promise<google.protobuf.Empty>	Promise

deletePolicy(request, callback)

public deletePolicy(request: google.cloud.orgpolicy.v2.IDeletePolicyRequest, callback: google.cloud.orgpolicy.v2.OrgPolicy.DeletePolicyCallback): void;

Calls DeletePolicy.

Parameters
Name	Description
request	IDeletePolicyRequest DeletePolicyRequest message or plain object
callback	DeletePolicyCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deletePolicy(request)

public deletePolicy(request: google.cloud.orgpolicy.v2.IDeletePolicyRequest): Promise<google.protobuf.Empty>;

Calls DeletePolicy.

Parameter
Name	Description
request	IDeletePolicyRequest DeletePolicyRequest message or plain object

Returns
Type	Description
Promise<google.protobuf.Empty>	Promise

getCustomConstraint(request, callback)

public getCustomConstraint(request: google.cloud.orgpolicy.v2.IGetCustomConstraintRequest, callback: google.cloud.orgpolicy.v2.OrgPolicy.GetCustomConstraintCallback): void;

Calls GetCustomConstraint.

Parameters
Name	Description
request	IGetCustomConstraintRequest GetCustomConstraintRequest message or plain object
callback	GetCustomConstraintCallback Node-style callback called with the error, if any, and CustomConstraint

Returns
Type	Description
void

getCustomConstraint(request)

public getCustomConstraint(request: google.cloud.orgpolicy.v2.IGetCustomConstraintRequest): Promise<google.cloud.orgpolicy.v2.CustomConstraint>;

Calls GetCustomConstraint.

Parameter
Name	Description
request	IGetCustomConstraintRequest GetCustomConstraintRequest message or plain object

Returns
Type	Description
Promise<google.cloud.orgpolicy.v2.CustomConstraint>	Promise

getEffectivePolicy(request, callback)

public getEffectivePolicy(request: google.cloud.orgpolicy.v2.IGetEffectivePolicyRequest, callback: google.cloud.orgpolicy.v2.OrgPolicy.GetEffectivePolicyCallback): void;

Calls GetEffectivePolicy.

Parameters
Name	Description
request	IGetEffectivePolicyRequest GetEffectivePolicyRequest message or plain object
callback	GetEffectivePolicyCallback Node-style callback called with the error, if any, and Policy

Returns
Type	Description
void

getEffectivePolicy(request)

public getEffectivePolicy(request: google.cloud.orgpolicy.v2.IGetEffectivePolicyRequest): Promise<google.cloud.orgpolicy.v2.Policy>;

Calls GetEffectivePolicy.

Parameter
Name	Description
request	IGetEffectivePolicyRequest GetEffectivePolicyRequest message or plain object

Returns
Type	Description
Promise<google.cloud.orgpolicy.v2.Policy>	Promise

getPolicy(request, callback)

public getPolicy(request: google.cloud.orgpolicy.v2.IGetPolicyRequest, callback: google.cloud.orgpolicy.v2.OrgPolicy.GetPolicyCallback): void;

Calls GetPolicy.

Parameters
Name	Description
request	IGetPolicyRequest GetPolicyRequest message or plain object
callback	GetPolicyCallback Node-style callback called with the error, if any, and Policy

Returns
Type	Description
void

getPolicy(request)

public getPolicy(request: google.cloud.orgpolicy.v2.IGetPolicyRequest): Promise<google.cloud.orgpolicy.v2.Policy>;

Calls GetPolicy.

Parameter
Name	Description
request	IGetPolicyRequest GetPolicyRequest message or plain object

Returns
Type	Description
Promise<google.cloud.orgpolicy.v2.Policy>	Promise

listConstraints(request, callback)

public listConstraints(request: google.cloud.orgpolicy.v2.IListConstraintsRequest, callback: google.cloud.orgpolicy.v2.OrgPolicy.ListConstraintsCallback): void;

Calls ListConstraints.

Parameters
Name	Description
request	IListConstraintsRequest ListConstraintsRequest message or plain object
callback	ListConstraintsCallback Node-style callback called with the error, if any, and ListConstraintsResponse

Returns
Type	Description
void

listConstraints(request)

public listConstraints(request: google.cloud.orgpolicy.v2.IListConstraintsRequest): Promise<google.cloud.orgpolicy.v2.ListConstraintsResponse>;

Calls ListConstraints.

Parameter
Name	Description
request	IListConstraintsRequest ListConstraintsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.orgpolicy.v2.ListConstraintsResponse>	Promise

listCustomConstraints(request, callback)

public listCustomConstraints(request: google.cloud.orgpolicy.v2.IListCustomConstraintsRequest, callback: google.cloud.orgpolicy.v2.OrgPolicy.ListCustomConstraintsCallback): void;

Calls ListCustomConstraints.

Parameters
Name	Description
request	IListCustomConstraintsRequest ListCustomConstraintsRequest message or plain object
callback	ListCustomConstraintsCallback Node-style callback called with the error, if any, and ListCustomConstraintsResponse

Returns
Type	Description
void

listCustomConstraints(request)

public listCustomConstraints(request: google.cloud.orgpolicy.v2.IListCustomConstraintsRequest): Promise<google.cloud.orgpolicy.v2.ListCustomConstraintsResponse>;

Calls ListCustomConstraints.

Parameter
Name	Description
request	IListCustomConstraintsRequest ListCustomConstraintsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.orgpolicy.v2.ListCustomConstraintsResponse>	Promise

listPolicies(request, callback)

public listPolicies(request: google.cloud.orgpolicy.v2.IListPoliciesRequest, callback: google.cloud.orgpolicy.v2.OrgPolicy.ListPoliciesCallback): void;

Calls ListPolicies.

Parameters
Name	Description
request	IListPoliciesRequest ListPoliciesRequest message or plain object
callback	ListPoliciesCallback Node-style callback called with the error, if any, and ListPoliciesResponse

Returns
Type	Description
void

listPolicies(request)

public listPolicies(request: google.cloud.orgpolicy.v2.IListPoliciesRequest): Promise<google.cloud.orgpolicy.v2.ListPoliciesResponse>;

Calls ListPolicies.

Parameter
Name	Description
request	IListPoliciesRequest ListPoliciesRequest message or plain object

Returns
Type	Description
Promise<google.cloud.orgpolicy.v2.ListPoliciesResponse>	Promise

updateCustomConstraint(request, callback)

public updateCustomConstraint(request: google.cloud.orgpolicy.v2.IUpdateCustomConstraintRequest, callback: google.cloud.orgpolicy.v2.OrgPolicy.UpdateCustomConstraintCallback): void;

Calls UpdateCustomConstraint.

Parameters
Name	Description
request	IUpdateCustomConstraintRequest UpdateCustomConstraintRequest message or plain object
callback	UpdateCustomConstraintCallback Node-style callback called with the error, if any, and CustomConstraint

Returns
Type	Description
void

updateCustomConstraint(request)

public updateCustomConstraint(request: google.cloud.orgpolicy.v2.IUpdateCustomConstraintRequest): Promise<google.cloud.orgpolicy.v2.CustomConstraint>;

Calls UpdateCustomConstraint.

Parameter
Name	Description
request	IUpdateCustomConstraintRequest UpdateCustomConstraintRequest message or plain object

Returns
Type	Description
Promise<google.cloud.orgpolicy.v2.CustomConstraint>	Promise

updatePolicy(request, callback)

public updatePolicy(request: google.cloud.orgpolicy.v2.IUpdatePolicyRequest, callback: google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicyCallback): void;

Calls UpdatePolicy.

Parameters
Name	Description
request	IUpdatePolicyRequest UpdatePolicyRequest message or plain object
callback	UpdatePolicyCallback Node-style callback called with the error, if any, and Policy

Returns
Type	Description
void

updatePolicy(request)

public updatePolicy(request: google.cloud.orgpolicy.v2.IUpdatePolicyRequest): Promise<google.cloud.orgpolicy.v2.Policy>;

Calls UpdatePolicy.

Parameter
Name	Description
request	IUpdatePolicyRequest UpdatePolicyRequest message or plain object

Returns
Type	Description
Promise<google.cloud.orgpolicy.v2.Policy>	Promise