Represents a PackageNote.
Package
@google-cloud/grafeasConstructors
(constructor)(properties)
constructor(properties?: grafeas.v1.IPackageNote);Constructs a new PackageNote.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPackageNote
Properties to set |
Properties
architecture
public architecture: (grafeas.v1.Architecture|keyof typeof grafeas.v1.Architecture);PackageNote architecture.
cpeUri
public cpeUri: string;PackageNote cpeUri.
description
public description: string;PackageNote description.
digest
public digest: grafeas.v1.IDigest[];PackageNote digest.
distribution
public distribution: grafeas.v1.IDistribution[];PackageNote distribution.
license
public license?: (grafeas.v1.ILicense|null);PackageNote license.
maintainer
public maintainer: string;PackageNote maintainer.
name
public name: string;PackageNote name.
packageType
public packageType: string;PackageNote packageType.
url
public url: string;PackageNote url.
version
public version?: (grafeas.v1.IVersion|null);PackageNote version.
Methods
create(properties)
public static create(properties?: grafeas.v1.IPackageNote): grafeas.v1.PackageNote;Creates a new PackageNote instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPackageNote
Properties to set |
| Returns | |
|---|---|
| Type | Description |
grafeas.v1.PackageNote | PackageNote instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): grafeas.v1.PackageNote;Decodes a PackageNote 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.PackageNote | PackageNote |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): grafeas.v1.PackageNote;Decodes a PackageNote 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.PackageNote | PackageNote |
encode(message, writer)
public static encode(message: grafeas.v1.IPackageNote, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified PackageNote message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPackageNote
PackageNote 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.IPackageNote, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified PackageNote message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPackageNote
PackageNote 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.PackageNote;Creates a PackageNote 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.PackageNote | PackageNote |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for PackageNote
| 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 PackageNote to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: grafeas.v1.PackageNote, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a PackageNote message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
grafeas.v1.PackageNote
PackageNote |
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 a PackageNote message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|