Class protos.google.cloud.iot.v1.BindDeviceToGatewayRequest (2.3.6)

Represents a BindDeviceToGatewayRequest.

Package

@google-cloud/iot!

Constructors

(constructor)(properties)

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

Constructs a new BindDeviceToGatewayRequest.

Parameter

Name	Description
properties	`IBindDeviceToGatewayRequest` Properties to set

Properties

deviceId

public deviceId: string;

BindDeviceToGatewayRequest deviceId.

Property Value

Type	Description
string

gatewayId

public gatewayId: string;

BindDeviceToGatewayRequest gatewayId.

Property Value

Type	Description
string

parent

public parent: string;

BindDeviceToGatewayRequest parent.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.cloud.iot.v1.IBindDeviceToGatewayRequest): google.cloud.iot.v1.BindDeviceToGatewayRequest;

Creates a new BindDeviceToGatewayRequest instance using the specified properties.

Parameter

Name	Description
properties	`IBindDeviceToGatewayRequest` Properties to set

Returns

Type	Description
google.cloud.iot.v1.BindDeviceToGatewayRequest	BindDeviceToGatewayRequest instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified BindDeviceToGatewayRequest message. Does not implicitly messages.

Parameters

Name	Description
message	`IBindDeviceToGatewayRequest` BindDeviceToGatewayRequest 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.IBindDeviceToGatewayRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IBindDeviceToGatewayRequest` BindDeviceToGatewayRequest 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.BindDeviceToGatewayRequest;

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

toJSON()

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

Converts this BindDeviceToGatewayRequest to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.iot.v1.BindDeviceToGatewayRequest` BindDeviceToGatewayRequest
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 BindDeviceToGatewayRequest 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