Class protos.grafeas.v1.AliasContext (3.4.6)

Represents an AliasContext.

Package

@google-cloud/grafeas!

Constructors

(constructor)(properties)

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

Constructs a new AliasContext.

Parameter
NameDescription
properties IAliasContext

Properties to set

Properties

kind

public kind: (grafeas.v1.AliasContext.Kind|keyof typeof grafeas.v1.AliasContext.Kind);

AliasContext kind.

Property Value
TypeDescription
(grafeas.v1.AliasContext.Kind|keyof typeof grafeas.v1.AliasContext.Kind)

name

public name: string;

AliasContext name.

Property Value
TypeDescription
string

Methods

create(properties)

public static create(properties?: grafeas.v1.IAliasContext): grafeas.v1.AliasContext;

Creates a new AliasContext instance using the specified properties.

Parameter
NameDescription
properties IAliasContext

Properties to set

Returns
TypeDescription
grafeas.v1.AliasContext

AliasContext instance

decode(reader, length)

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

Decodes an AliasContext 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.AliasContext

AliasContext

decodeDelimited(reader)

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

Decodes an AliasContext 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.AliasContext

AliasContext

encode(message, writer)

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

Encodes the specified AliasContext message. Does not implicitly messages.

Parameters
NameDescription
message IAliasContext

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

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

Parameters
NameDescription
message IAliasContext

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

Creates an AliasContext 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.AliasContext

AliasContext

toJSON()

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

Converts this AliasContext to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message grafeas.v1.AliasContext

AliasContext

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an AliasContext 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