Represents an Occurrence.
Package
@google-cloud/grafeasConstructors
(constructor)(properties)
constructor
(
properties
?:
grafeas
.
v1
.
IOccurrence
);
Constructs a new Occurrence.
Properties
attestation
public
attestation
?:
(
grafeas
.
v1
.
IAttestationOccurrence
|
null
);
Occurrence attestation.
build
public
build
?:
(
grafeas
.
v1
.
IBuildOccurrence
|
null
);
Occurrence build.
compliance
public
compliance
?:
(
grafeas
.
v1
.
IComplianceOccurrence
|
null
);
Occurrence compliance.
createTime
public
createTime
?:
(
google
.
protobuf
.
ITimestamp
|
null
);
Occurrence createTime.
deployment
public
deployment
?:
(
grafeas
.
v1
.
IDeploymentOccurrence
|
null
);
Occurrence deployment.
details
public
details
?:
(
"vulnerability"
|
"build"
|
"image"
|
"package"
|
"deployment"
|
"discovery"
|
"attestation"
|
"upgrade"
|
"compliance"
|
"dsseAttestation"
|
"sbomReference"
);
Occurrence details.
discovery
public
discovery
?:
(
grafeas
.
v1
.
IDiscoveryOccurrence
|
null
);
Occurrence discovery.
dsseAttestation
public
dsseAttestation
?:
(
grafeas
.
v1
.
IDSSEAttestationOccurrence
|
null
);
Occurrence dsseAttestation.
envelope
public
envelope
?:
(
grafeas
.
v1
.
IEnvelope
|
null
);
Occurrence envelope.
image
public
image
?:
(
grafeas
.
v1
.
IImageOccurrence
|
null
);
Occurrence image.
kind
public
kind
:
(
grafeas
.
v1
.
NoteKind
|
keyof
typeof
grafeas
.
v1
.
NoteKind
);
Occurrence kind.
name
public
name
:
string
;
Occurrence name.
noteName
public
noteName
:
string
;
Occurrence noteName.
package
public
package
?:
(
grafeas
.
v1
.
IPackageOccurrence
|
null
);
Occurrence package.
remediation
public
remediation
:
string
;
Occurrence remediation.
resourceUri
public
resourceUri
:
string
;
Occurrence resourceUri.
sbomReference
public
sbomReference
?:
(
grafeas
.
v1
.
ISBOMReferenceOccurrence
|
null
);
Occurrence sbomReference.
updateTime
public
updateTime
?:
(
google
.
protobuf
.
ITimestamp
|
null
);
Occurrence updateTime.
upgrade
public
upgrade
?:
(
grafeas
.
v1
.
IUpgradeOccurrence
|
null
);
Occurrence upgrade.
vulnerability
public
vulnerability
?:
(
grafeas
.
v1
.
IVulnerabilityOccurrence
|
null
);
Occurrence vulnerability.
Methods
create(properties)
public
static
create
(
properties
?:
grafeas
.
v1
.
IOccurrence
)
:
grafeas
.
v1
.
Occurrence
;
Creates a new Occurrence instance using the specified properties.
decode(reader, length)
public
static
decode
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
),
length
?:
number
)
:
grafeas
.
v1
.
Occurrence
;
Decodes an Occurrence message from the specified reader or buffer.
reader
( Reader
| Uint8Array
)
Reader or buffer to decode from
length
number
Message length if known beforehand
decodeDelimited(reader)
public
static
decodeDelimited
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
))
:
grafeas
.
v1
.
Occurrence
;
Decodes an Occurrence message from the specified reader or buffer, length delimited.
reader
( Reader
| Uint8Array
)
Reader or buffer to decode from
encode(message, writer)
public
static
encode
(
message
:
grafeas
.
v1
.
IOccurrence
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified Occurrence message. Does not implicitly messages.
message
writer
$protobuf.Writer
Writer to encode to
$protobuf.Writer
Writer
encodeDelimited(message, writer)
public
static
encodeDelimited
(
message
:
grafeas
.
v1
.
IOccurrence
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified Occurrence message, length delimited. Does not implicitly messages.
message
writer
$protobuf.Writer
Writer to encode to
$protobuf.Writer
Writer
fromObject(object)
public
static
fromObject
(
object
:
{
[
k
:
string
]
:
any
})
:
grafeas
.
v1
.
Occurrence
;
Creates an Occurrence message from a plain object. Also converts values to their respective internal types.
object
{ [k: string]: any }
Plain object
getTypeUrl(typeUrlPrefix)
public
static
getTypeUrl
(
typeUrlPrefix
?:
string
)
:
string
;
Gets the default type url for Occurrence
typeUrlPrefix
string
your custom typeUrlPrefix(default "type.googleapis.com")
string
The default type url
toJSON()
public
toJSON
()
:
{
[
k
:
string
]
:
any
};
Converts this Occurrence to JSON.
{ [k: string]: any }
JSON object
toObject(message, options)
public
static
toObject
(
message
:
grafeas
.
v1
.
Occurrence
,
options
?:
$protobuf
.
IConversionOptions
)
:
{
[
k
:
string
]
:
any
};
Creates a plain object from an Occurrence message. Also converts values to other types if specified.
message
options
$protobuf.IConversionOptions
Conversion options
{ [k: string]: any }
Plain object
verify(message)
public
static
verify
(
message
:
{
[
k
:
string
]
:
any
})
:
(
string
|
null
);
Verifies an Occurrence message.
message
{ [k: string]: any }
Plain object to verify
(string|null)
null
if valid, otherwise the reason why it is not