Class protos.grafeas.v1.PackageOccurrence (4.7.0)

Represents a PackageOccurrence.

Package

@google-cloud/containeranalysis

Constructors

(constructor)(properties)

constructor(properties?: grafeas.v1.IPackageOccurrence);

Constructs a new PackageOccurrence.

Parameter
NameDescription
properties IPackageOccurrence

Properties to set

Properties

architecture

public architecture: (grafeas.v1.Architecture|keyof typeof grafeas.v1.Architecture);

PackageOccurrence architecture.

cpeUri

public cpeUri: string;

PackageOccurrence cpeUri.

license

public license?: (grafeas.v1.ILicense|null);

PackageOccurrence license.

location

public location: grafeas.v1.ILocation[];

PackageOccurrence location.

name

public name: string;

PackageOccurrence name.

packageType

public packageType: string;

PackageOccurrence packageType.

version

public version?: (grafeas.v1.IVersion|null);

PackageOccurrence version.

Methods

create(properties)

public static create(properties?: grafeas.v1.IPackageOccurrence): grafeas.v1.PackageOccurrence;

Creates a new PackageOccurrence instance using the specified properties.

Parameter
NameDescription
properties IPackageOccurrence

Properties to set

Returns
TypeDescription
grafeas.v1.PackageOccurrence

PackageOccurrence instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): grafeas.v1.PackageOccurrence;

Decodes a PackageOccurrence message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
grafeas.v1.PackageOccurrence

PackageOccurrence

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): grafeas.v1.PackageOccurrence;

Decodes a PackageOccurrence message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
grafeas.v1.PackageOccurrence

PackageOccurrence

encode(message, writer)

public static encode(message: grafeas.v1.IPackageOccurrence, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PackageOccurrence message. Does not implicitly messages.

Parameters
NameDescription
message IPackageOccurrence

PackageOccurrence message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: grafeas.v1.IPackageOccurrence, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PackageOccurrence message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IPackageOccurrence

PackageOccurrence message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): grafeas.v1.PackageOccurrence;

Creates a PackageOccurrence message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
grafeas.v1.PackageOccurrence

PackageOccurrence

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for PackageOccurrence

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this PackageOccurrence to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: grafeas.v1.PackageOccurrence, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a PackageOccurrence message. Also converts values to other types if specified.

Parameters
NameDescription
message grafeas.v1.PackageOccurrence

PackageOccurrence

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a PackageOccurrence message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not