InfoTypeDescription

google.privacy.dlp.v2. InfoTypeDescription

Represents an InfoTypeDescription.

Constructor

new InfoTypeDescription(propertiesopt)

Constructs a new InfoTypeDescription.

Parameters:
Name Type Attributes Description
properties google.privacy.dlp.v2.IInfoTypeDescription <optional>

Properties to set

Implements:
  • IInfoTypeDescription

Members

categories

InfoTypeDescription categories.

description

InfoTypeDescription description.

displayName

InfoTypeDescription displayName.

example

InfoTypeDescription example.

name

InfoTypeDescription name.

sensitivityScore

InfoTypeDescription sensitivityScore.

specificInfoTypes

InfoTypeDescription specificInfoTypes.

supportedBy

InfoTypeDescription supportedBy.

versions

InfoTypeDescription versions.

Methods

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

Converts this InfoTypeDescription to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.privacy.dlp.v2.InfoTypeDescription}

Creates a new InfoTypeDescription instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.privacy.dlp.v2.IInfoTypeDescription <optional>

Properties to set

Returns:
Type Description
google.privacy.dlp.v2.InfoTypeDescription

InfoTypeDescription instance

(static) decode(reader, lengthopt) → {google.privacy.dlp.v2.InfoTypeDescription}

Decodes an InfoTypeDescription 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.privacy.dlp.v2.InfoTypeDescription

InfoTypeDescription

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.privacy.dlp.v2.InfoTypeDescription}

Decodes an InfoTypeDescription 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.privacy.dlp.v2.InfoTypeDescription

InfoTypeDescription

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

Parameters:
Name Type Attributes Description
message google.privacy.dlp.v2.IInfoTypeDescription

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

Parameters:
Name Type Attributes Description
message google.privacy.dlp.v2.IInfoTypeDescription

InfoTypeDescription message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.privacy.dlp.v2.InfoTypeDescription}

Creates an InfoTypeDescription 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.privacy.dlp.v2.InfoTypeDescription

InfoTypeDescription

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for InfoTypeDescription

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

Parameters:
Name Type Attributes Description
message google.privacy.dlp.v2.InfoTypeDescription

InfoTypeDescription

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies an InfoTypeDescription 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