Represents an Occurrence.
Package
@google-cloud/grafeasConstructors
(constructor)(properties)
constructor(properties?: grafeas.v1.IOccurrence);Constructs a new Occurrence.
| Parameter | |
|---|---|
| Name | Description |
properties |
IOccurrence
Properties to set |
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");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.
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.
| Parameter | |
|---|---|
| Name | Description |
properties |
IOccurrence
Properties to set |
| Returns | |
|---|---|
| Type | Description |
grafeas.v1.Occurrence | Occurrence instance |
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.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
grafeas.v1.Occurrence | Occurrence |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): grafeas.v1.Occurrence;Decodes an Occurrence 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.v1.Occurrence | Occurrence |
encode(message, writer)
public static encode(message: grafeas.v1.IOccurrence, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Occurrence message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IOccurrence
Occurrence 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.IOccurrence, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Occurrence message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IOccurrence
Occurrence 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.Occurrence;Creates an Occurrence 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.v1.Occurrence | Occurrence |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Occurrence
| 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 Occurrence to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [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.
| Parameters | |
|---|---|
| Name | Description |
message |
grafeas.v1.Occurrence
Occurrence |
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 an Occurrence message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|