Class protos.google.maps.routeoptimization.v1.OptimizeToursValidationError.FieldReference (0.1.0)

Represents a FieldReference.

Package

@googlemaps/routeoptimization

Constructors

(constructor)(properties)

constructor(properties?: google.maps.routeoptimization.v1.OptimizeToursValidationError.IFieldReference);

Constructs a new FieldReference.

Parameter
Name Description
properties IFieldReference

Properties to set

Properties

index

public index?: (number|null);

FieldReference index.

indexOrKey

public indexOrKey?: ("index"|"key");

FieldReference indexOrKey.

key

public key?: (string|null);

FieldReference key.

name

public name: string;

FieldReference name.

subField

public subField?: (google.maps.routeoptimization.v1.OptimizeToursValidationError.IFieldReference|null);

FieldReference subField.

Methods

create(properties)

public static create(properties?: google.maps.routeoptimization.v1.OptimizeToursValidationError.IFieldReference): google.maps.routeoptimization.v1.OptimizeToursValidationError.FieldReference;

Creates a new FieldReference instance using the specified properties.

Parameter
Name Description
properties IFieldReference

Properties to set

Returns
Type Description
FieldReference

FieldReference instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.routeoptimization.v1.OptimizeToursValidationError.FieldReference;

Decodes a FieldReference message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
FieldReference

FieldReference

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.routeoptimization.v1.OptimizeToursValidationError.FieldReference;

Decodes a FieldReference message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
FieldReference

FieldReference

encode(message, writer)

public static encode(message: google.maps.routeoptimization.v1.OptimizeToursValidationError.IFieldReference, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified FieldReference message. Does not implicitly messages.

Parameters
Name Description
message IFieldReference

FieldReference 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: google.maps.routeoptimization.v1.OptimizeToursValidationError.IFieldReference, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IFieldReference

FieldReference 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 }): google.maps.routeoptimization.v1.OptimizeToursValidationError.FieldReference;

Creates a FieldReference 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
FieldReference

FieldReference

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for FieldReference

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.maps.routeoptimization.v1.OptimizeToursValidationError.FieldReference, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message FieldReference

FieldReference

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