Class protos.google.cloud.iot.v1.ListDevicesRequest (2.2.0)

Represents a ListDevicesRequest.

Package

@google-cloud/iot!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.iot.v1.IListDevicesRequest);

Constructs a new ListDevicesRequest.

Parameter
Name Description
properties IListDevicesRequest

Properties to set

Properties

deviceIds

public deviceIds: string[];

ListDevicesRequest deviceIds.

Property Value
Type Description
string[]

deviceNumIds

public deviceNumIds: (number|Long|string)[];

ListDevicesRequest deviceNumIds.

Property Value
Type Description
(number|Long|string)[]

fieldMask

public fieldMask?: (google.protobuf.IFieldMask|null);

ListDevicesRequest fieldMask.

Property Value
Type Description
(google.protobuf.IFieldMask|null)

gatewayListOptions

public gatewayListOptions?: (google.cloud.iot.v1.IGatewayListOptions|null);

ListDevicesRequest gatewayListOptions.

Property Value
Type Description
(google.cloud.iot.v1.IGatewayListOptions|null)

pageSize

public pageSize: number;

ListDevicesRequest pageSize.

Property Value
Type Description
number

pageToken

public pageToken: string;

ListDevicesRequest pageToken.

Property Value
Type Description
string

parent

public parent: string;

ListDevicesRequest parent.

Property Value
Type Description
string

Methods

create(properties)

public static create(properties?: google.cloud.iot.v1.IListDevicesRequest): google.cloud.iot.v1.ListDevicesRequest;

Creates a new ListDevicesRequest instance using the specified properties.

Parameter
Name Description
properties IListDevicesRequest

Properties to set
Returns
Type Description
google.cloud.iot.v1.ListDevicesRequest

ListDevicesRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.iot.v1.ListDevicesRequest;

Decodes a ListDevicesRequest 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
google.cloud.iot.v1.ListDevicesRequest

ListDevicesRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.iot.v1.ListDevicesRequest;

Decodes a ListDevicesRequest 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
google.cloud.iot.v1.ListDevicesRequest

ListDevicesRequest

encode(message, writer)

public static encode(message: google.cloud.iot.v1.IListDevicesRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListDevicesRequest message. Does not implicitly messages.

Parameters
Name Description
message IListDevicesRequest

ListDevicesRequest 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.cloud.iot.v1.IListDevicesRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IListDevicesRequest

ListDevicesRequest 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.cloud.iot.v1.ListDevicesRequest;

Creates a ListDevicesRequest 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
google.cloud.iot.v1.ListDevicesRequest

ListDevicesRequest

toJSON()

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

Converts this ListDevicesRequest to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.iot.v1.ListDevicesRequest

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