Represents a Note.
Package
@google-cloud/containeranalysisConstructors
(constructor)(properties)
constructor(properties?: grafeas.v1.INote);Constructs a new Note.
| Parameter | |
|---|---|
| Name | Description |
properties |
INote
Properties to set |
Properties
attestation
public attestation?: (grafeas.v1.IAttestationNote|null);Note attestation.
build
public build?: (grafeas.v1.IBuildNote|null);Note build.
compliance
public compliance?: (grafeas.v1.IComplianceNote|null);Note compliance.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Note createTime.
deployment
public deployment?: (grafeas.v1.IDeploymentNote|null);Note deployment.
discovery
public discovery?: (grafeas.v1.IDiscoveryNote|null);Note discovery.
dsseAttestation
public dsseAttestation?: (grafeas.v1.IDSSEAttestationNote|null);Note dsseAttestation.
expirationTime
public expirationTime?: (google.protobuf.ITimestamp|null);Note expirationTime.
image
public image?: (grafeas.v1.IImageNote|null);Note image.
kind
public kind: (grafeas.v1.NoteKind|keyof typeof grafeas.v1.NoteKind);Note kind.
longDescription
public longDescription: string;Note longDescription.
name
public name: string;Note name.
package
public package?: (grafeas.v1.IPackageNote|null);Note package.
relatedNoteNames
public relatedNoteNames: string[];Note relatedNoteNames.
relatedUrl
public relatedUrl: grafeas.v1.IRelatedUrl[];Note relatedUrl.
shortDescription
public shortDescription: string;Note shortDescription.
type
public type?: ("vulnerability"|"build"|"image"|"package"|"deployment"|"discovery"|"attestation"|"upgrade"|"compliance"|"dsseAttestation"|"vulnerabilityAssessment");Note type.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Note updateTime.
upgrade
public upgrade?: (grafeas.v1.IUpgradeNote|null);Note upgrade.
vulnerability
public vulnerability?: (grafeas.v1.IVulnerabilityNote|null);Note vulnerability.
vulnerabilityAssessment
public vulnerabilityAssessment?: (grafeas.v1.IVulnerabilityAssessmentNote|null);Note vulnerabilityAssessment.
Methods
create(properties)
public static create(properties?: grafeas.v1.INote): grafeas.v1.Note;Creates a new Note instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
INote
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Note | Note instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): grafeas.v1.Note;Decodes a Note message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Note | Note |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): grafeas.v1.Note;Decodes a Note message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Note | Note |
encode(message, writer)
public static encode(message: grafeas.v1.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.v1.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.v1.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 |
Note | Note |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Note
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
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.v1.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 |
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) |
|