ListPolicy

google.cloud.orgpolicy.v1.Policy. ListPolicy

Represents a ListPolicy.

Constructor

new ListPolicy(propertiesopt)

Constructs a new ListPolicy.

Parameters:
Name Type Attributes Description
properties google.cloud.orgpolicy.v1.Policy.IListPolicy <optional>

Properties to set
Implements:
  • IListPolicy

Members

AllValues

AllValues enum.

Properties:
Name Type Description
ALL_VALUES_UNSPECIFIED number

ALL_VALUES_UNSPECIFIED value
ALLOW number

ALLOW value
DENY number

DENY value

allowedValues

ListPolicy allowedValues.

allValues

ListPolicy allValues.

deniedValues

ListPolicy deniedValues.

inheritFromParent

ListPolicy inheritFromParent.

suggestedValue

ListPolicy suggestedValue.

Methods

(static) create(propertiesopt) → {google.cloud.orgpolicy.v1.Policy.ListPolicy}

Creates a new ListPolicy instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.orgpolicy.v1.Policy.IListPolicy <optional>

Properties to set
Returns:
Type Description
google.cloud.orgpolicy.v1.Policy.ListPolicy

ListPolicy instance

(static) decode(reader, lengthopt) → {google.cloud.orgpolicy.v1.Policy.ListPolicy}

Decodes a ListPolicy 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.orgpolicy.v1.Policy.ListPolicy

ListPolicy
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.orgpolicy.v1.Policy.ListPolicy}

Decodes a ListPolicy 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.orgpolicy.v1.Policy.ListPolicy

ListPolicy
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 ListPolicy message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.orgpolicy.v1.Policy.IListPolicy

ListPolicy 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 ListPolicy message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.orgpolicy.v1.Policy.IListPolicy

ListPolicy 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.orgpolicy.v1.Policy.ListPolicy}

Creates a ListPolicy 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.orgpolicy.v1.Policy.ListPolicy

ListPolicy

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for ListPolicy

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 ListPolicy message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.orgpolicy.v1.Policy.ListPolicy

ListPolicy
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a ListPolicy 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

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

Converts this ListPolicy to JSON.

Returns:
Type Description
Object.<string, *>

JSON object