ComplianceNote

grafeas.v1. ComplianceNote

Represents a ComplianceNote.

Constructor

new ComplianceNote(propertiesopt)

Constructs a new ComplianceNote.

Parameters:
Name Type Attributes Description
properties grafeas.v1.IComplianceNote <optional>

Properties to set

Implements:
  • IComplianceNote

Classes

CisBenchmark

Members

cisBenchmark

ComplianceNote cisBenchmark.

complianceType

ComplianceNote complianceType.

description

ComplianceNote description.

impact

ComplianceNote impact.

potentialImpact

ComplianceNote potentialImpact.

rationale

ComplianceNote rationale.

remediation

ComplianceNote remediation.

scanInstructions

ComplianceNote scanInstructions.

title

ComplianceNote title.

version

ComplianceNote version.

Methods

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

Converts this ComplianceNote to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {grafeas.v1.ComplianceNote}

Creates a new ComplianceNote instance using the specified properties.

Parameters:
Name Type Attributes Description
properties grafeas.v1.IComplianceNote <optional>

Properties to set

Returns:
Type Description
grafeas.v1.ComplianceNote

ComplianceNote instance

(static) decode(reader, lengthopt) → {grafeas.v1.ComplianceNote}

Decodes a ComplianceNote 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
grafeas.v1.ComplianceNote

ComplianceNote

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) → {grafeas.v1.ComplianceNote}

Decodes a ComplianceNote 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
grafeas.v1.ComplianceNote

ComplianceNote

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

Parameters:
Name Type Attributes Description
message grafeas.v1.IComplianceNote

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

Parameters:
Name Type Attributes Description
message grafeas.v1.IComplianceNote

ComplianceNote message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {grafeas.v1.ComplianceNote}

Creates a ComplianceNote 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
grafeas.v1.ComplianceNote

ComplianceNote

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for ComplianceNote

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

Parameters:
Name Type Attributes Description
message grafeas.v1.ComplianceNote

ComplianceNote

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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