Class protos.grafeas.v1beta1.Note (3.1.8)

Represents a Note.

Package

@google-cloud/containeranalysis!

Constructors

(constructor)(properties)

constructor(properties?: grafeas.v1beta1.INote);

Constructs a new Note.

Parameter

Name	Description
properties	`INote` Properties to set

Properties

attestationAuthority

public attestationAuthority?: (grafeas.v1beta1.attestation.IAuthority|null);

Note attestationAuthority.

Property Value

Type	Description
(grafeas.v1beta1.attestation.IAuthority\|null)

baseImage

public baseImage?: (grafeas.v1beta1.image.IBasis|null);

Note baseImage.

Property Value

Type	Description
(grafeas.v1beta1.image.IBasis\|null)

build

public build?: (grafeas.v1beta1.build.IBuild|null);

Note build.

Property Value

Type	Description
(grafeas.v1beta1.build.IBuild\|null)

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Note createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

deployable

public deployable?: (grafeas.v1beta1.deployment.IDeployable|null);

Note deployable.

Property Value

Type	Description
(grafeas.v1beta1.deployment.IDeployable\|null)

discovery

public discovery?: (grafeas.v1beta1.discovery.IDiscovery|null);

Note discovery.

Property Value

Type	Description
(grafeas.v1beta1.discovery.IDiscovery\|null)

expirationTime

public expirationTime?: (google.protobuf.ITimestamp|null);

Note expirationTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

kind

public kind: (grafeas.v1beta1.NoteKind|keyof typeof grafeas.v1beta1.NoteKind);

Note kind.

Property Value

Type	Description
(grafeas.v1beta1.NoteKind\|keyof typeof grafeas.v1beta1.NoteKind)

longDescription

public longDescription: string;

Note longDescription.

Property Value

Type	Description
string

name

public name: string;

Note name.

Property Value

Type	Description
string

package

public package?: (grafeas.v1beta1.package_.IPackage|null);

Note package.

Property Value

Type	Description
(grafeas.v1beta1.package_.IPackage\|null)

relatedNoteNames

public relatedNoteNames: string[];

Note relatedNoteNames.

Property Value

Type	Description
string[]

relatedUrl

public relatedUrl: grafeas.v1beta1.IRelatedUrl[];

Note relatedUrl.

Property Value

Type	Description
grafeas.v1beta1.IRelatedUrl[]

shortDescription

public shortDescription: string;

Note shortDescription.

Property Value

Type	Description
string

type

public type?: ("vulnerability"|"build"|"baseImage"|"package"|"deployable"|"discovery"|"attestationAuthority");

Note type.

Property Value

Type	Description
("vulnerability"\|"build"\|"baseImage"\|"package"\|"deployable"\|"discovery"\|"attestationAuthority")

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Note updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

vulnerability

public vulnerability?: (grafeas.v1beta1.vulnerability.IVulnerability|null);

Note vulnerability.

Property Value

Type	Description
(grafeas.v1beta1.vulnerability.IVulnerability\|null)

Methods

create(properties)

public static create(properties?: grafeas.v1beta1.INote): grafeas.v1beta1.Note;

Creates a new Note instance using the specified properties.

Parameter

Name	Description
properties	`INote` Properties to set

Returns

Type	Description
grafeas.v1beta1.Note	Note instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): grafeas.v1beta1.Note;

Decodes a Note message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
grafeas.v1beta1.Note	Note

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): grafeas.v1beta1.Note;

Decodes a Note message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
grafeas.v1beta1.Note	Note

encode(message, writer)

public static encode(message: grafeas.v1beta1.INote, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Note message. Does not implicitly messages.

Parameters

Name	Description
message	`INote` Note message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: grafeas.v1beta1.INote, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Note message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`INote` Note message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): grafeas.v1beta1.Note;

Creates a Note message from a plain object. Also converts values to their respective internal types.

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
grafeas.v1beta1.Note	Note

toJSON()

public toJSON(): { [k: string]: any };

Converts this Note to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: grafeas.v1beta1.Note, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Note message. Also converts values to other types if specified.

Parameters

Name	Description
message	`grafeas.v1beta1.Note` Note
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Note message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not