Note

grafeas.v1. Note

Represents a Note.

Constructor

new Note(propertiesopt)

Constructs a new Note.

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

Properties to set

Implements:
  • INote

Members

attestation

Note attestation.

build

Note build.

compliance

Note compliance.

createTime

Note createTime.

deployment

Note deployment.

discovery

Note discovery.

dsseAttestation

Note dsseAttestation.

expirationTime

Note expirationTime.

image

Note image.

kind

Note kind.

longDescription

Note longDescription.

name

Note name.

package

Note package.

relatedNoteNames

Note relatedNoteNames.

relatedUrl

Note relatedUrl.

shortDescription

Note shortDescription.

type

Note type.

updateTime

Note updateTime.

upgrade

Note upgrade.

vulnerability

Note vulnerability.

vulnerabilityAssessment

Note vulnerabilityAssessment.

Methods

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

Converts this Note to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Note instance using the specified properties.

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

Properties to set

Returns:
Type Description
grafeas.v1.Note

Note instance

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

Decodes a Note 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.Note

Note

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.Note}

Decodes a Note 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.Note

Note

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

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

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

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

Note 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.Note}

Creates a Note 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.Note

Note

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Note

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

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

Note

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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