Class protos.google.cloud.talent.v4.CommuteFilter (6.0.2)

Represents a CommuteFilter.

Package

@google-cloud/talent

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.talent.v4.ICommuteFilter);

Constructs a new CommuteFilter.

Parameter
NameDescription
properties ICommuteFilter

Properties to set

Properties

allowImpreciseAddresses

public allowImpreciseAddresses: boolean;

CommuteFilter allowImpreciseAddresses.

commuteMethod

public commuteMethod: (google.cloud.talent.v4.CommuteMethod|keyof typeof google.cloud.talent.v4.CommuteMethod);

CommuteFilter commuteMethod.

departureTime

public departureTime?: (google.type.ITimeOfDay|null);

CommuteFilter departureTime.

roadTraffic

public roadTraffic?: (google.cloud.talent.v4.CommuteFilter.RoadTraffic|keyof typeof google.cloud.talent.v4.CommuteFilter.RoadTraffic|null);

CommuteFilter roadTraffic.

startCoordinates

public startCoordinates?: (google.type.ILatLng|null);

CommuteFilter startCoordinates.

trafficOption

public trafficOption?: ("roadTraffic"|"departureTime");

CommuteFilter trafficOption.

travelDuration

public travelDuration?: (google.protobuf.IDuration|null);

CommuteFilter travelDuration.

Methods

create(properties)

public static create(properties?: google.cloud.talent.v4.ICommuteFilter): google.cloud.talent.v4.CommuteFilter;

Creates a new CommuteFilter instance using the specified properties.

Parameter
NameDescription
properties ICommuteFilter

Properties to set

Returns
TypeDescription
CommuteFilter

CommuteFilter instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.talent.v4.CommuteFilter;

Decodes a CommuteFilter message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
CommuteFilter

CommuteFilter

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.talent.v4.CommuteFilter;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
CommuteFilter

CommuteFilter

encode(message, writer)

public static encode(message: google.cloud.talent.v4.ICommuteFilter, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CommuteFilter message. Does not implicitly messages.

Parameters
NameDescription
message ICommuteFilter

CommuteFilter 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: google.cloud.talent.v4.ICommuteFilter, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ICommuteFilter

CommuteFilter 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 }): google.cloud.talent.v4.CommuteFilter;

Creates a CommuteFilter message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
CommuteFilter

CommuteFilter

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CommuteFilter

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.talent.v4.CommuteFilter, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message CommuteFilter

CommuteFilter

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