Represents a Note.
Package
@google-cloud/grafeas!Constructors
(constructor)(properties)
constructor
(
properties
?:
grafeas
.
v1
.
INote
);
Constructs a new Note.
| Name | Description |
|---|---|
| properties | INote
Properties to set |
Properties
attestation
public
attestation
?:
(
grafeas
.
v1
.
IAttestationNote
|
null
);
Note attestation.
| Type | Description |
|---|---|
| ( grafeas.v1.IAttestationNote |null) |
build
public
build
?:
(
grafeas
.
v1
.
IBuildNote
|
null
);
Note build.
| Type | Description |
|---|---|
| ( grafeas.v1.IBuildNote |null) |
createTime
public
createTime
?:
(
google
.
protobuf
.
ITimestamp
|
null
);
Note createTime.
| Type | Description |
|---|---|
| ( google.protobuf.ITimestamp |null) |
deployment
public
deployment
?:
(
grafeas
.
v1
.
IDeploymentNote
|
null
);
Note deployment.
| Type | Description |
|---|---|
| ( grafeas.v1.IDeploymentNote |null) |
discovery
public
discovery
?:
(
grafeas
.
v1
.
IDiscoveryNote
|
null
);
Note discovery.
| Type | Description |
|---|---|
| ( grafeas.v1.IDiscoveryNote |null) |
expirationTime
public
expirationTime
?:
(
google
.
protobuf
.
ITimestamp
|
null
);
Note expirationTime.
| Type | Description |
|---|---|
| ( google.protobuf.ITimestamp |null) |
image
public
image
?:
(
grafeas
.
v1
.
IImageNote
|
null
);
Note image.
| Type | Description |
|---|---|
| ( grafeas.v1.IImageNote |null) |
kind
public
kind
:
(
grafeas
.
v1
.
NoteKind
|
keyof
typeof
grafeas
.
v1
.
NoteKind
);
Note kind.
| Type | Description |
|---|---|
| ( grafeas.v1.NoteKind |keyof typeof grafeas.v1.NoteKind ) |
longDescription
public
longDescription
:
string
;
Note longDescription.
| Type | Description |
|---|---|
| string |
name
public
name
:
string
;
Note name.
| Type | Description |
|---|---|
| string |
package
public
package
?:
(
grafeas
.
v1
.
IPackageNote
|
null
);
Note package.
| Type | Description |
|---|---|
| ( grafeas.v1.IPackageNote |null) |
relatedNoteNames
public
relatedNoteNames
:
string
[];
Note relatedNoteNames.
| Type | Description |
|---|---|
| string[] |
relatedUrl
public
relatedUrl
:
grafeas
.
v1
.
IRelatedUrl
[];
Note relatedUrl.
| Type | Description |
|---|---|
| grafeas.v1.IRelatedUrl [] |
shortDescription
public
shortDescription
:
string
;
Note shortDescription.
| Type | Description |
|---|---|
| string |
type
public
type
?:
(
"vulnerability"
|
"build"
|
"image"
|
"package"
|
"deployment"
|
"discovery"
|
"attestation"
|
"upgrade"
);
Note type.
| Type | Description |
|---|---|
| ("vulnerability"|"build"|"image"|"package"|"deployment"|"discovery"|"attestation"|"upgrade") |
updateTime
public
updateTime
?:
(
google
.
protobuf
.
ITimestamp
|
null
);
Note updateTime.
| Type | Description |
|---|---|
| ( google.protobuf.ITimestamp |null) |
upgrade
public
upgrade
?:
(
grafeas
.
v1
.
IUpgradeNote
|
null
);
Note upgrade.
| Type | Description |
|---|---|
| ( grafeas.v1.IUpgradeNote |null) |
vulnerability
public
vulnerability
?:
(
grafeas
.
v1
.
IVulnerabilityNote
|
null
);
Note vulnerability.
| Type | Description |
|---|---|
| ( grafeas.v1.IVulnerabilityNote |null) |
Methods
create(properties)
public
static
create
(
properties
?:
grafeas
.
v1
.
INote
)
:
grafeas
.
v1
.
Note
;
Creates a new Note instance using the specified properties.
| Name | Description |
|---|---|
| properties | INote
Properties to set |
| Type | Description |
|---|---|
| grafeas.v1.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.
| Name | Description |
| reader | ($protobuf. Reader
| Uint8Array
)
Reader or buffer to decode from |
| length | number
Message length if known beforehand |
| Type | Description |
|---|---|
| grafeas.v1.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.
| Name | Description |
| reader | ($protobuf. Reader
| Uint8Array
)
Reader or buffer to decode from |
| Type | Description |
|---|---|
| grafeas.v1.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.
| Name | Description |
| message | INote
Note message or plain object to encode |
| writer | $protobuf. Writer
Writer to encode to |
| 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.
| Name | Description |
| message | INote
Note message or plain object to encode |
| writer | $protobuf. Writer
Writer to encode to |
| 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.
| Name | Description |
| object | { [k: string]: any }
Plain object |
| Type | Description |
|---|---|
| grafeas.v1.Note | Note |
toJSON()
public
toJSON
()
:
{
[
k
:
string
]
:
any
};
Converts this Note to JSON.
| 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.
| Name | Description |
| message | grafeas.v1.Note
Note |
| options | $protobuf. IConversionOptions
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public
static
verify
(
message
:
{
[
k
:
string
]
:
any
})
:
(
string
|
null
);
Verifies a Note message.
| Name | Description |
| message | { [k: string]: any }
Plain object to verify |
| Type | Description |
| (string|null) | |
