Class protos.grafeas.v1.Recipe

Represents a Recipe.

Package

@google-cloud/grafeas

Constructors

(constructor)(properties)

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

Constructs a new Recipe.

Parameter
NameDescription
properties IRecipe

Properties to set

Properties

arguments

public arguments: google.protobuf.IAny[];

Recipe arguments.

definedInMaterial

public definedInMaterial: (number|Long|string);

Recipe definedInMaterial.

entryPoint

public entryPoint: string;

Recipe entryPoint.

environment

public environment: google.protobuf.IAny[];

Recipe environment.

type

public type: string;

Recipe type.

Methods

create(properties)

public static create(properties?: grafeas.v1.IRecipe): grafeas.v1.Recipe;

Creates a new Recipe instance using the specified properties.

Parameter
NameDescription
properties IRecipe

Properties to set

Returns
TypeDescription
grafeas.v1.Recipe

Recipe instance

decode(reader, length)

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

Decodes a Recipe 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.Recipe

Recipe

decodeDelimited(reader)

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

Decodes a Recipe 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.Recipe

Recipe

encode(message, writer)

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

Encodes the specified Recipe message. Does not implicitly messages.

Parameters
NameDescription
message IRecipe

Recipe 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.IRecipe, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IRecipe

Recipe 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.Recipe;

Creates a Recipe 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.Recipe

Recipe

toJSON()

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

Converts this Recipe to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message grafeas.v1.Recipe

Recipe

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