Google Cloud IoT Core V1 Client - Class BindDeviceToGatewayRequest (1.6.4)

Reference documentation and code samples for the Google Cloud IoT Core V1 Client class BindDeviceToGatewayRequest.

Request for BindDeviceToGateway.

Generated from protobuf message google.cloud.iot.v1.BindDeviceToGatewayRequest

Namespace

Google \ Cloud \ Iot \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
`↳ gateway_id`	`string` Required. The value of `gateway_id` can be either the device numeric ID or the user-defined device identifier.
`↳ device_id`	`string` Required. The device to associate with the specified gateway. The value of `device_id` can be either the device numeric ID or the user-defined device identifier.

getParent

Required. The name of the registry. For example, projects/example-project/locations/us-central1/registries/my-registry.

Returns
Type	Description
`string`

setParent

Required. The name of the registry. For example, projects/example-project/locations/us-central1/registries/my-registry.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getGatewayId

Required. The value of gateway_id can be either the device numeric ID or the user-defined device identifier.

Returns
Type	Description
`string`

setGatewayId

Required. The value of gateway_id can be either the device numeric ID or the user-defined device identifier.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDeviceId

Required. The device to associate with the specified gateway. The value of device_id can be either the device numeric ID or the user-defined device identifier.

Returns
Type	Description
`string`

setDeviceId

Required. The device to associate with the specified gateway. The value of device_id can be either the device numeric ID or the user-defined device identifier.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`parent`	`string` Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. Please see Google\Cloud\Iot\V1\DeviceManagerClient::registryName() for help formatting this field.
`gatewayId`	`string` Required. The value of `gateway_id` can be either the device numeric ID or the user-defined device identifier.
`deviceId`	`string` Required. The device to associate with the specified gateway. The value of `device_id` can be either the device numeric ID or the user-defined device identifier.

Returns
Type	Description
`Google\Cloud\Iot\V1\BindDeviceToGatewayRequest`