Class protos.grafeas.v1.SlsaProvenance.SlsaRecipe (3.4.0)

Represents a SlsaRecipe.

Package

Constructors

(constructor)(properties)

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

Constructs a new SlsaRecipe.

Parameter

Name	Description
properties	`ISlsaRecipe` Properties to set

Properties

arguments

public arguments?: (google.protobuf.IAny|null);

SlsaRecipe arguments.

definedInMaterial

public definedInMaterial: (number|Long|string);

SlsaRecipe definedInMaterial.

entryPoint

public entryPoint: string;

SlsaRecipe entryPoint.

environment

public environment?: (google.protobuf.IAny|null);

SlsaRecipe environment.

type

public type: string;

SlsaRecipe type.

Methods

create(properties)

public static create(properties?: grafeas.v1.SlsaProvenance.ISlsaRecipe): grafeas.v1.SlsaProvenance.SlsaRecipe;

Creates a new SlsaRecipe instance using the specified properties.

Parameter

Name	Description
properties	`ISlsaRecipe` Properties to set

Returns

Type	Description
grafeas.v1.SlsaProvenance.SlsaRecipe	SlsaRecipe instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified SlsaRecipe message. Does not implicitly messages.

Parameters

Name	Description
message	`ISlsaRecipe` SlsaRecipe 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.SlsaProvenance.ISlsaRecipe, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`ISlsaRecipe` SlsaRecipe 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.SlsaProvenance.SlsaRecipe;

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

toJSON()

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

Converts this SlsaRecipe to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`grafeas.v1.SlsaProvenance.SlsaRecipe` SlsaRecipe
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 SlsaRecipe 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