Represents an ExplainedDenyPolicy.
Package
@google-cloud/policy-troubleshooter-iamConstructors
(constructor)(properties)
constructor(properties?: google.cloud.policytroubleshooter.iam.v3beta.IExplainedDenyPolicy);Constructs a new ExplainedDenyPolicy.
| Parameter | |
|---|---|
| Name | Description |
properties |
IExplainedDenyPolicy
Properties to set |
Properties
denyAccessState
public denyAccessState: (google.cloud.policytroubleshooter.iam.v3beta.DenyAccessState|keyof typeof google.cloud.policytroubleshooter.iam.v3beta.DenyAccessState);ExplainedDenyPolicy denyAccessState.
policy
public policy?: (google.iam.v2.IPolicy|null);ExplainedDenyPolicy policy.
relevance
public relevance: (google.cloud.policytroubleshooter.iam.v3beta.HeuristicRelevance|keyof typeof google.cloud.policytroubleshooter.iam.v3beta.HeuristicRelevance);ExplainedDenyPolicy relevance.
ruleExplanations
public ruleExplanations: google.cloud.policytroubleshooter.iam.v3beta.IDenyRuleExplanation[];ExplainedDenyPolicy ruleExplanations.
Methods
create(properties)
public static create(properties?: google.cloud.policytroubleshooter.iam.v3beta.IExplainedDenyPolicy): google.cloud.policytroubleshooter.iam.v3beta.ExplainedDenyPolicy;Creates a new ExplainedDenyPolicy instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IExplainedDenyPolicy
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ExplainedDenyPolicy |
ExplainedDenyPolicy instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.policytroubleshooter.iam.v3beta.ExplainedDenyPolicy;Decodes an ExplainedDenyPolicy message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
ExplainedDenyPolicy |
ExplainedDenyPolicy |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.policytroubleshooter.iam.v3beta.ExplainedDenyPolicy;Decodes an ExplainedDenyPolicy message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ExplainedDenyPolicy |
ExplainedDenyPolicy |
encode(message, writer)
public static encode(message: google.cloud.policytroubleshooter.iam.v3beta.IExplainedDenyPolicy, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ExplainedDenyPolicy message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IExplainedDenyPolicy
ExplainedDenyPolicy message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.policytroubleshooter.iam.v3beta.IExplainedDenyPolicy, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ExplainedDenyPolicy message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IExplainedDenyPolicy
ExplainedDenyPolicy message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.policytroubleshooter.iam.v3beta.ExplainedDenyPolicy;Creates an ExplainedDenyPolicy message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
ExplainedDenyPolicy |
ExplainedDenyPolicy |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ExplainedDenyPolicy
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this ExplainedDenyPolicy to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.policytroubleshooter.iam.v3beta.ExplainedDenyPolicy, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an ExplainedDenyPolicy message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
ExplainedDenyPolicy
ExplainedDenyPolicy |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an ExplainedDenyPolicy message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|