Class protos.grafeas.v1.Occurrence (3.5.0)

Represents an Occurrence.

Package

@google-cloud/grafeas!

Constructors

(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.

Property Value

Type	Description
(grafeas.v1.IAttestationOccurrence\|null)

build

public build?: (grafeas.v1.IBuildOccurrence|null);

Occurrence build.

Property Value

Type	Description
(grafeas.v1.IBuildOccurrence\|null)

createTime

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

Occurrence createTime.

Property Value

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

deployment

public deployment?: (grafeas.v1.IDeploymentOccurrence|null);

Occurrence deployment.

Property Value

Type	Description
(grafeas.v1.IDeploymentOccurrence\|null)

details

public details?: ("vulnerability"|"build"|"image"|"package"|"deployment"|"discovery"|"attestation"|"upgrade");

Occurrence details.

Property Value

Type	Description
("vulnerability"\|"build"\|"image"\|"package"\|"deployment"\|"discovery"\|"attestation"\|"upgrade")

discovery

public discovery?: (grafeas.v1.IDiscoveryOccurrence|null);

Occurrence discovery.

Property Value

Type	Description
(grafeas.v1.IDiscoveryOccurrence\|null)

image

public image?: (grafeas.v1.IImageOccurrence|null);

Occurrence image.

Property Value

Type	Description
(grafeas.v1.IImageOccurrence\|null)

kind

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

Occurrence kind.

Property Value

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

name

public name: string;

Occurrence name.

Property Value

Type	Description
string

noteName

public noteName: string;

Occurrence noteName.

Property Value

Type	Description
string

package

public package?: (grafeas.v1.IPackageOccurrence|null);

Occurrence package.

Property Value

Type	Description
(grafeas.v1.IPackageOccurrence\|null)

remediation

public remediation: string;

Occurrence remediation.

Property Value

Type	Description
string

resourceUri

public resourceUri: string;

Occurrence resourceUri.

Property Value

Type	Description
string

updateTime

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

Occurrence updateTime.

Property Value

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

upgrade

public upgrade?: (grafeas.v1.IUpgradeOccurrence|null);

Occurrence upgrade.

Property Value

Type	Description
(grafeas.v1.IUpgradeOccurrence\|null)

vulnerability

public vulnerability?: (grafeas.v1.IVulnerabilityOccurrence|null);

Occurrence vulnerability.

Property Value

Type	Description
(grafeas.v1.IVulnerabilityOccurrence\|null)

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

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)	`null` if valid, otherwise the reason why it is not