Policy

google.cloud.orgpolicy.v1. Policy

Represents a Policy.

Constructor

new Policy(propertiesopt)

Constructs a new Policy.

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

Properties to set
Implements:
  • IPolicy

Classes

BooleanPolicy
ListPolicy
RestoreDefault

Members

booleanPolicy

Policy booleanPolicy.

constraint

Policy constraint.

etag

Policy etag.

listPolicy

Policy listPolicy.

policyType

Policy policyType.

restoreDefault

Policy restoreDefault.

updateTime

Policy updateTime.

version

Policy version.

Methods

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

Creates a new Policy instance using the specified properties.

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

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

Policy instance

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

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

Policy
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}

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

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

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

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

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

Policy 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}

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

Policy

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Policy

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

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

Policy
options $protobuf.IConversionOptions <optional>

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

Plain object

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

Verifies a Policy 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 Policy to JSON.

Returns:
Type Description
Object.<string, *>

JSON object