Represents an OrgPolicy
Inheritance
$protobuf.rpc.Service > protos.google.cloud.orgpolicy.v2.OrgPolicyPackage
@google-cloud/org-policyConstructors
(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. |
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 |
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 |
void |
createPolicy(request)
public createPolicy(request: google.cloud.orgpolicy.v2.ICreatePolicyRequest): Promise<google.cloud.orgpolicy.v2.Policy>;
Calls CreatePolicy.
Parameter | |
---|---|
Name | 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)
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 |
google.cloud.orgpolicy.v2.OrgPolicy.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 |
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 |
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 |
void |
getEffectivePolicy(request)
public getEffectivePolicy(request: google.cloud.orgpolicy.v2.IGetEffectivePolicyRequest): Promise<google.cloud.orgpolicy.v2.Policy>;
Calls GetEffectivePolicy.
Parameter | |
---|---|
Name | 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)
public getPolicy(request: google.cloud.orgpolicy.v2.IGetPolicyRequest, callback: google.cloud.orgpolicy.v2.OrgPolicy.GetPolicyCallback): void;
Calls GetPolicy.
Parameters | |
---|---|
Name | 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 |
void |
getPolicy(request)
public getPolicy(request: google.cloud.orgpolicy.v2.IGetPolicyRequest): Promise<google.cloud.orgpolicy.v2.Policy>;
Calls GetPolicy.
Parameter | |
---|---|
Name | 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)
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 |
google.cloud.orgpolicy.v2.OrgPolicy.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 |
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 |
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 |
void |
listPolicies(request)
public listPolicies(request: google.cloud.orgpolicy.v2.IListPoliciesRequest): Promise<google.cloud.orgpolicy.v2.ListPoliciesResponse>;
Calls ListPolicies.
Parameter | |
---|---|
Name | 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)
public updatePolicy(request: google.cloud.orgpolicy.v2.IUpdatePolicyRequest, callback: google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicyCallback): void;
Calls UpdatePolicy.
Parameters | |
---|---|
Name | 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 |
void |
updatePolicy(request)
public updatePolicy(request: google.cloud.orgpolicy.v2.IUpdatePolicyRequest): Promise<google.cloud.orgpolicy.v2.Policy>;
Calls UpdatePolicy.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.orgpolicy.v2.IUpdatePolicyRequest
UpdatePolicyRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.orgpolicy.v2.Policy> | Promise |