google_api_cloud_iot v0.7.0 GoogleApi.CloudIot.V1.Api.Projects View Source
API calls for all endpoints tagged Projects
.
Link to this section Summary
Functions
Associates the device with the gateway.
Creates a device registry that contains devices.
Deletes a device registry configuration.
Lists the last few versions of the device configuration in descending order (i.e.: newest first).
Creates a device in a device registry.
Deletes a device.
Gets details about a device.
List devices in a device registry.
Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata.
Updates a device.
Sends a command to the specified device. In order for a device to be able to receive commands, it must: 1) be connected to Cloud IoT Core using the MQTT protocol, and 2) be subscribed to the group of MQTT topics specified by /devices/{device-id}/commands/#. This subscription will receive commands at the top-level topic /devices/{device-id}/commands as well as commands for subfolders, like /devices/{device-id}/commands/subfolder. Note that subscribing to specific subfolders is not supported. If the command could not be delivered to the device, this method will return an error; in particular, if the device is not subscribed, this method will return FAILED_PRECONDITION. Otherwise, this method will return OK. If the subscription is QoS 1, at least once delivery will be guaranteed; for QoS 0, no acknowledgment will be expected from the device.
Lists the last few versions of the device state in descending order (i.e.: newest first).
Gets a device registry configuration.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
List devices in a device registry.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Sets the access control policy on the specified resource. Replaces any existing policy.
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Lists device registries.
Updates a device registry configuration.
Sets the access control policy on the specified resource. Replaces any existing policy.
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Deletes the association between the device and the gateway.
Link to this section Functions
cloudiot_projects_locations_registries_bind_device_to_gateway(connection, projects_id, locations_id, registries_id, optional_params \\ [], opts \\ []) View Source
Associates the device with the gateway.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
parent
. The name of the registry. For example,projects/example-project/locations/us-central1/registries/my-registry
. - locations_id (String.t): Part of
parent
. See documentation ofprojectsId
. - registries_id (String.t): Part of
parent
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudIot.V1.Model.BindDeviceToGatewayRequest.t):
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.BindDeviceToGatewayResponse{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_create(connection, projects_id, locations_id, optional_params \\ [], opts \\ []) View Source
Creates a device registry that contains devices.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
parent
. The project and cloud region where this device registry must be created. For example,projects/example-project/locations/us-central1
. - locations_id (String.t): Part of
parent
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudIot.V1.Model.DeviceRegistry.t):
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.DeviceRegistry{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_delete(connection, projects_id, locations_id, registries_id, optional_params \\ [], opts \\ []) View Source
Deletes a device registry configuration.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The name of the device registry. For example,projects/example-project/locations/us-central1/registries/my-registry
. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - registries_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.Empty{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_devices_config_versions_list(connection, projects_id, locations_id, registries_id, devices_id, optional_params \\ [], opts \\ []) View Source
Lists the last few versions of the device configuration in descending order (i.e.: newest first).
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The name of the device. For example,projects/p0/locations/us-central1/registries/registry0/devices/device0
orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}
. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - registries_id (String.t): Part of
name
. See documentation ofprojectsId
. - devices_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :numVersions (integer()): The number of versions to list. Versions are listed in decreasing order of
the version number. The maximum number of versions retained is 10. If this value is zero, it will return all the versions available.
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.ListDeviceConfigVersionsResponse{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_devices_create(connection, projects_id, locations_id, registries_id, optional_params \\ [], opts \\ []) View Source
Creates a device in a device registry.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
parent
. The name of the device registry where this device should be created. For example,projects/example-project/locations/us-central1/registries/my-registry
. - locations_id (String.t): Part of
parent
. See documentation ofprojectsId
. - registries_id (String.t): Part of
parent
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudIot.V1.Model.Device.t):
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.Device{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_devices_delete(connection, projects_id, locations_id, registries_id, devices_id, optional_params \\ [], opts \\ []) View Source
Deletes a device.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The name of the device. For example,projects/p0/locations/us-central1/registries/registry0/devices/device0
orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}
. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - registries_id (String.t): Part of
name
. See documentation ofprojectsId
. - devices_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.Empty{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_devices_get(connection, projects_id, locations_id, registries_id, devices_id, optional_params \\ [], opts \\ []) View Source
Gets details about a device.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The name of the device. For example,projects/p0/locations/us-central1/registries/registry0/devices/device0
orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}
. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - registries_id (String.t): Part of
name
. See documentation ofprojectsId
. - devices_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :fieldMask (String.t): The fields of the
Device
resource to be returned in the response. If the
field mask is unset or empty, all fields are returned.
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.Device{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_devices_list(connection, projects_id, locations_id, registries_id, optional_params \\ [], opts \\ []) View Source
List devices in a device registry.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
parent
. The device registry path. Required. For example,projects/my-project/locations/us-central1/registries/my-registry
. - locations_id (String.t): Part of
parent
. See documentation ofprojectsId
. - registries_id (String.t): Part of
parent
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :deviceIds (list(String.t)): A list of device string IDs. For example,
['device0', 'device12']
.
If empty, this field is ignored. Maximum IDs: 10,000
- :deviceNumIds (list(String.t)): A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
- :fieldMask (String.t): The fields of the
Device
resource to be returned in the response. The fieldsid
andnum_id
are always returned, along with any other fields specified. - :gatewayListOptions.associationsDeviceId (String.t): If set, returns only the gateways with which the specified device is
associated. The device ID can be numeric (
num_id
) or the user-defined string (id
). For example, if456
is specified, returns only the gateways to which the device withnum_id
456 is bound. - :gatewayListOptions.associationsGatewayId (String.t): If set, only devices associated with the specified gateway are returned.
The gateway ID can be numeric (
num_id
) or the user-defined string (id
). For example, if123
is specified, only devices bound to the gateway withnum_id
123 are returned. - :gatewayListOptions.gatewayType (String.t): If
GATEWAY
is specified, only gateways are returned. IfNON_GATEWAY
is specified, only non-gateway devices are returned. IfGATEWAY_TYPE_UNSPECIFIED
is specified, all devices are returned. - :pageSize (integer()): The maximum number of devices to return in the response. If this value
is zero, the service will select a default size. A call may return fewer
objects than requested. A non-empty
next_page_token
in the response indicates that more data is available. - :pageToken (String.t): The value returned by the last
ListDevicesResponse
; indicates that this is a continuation of a priorListDevices
call and the system should return the next page of data.
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.ListDevicesResponse{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_devices_modify_cloud_to_device_config(connection, projects_id, locations_id, registries_id, devices_id, optional_params \\ [], opts \\ []) View Source
Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The name of the device. For example,projects/p0/locations/us-central1/registries/registry0/devices/device0
orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}
. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - registries_id (String.t): Part of
name
. See documentation ofprojectsId
. - devices_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudIot.V1.Model.ModifyCloudToDeviceConfigRequest.t):
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.DeviceConfig{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_devices_patch(connection, projects_id, locations_id, registries_id, devices_id, optional_params \\ [], opts \\ []) View Source
Updates a device.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
device.name
. The resource path name. For example,projects/p1/locations/us-central1/registries/registry0/devices/dev0
orprojects/p1/locations/us-central1/registries/registry0/devices/{num_id}
. Whenname
is populated as a response from the service, it always ends in the device numeric ID. - locations_id (String.t): Part of
device.name
. See documentation ofprojectsId
. - registries_id (String.t): Part of
device.name
. See documentation ofprojectsId
. - devices_id (String.t): Part of
device.name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :updateMask (String.t): Only updates the
device
fields indicated by this mask.
The field mask must not be empty, and it must not contain fields that
are immutable or only set by the server.
Mutable top-level fields: credentials
, blocked
, and metadata
- :body (GoogleApi.CloudIot.V1.Model.Device.t):
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.Device{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_devices_send_command_to_device(connection, projects_id, locations_id, registries_id, devices_id, optional_params \\ [], opts \\ []) View Source
Sends a command to the specified device. In order for a device to be able to receive commands, it must: 1) be connected to Cloud IoT Core using the MQTT protocol, and 2) be subscribed to the group of MQTT topics specified by /devices/{device-id}/commands/#. This subscription will receive commands at the top-level topic /devices/{device-id}/commands as well as commands for subfolders, like /devices/{device-id}/commands/subfolder. Note that subscribing to specific subfolders is not supported. If the command could not be delivered to the device, this method will return an error; in particular, if the device is not subscribed, this method will return FAILED_PRECONDITION. Otherwise, this method will return OK. If the subscription is QoS 1, at least once delivery will be guaranteed; for QoS 0, no acknowledgment will be expected from the device.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The name of the device. For example,projects/p0/locations/us-central1/registries/registry0/devices/device0
orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}
. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - registries_id (String.t): Part of
name
. See documentation ofprojectsId
. - devices_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudIot.V1.Model.SendCommandToDeviceRequest.t):
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.SendCommandToDeviceResponse{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_devices_states_list(connection, projects_id, locations_id, registries_id, devices_id, optional_params \\ [], opts \\ []) View Source
Lists the last few versions of the device state in descending order (i.e.: newest first).
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The name of the device. For example,projects/p0/locations/us-central1/registries/registry0/devices/device0
orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}
. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - registries_id (String.t): Part of
name
. See documentation ofprojectsId
. - devices_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :numStates (integer()): The number of states to list. States are listed in descending order of
update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available.
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.ListDeviceStatesResponse{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_get(connection, projects_id, locations_id, registries_id, optional_params \\ [], opts \\ []) View Source
Gets a device registry configuration.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
name
. The name of the device registry. For example,projects/example-project/locations/us-central1/registries/my-registry
. - locations_id (String.t): Part of
name
. See documentation ofprojectsId
. - registries_id (String.t): Part of
name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.DeviceRegistry{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_get_iam_policy(connection, projects_id, locations_id, registries_id, optional_params \\ [], opts \\ []) View Source
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - locations_id (String.t): Part of
resource
. See documentation ofprojectsId
. - registries_id (String.t): Part of
resource
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudIot.V1.Model.GetIamPolicyRequest.t):
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.Policy{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_groups_devices_list(connection, projects_id, locations_id, registries_id, groups_id, optional_params \\ [], opts \\ []) View Source
List devices in a device registry.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
parent
. The device registry path. Required. For example,projects/my-project/locations/us-central1/registries/my-registry
. - locations_id (String.t): Part of
parent
. See documentation ofprojectsId
. - registries_id (String.t): Part of
parent
. See documentation ofprojectsId
. - groups_id (String.t): Part of
parent
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :deviceIds (list(String.t)): A list of device string IDs. For example,
['device0', 'device12']
.
If empty, this field is ignored. Maximum IDs: 10,000
- :deviceNumIds (list(String.t)): A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
- :fieldMask (String.t): The fields of the
Device
resource to be returned in the response. The fieldsid
andnum_id
are always returned, along with any other fields specified. - :gatewayListOptions.associationsDeviceId (String.t): If set, returns only the gateways with which the specified device is
associated. The device ID can be numeric (
num_id
) or the user-defined string (id
). For example, if456
is specified, returns only the gateways to which the device withnum_id
456 is bound. - :gatewayListOptions.associationsGatewayId (String.t): If set, only devices associated with the specified gateway are returned.
The gateway ID can be numeric (
num_id
) or the user-defined string (id
). For example, if123
is specified, only devices bound to the gateway withnum_id
123 are returned. - :gatewayListOptions.gatewayType (String.t): If
GATEWAY
is specified, only gateways are returned. IfNON_GATEWAY
is specified, only non-gateway devices are returned. IfGATEWAY_TYPE_UNSPECIFIED
is specified, all devices are returned. - :pageSize (integer()): The maximum number of devices to return in the response. If this value
is zero, the service will select a default size. A call may return fewer
objects than requested. A non-empty
next_page_token
in the response indicates that more data is available. - :pageToken (String.t): The value returned by the last
ListDevicesResponse
; indicates that this is a continuation of a priorListDevices
call and the system should return the next page of data.
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.ListDevicesResponse{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_groups_get_iam_policy(connection, projects_id, locations_id, registries_id, groups_id, optional_params \\ [], opts \\ []) View Source
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - locations_id (String.t): Part of
resource
. See documentation ofprojectsId
. - registries_id (String.t): Part of
resource
. See documentation ofprojectsId
. - groups_id (String.t): Part of
resource
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudIot.V1.Model.GetIamPolicyRequest.t):
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.Policy{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_groups_set_iam_policy(connection, projects_id, locations_id, registries_id, groups_id, optional_params \\ [], opts \\ []) View Source
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - locations_id (String.t): Part of
resource
. See documentation ofprojectsId
. - registries_id (String.t): Part of
resource
. See documentation ofprojectsId
. - groups_id (String.t): Part of
resource
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudIot.V1.Model.SetIamPolicyRequest.t):
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.Policy{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_groups_test_iam_permissions(connection, projects_id, locations_id, registries_id, groups_id, optional_params \\ [], opts \\ []) View Source
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - locations_id (String.t): Part of
resource
. See documentation ofprojectsId
. - registries_id (String.t): Part of
resource
. See documentation ofprojectsId
. - groups_id (String.t): Part of
resource
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudIot.V1.Model.TestIamPermissionsRequest.t):
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_list(connection, projects_id, locations_id, optional_params \\ [], opts \\ []) View Source
Lists device registries.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
parent
. The project and cloud region path. For example,projects/example-project/locations/us-central1
. - locations_id (String.t): Part of
parent
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (integer()): The maximum number of registries to return in the response. If this value
is zero, the service will select a default size. A call may return fewer
objects than requested. A non-empty next_page_token
in the response
indicates that more data is available.
- :pageToken (String.t): The value returned by the last
ListDeviceRegistriesResponse
; indicates that this is a continuation of a priorListDeviceRegistries
call and the system should return the next page of data.
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.ListDeviceRegistriesResponse{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_patch(connection, projects_id, locations_id, registries_id, optional_params \\ [], opts \\ []) View Source
Updates a device registry configuration.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
deviceRegistry.name
. The resource path name. For example,projects/example-project/locations/us-central1/registries/my-registry
. - locations_id (String.t): Part of
deviceRegistry.name
. See documentation ofprojectsId
. - registries_id (String.t): Part of
deviceRegistry.name
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :updateMask (String.t): Only updates the
device_registry
fields indicated by this mask.
The field mask must not be empty, and it must not contain fields that
are immutable or only set by the server.
Mutable top-level fields: event_notification_config
, http_config
,
mqtt_config
, and state_notification_config
.
- :body (GoogleApi.CloudIot.V1.Model.DeviceRegistry.t):
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.DeviceRegistry{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_set_iam_policy(connection, projects_id, locations_id, registries_id, optional_params \\ [], opts \\ []) View Source
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - locations_id (String.t): Part of
resource
. See documentation ofprojectsId
. - registries_id (String.t): Part of
resource
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudIot.V1.Model.SetIamPolicyRequest.t):
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.Policy{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_test_iam_permissions(connection, projects_id, locations_id, registries_id, optional_params \\ [], opts \\ []) View Source
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - locations_id (String.t): Part of
resource
. See documentation ofprojectsId
. - registries_id (String.t): Part of
resource
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudIot.V1.Model.TestIamPermissionsRequest.t):
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure
cloudiot_projects_locations_registries_unbind_device_from_gateway(connection, projects_id, locations_id, registries_id, optional_params \\ [], opts \\ []) View Source
Deletes the association between the device and the gateway.
Parameters
- connection (GoogleApi.CloudIot.V1.Connection): Connection to server
- projects_id (String.t): Part of
parent
. The name of the registry. For example,projects/example-project/locations/us-central1/registries/my-registry
. - locations_id (String.t): Part of
parent
. See documentation ofprojectsId
. - registries_id (String.t): Part of
parent
. See documentation ofprojectsId
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudIot.V1.Model.UnbindDeviceFromGatewayRequest.t):
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.UnbindDeviceFromGatewayResponse{}} on success {:error, info} on failure