Class protos.google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation (0.7.0)

Represents a DenyRuleExplanation.

Package

@google-cloud/policy-troubleshooter-iam

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.policytroubleshooter.iam.v3.IDenyRuleExplanation);

Constructs a new DenyRuleExplanation.

Parameter
Name Description
properties IDenyRuleExplanation

Properties to set

Properties

combinedDeniedPermission

public combinedDeniedPermission?: (google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation.IAnnotatedPermissionMatching|null);

DenyRuleExplanation combinedDeniedPermission.

combinedDeniedPrincipal

public combinedDeniedPrincipal?: (google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation.IAnnotatedDenyPrincipalMatching|null);

DenyRuleExplanation combinedDeniedPrincipal.

combinedExceptionPermission

public combinedExceptionPermission?: (google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation.IAnnotatedPermissionMatching|null);

DenyRuleExplanation combinedExceptionPermission.

combinedExceptionPrincipal

public combinedExceptionPrincipal?: (google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation.IAnnotatedDenyPrincipalMatching|null);

DenyRuleExplanation combinedExceptionPrincipal.

condition

public condition?: (google.type.IExpr|null);

DenyRuleExplanation condition.

conditionExplanation

public conditionExplanation?: (google.cloud.policytroubleshooter.iam.v3.IConditionExplanation|null);

DenyRuleExplanation conditionExplanation.

deniedPermissions

public deniedPermissions: { [k: string]: google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation.IAnnotatedPermissionMatching };

DenyRuleExplanation deniedPermissions.

deniedPrincipals

public deniedPrincipals: { [k: string]: google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation.IAnnotatedDenyPrincipalMatching };

DenyRuleExplanation deniedPrincipals.

denyAccessState

public denyAccessState: (google.cloud.policytroubleshooter.iam.v3.DenyAccessState|keyof typeof google.cloud.policytroubleshooter.iam.v3.DenyAccessState);

DenyRuleExplanation denyAccessState.

exceptionPermissions

public exceptionPermissions: { [k: string]: google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation.IAnnotatedPermissionMatching };

DenyRuleExplanation exceptionPermissions.

exceptionPrincipals

public exceptionPrincipals: { [k: string]: google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation.IAnnotatedDenyPrincipalMatching };

DenyRuleExplanation exceptionPrincipals.

relevance

public relevance: (google.cloud.policytroubleshooter.iam.v3.HeuristicRelevance|keyof typeof google.cloud.policytroubleshooter.iam.v3.HeuristicRelevance);

DenyRuleExplanation relevance.

Methods

create(properties)

public static create(properties?: google.cloud.policytroubleshooter.iam.v3.IDenyRuleExplanation): google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation;

Creates a new DenyRuleExplanation instance using the specified properties.

Parameter
Name Description
properties IDenyRuleExplanation

Properties to set

Returns
Type Description
DenyRuleExplanation

DenyRuleExplanation instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation;

Decodes a DenyRuleExplanation 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
DenyRuleExplanation

DenyRuleExplanation

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation;

Decodes a DenyRuleExplanation message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
DenyRuleExplanation

DenyRuleExplanation

encode(message, writer)

public static encode(message: google.cloud.policytroubleshooter.iam.v3.IDenyRuleExplanation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DenyRuleExplanation message. Does not implicitly messages.

Parameters
Name Description
message IDenyRuleExplanation

DenyRuleExplanation 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.v3.IDenyRuleExplanation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DenyRuleExplanation message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IDenyRuleExplanation

DenyRuleExplanation 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.v3.DenyRuleExplanation;

Creates a DenyRuleExplanation 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
DenyRuleExplanation

DenyRuleExplanation

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for DenyRuleExplanation

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 DenyRuleExplanation to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a DenyRuleExplanation message. Also converts values to other types if specified.

Parameters
Name Description
message DenyRuleExplanation

DenyRuleExplanation

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 a DenyRuleExplanation message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not