BindingExplanation

google.cloud.policytroubleshooter.v1. BindingExplanation

Represents a BindingExplanation.

Constructor

new BindingExplanation(propertiesopt)

Constructs a new BindingExplanation.

Parameters:
Name Type Attributes Description
properties google.cloud.policytroubleshooter.v1.IBindingExplanation <optional>

Properties to set

Implements:
  • IBindingExplanation

Classes

AnnotatedMembership

Members

access

BindingExplanation access.

condition

BindingExplanation condition.

memberships

BindingExplanation memberships.

relevance

BindingExplanation relevance.

role

BindingExplanation role.

rolePermission

BindingExplanation rolePermission.

rolePermissionRelevance

BindingExplanation rolePermissionRelevance.

Membership

Membership enum.

Properties:
Name Type Description
MEMBERSHIP_UNSPECIFIED number

MEMBERSHIP_UNSPECIFIED value

MEMBERSHIP_INCLUDED number

MEMBERSHIP_INCLUDED value

MEMBERSHIP_NOT_INCLUDED number

MEMBERSHIP_NOT_INCLUDED value

MEMBERSHIP_UNKNOWN_INFO_DENIED number

MEMBERSHIP_UNKNOWN_INFO_DENIED value

MEMBERSHIP_UNKNOWN_UNSUPPORTED number

MEMBERSHIP_UNKNOWN_UNSUPPORTED value

RolePermission

RolePermission enum.

Properties:
Name Type Description
ROLE_PERMISSION_UNSPECIFIED number

ROLE_PERMISSION_UNSPECIFIED value

ROLE_PERMISSION_INCLUDED number

ROLE_PERMISSION_INCLUDED value

ROLE_PERMISSION_NOT_INCLUDED number

ROLE_PERMISSION_NOT_INCLUDED value

ROLE_PERMISSION_UNKNOWN_INFO_DENIED number

ROLE_PERMISSION_UNKNOWN_INFO_DENIED value

Methods

toJSON() → {Object.<string, *>}

Converts this BindingExplanation to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.policytroubleshooter.v1.BindingExplanation}

Creates a new BindingExplanation instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.policytroubleshooter.v1.IBindingExplanation <optional>

Properties to set

Returns:
Type Description
google.cloud.policytroubleshooter.v1.BindingExplanation

BindingExplanation instance

(static) decode(reader, lengthopt) → {google.cloud.policytroubleshooter.v1.BindingExplanation}

Decodes a BindingExplanation message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.policytroubleshooter.v1.BindingExplanation

BindingExplanation

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.policytroubleshooter.v1.BindingExplanation}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.policytroubleshooter.v1.BindingExplanation

BindingExplanation

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified BindingExplanation message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.policytroubleshooter.v1.IBindingExplanation

BindingExplanation message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.policytroubleshooter.v1.IBindingExplanation

BindingExplanation message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.policytroubleshooter.v1.BindingExplanation}

Creates a BindingExplanation message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.policytroubleshooter.v1.BindingExplanation

BindingExplanation

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for BindingExplanation

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.policytroubleshooter.v1.BindingExplanation

BindingExplanation

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a BindingExplanation message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not