Class protos.grafeas.v1.SlsaProvenance.Material (4.1.2)

Stay organized with collections Save and categorize content based on your preferences.

Represents a Material.

Package

@google-cloud/grafeas

Constructors

(constructor)(properties)

constructor(properties?: grafeas.v1.SlsaProvenance.IMaterial);

Constructs a new Material.

Parameter
NameDescription
properties IMaterial

Properties to set

Properties

digest

public digest: { [k: string]: string };

Material digest.

uri

public uri: string;

Material uri.

Methods

create(properties)

public static create(properties?: grafeas.v1.SlsaProvenance.IMaterial): grafeas.v1.SlsaProvenance.Material;

Creates a new Material instance using the specified properties.

Parameter
NameDescription
properties IMaterial

Properties to set

Returns
TypeDescription
grafeas.v1.SlsaProvenance.Material

Material instance

decode(reader, length)

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

Decodes a Material 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.SlsaProvenance.Material

Material

decodeDelimited(reader)

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

Decodes a Material 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.SlsaProvenance.Material

Material

encode(message, writer)

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

Encodes the specified Material message. Does not implicitly messages.

Parameters
NameDescription
message IMaterial

Material 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.SlsaProvenance.IMaterial, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IMaterial

Material 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.SlsaProvenance.Material;

Creates a Material 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.SlsaProvenance.Material

Material

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Material

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 Material to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message grafeas.v1.SlsaProvenance.Material

Material

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 Material 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