google_api_cloud_iot v0.21.1 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 Sourcecloudiot_projects_locations_registries_bind_device_to_gateway( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.BindDeviceToGatewayResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Associates the device with the gateway.
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. The name of the registry. For example,projects/example-project/locations/us-central1/registries/my-registry
.locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudIot.V1.Model.BindDeviceToGatewayRequest.t
) -
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_create( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.DeviceRegistry.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a device registry that contains devices.
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. The project and cloud region where this device registry must be created. For example,projects/example-project/locations/us-central1
.locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudIot.V1.Model.DeviceRegistry.t
) -
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a device registry configuration.
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Required. The name of the device registry. For example,projects/example-project/locations/us-central1/registries/my-registry
.locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_devices_config_versions_list( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.ListDeviceConfigVersionsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists the last few versions of the device configuration in descending order (i.e.: newest first).
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Required. 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
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.devices_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:numVersions
(type: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.
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_devices_create( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.Device.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a device in a device registry.
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. 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
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudIot.V1.Model.Device.t
) -
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_devices_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a device.
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Required. 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
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.devices_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_devices_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.Device.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets details about a device.
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Required. 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
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.devices_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:fieldMask
(type:String.t
) - The fields of theDevice
resource to be returned in the response. If the field mask is unset or empty, all fields are returned.
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_devices_list( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.ListDevicesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
List devices in a device registry.
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. The device registry path. Required. For example,projects/my-project/locations/us-central1/registries/my-registry
.locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:deviceIds
(type:list(String.t)
) - A list of device string IDs. For example,['device0', 'device12']
. If empty, this field is ignored. Maximum IDs: 10,000:deviceNumIds
(type:list(String.t)
) - A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.:fieldMask
(type:String.t
) - The fields of theDevice
resource to be returned in the response. The fieldsid
andnum_id
are always returned, along with any other fields specified.:"gatewayListOptions.associationsDeviceId"
(type: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"
(type: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"
(type:String.t
) - IfGATEWAY
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
(type: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-emptynext_page_token
in the response indicates that more data is available.:pageToken
(type:String.t
) - The value returned by the lastListDevicesResponse
; indicates that this is a continuation of a priorListDevices
call and the system should return the next page of data.
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_devices_modify_cloud_to_device_config( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.DeviceConfig.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Required. 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
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.devices_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudIot.V1.Model.ModifyCloudToDeviceConfigRequest.t
) -
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_devices_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.Device.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates a device.
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofdevice.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
(type:String.t
) - Part ofdevice.name
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofdevice.name
. See documentation ofprojectsId
.devices_id
(type:String.t
) - Part ofdevice.name
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:updateMask
(type:String.t
) - Required. Only updates thedevice
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
, andmetadata
:body
(type:GoogleApi.CloudIot.V1.Model.Device.t
) -
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_devices_send_command_to_device( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.SendCommandToDeviceResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Required. 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
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.devices_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudIot.V1.Model.SendCommandToDeviceRequest.t
) -
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_devices_states_list( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.ListDeviceStatesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists the last few versions of the device state in descending order (i.e.: newest first).
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Required. 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
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.devices_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:numStates
(type: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.
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.DeviceRegistry.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets a device registry configuration.
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Required. The name of the device registry. For example,projects/example-project/locations/us-central1/registries/my-registry
.locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudIot.V1.Model.GetIamPolicyRequest.t
) -
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_groups_devices_list( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.ListDevicesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
List devices in a device registry.
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. The device registry path. Required. For example,projects/my-project/locations/us-central1/registries/my-registry
.locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.groups_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:deviceIds
(type:list(String.t)
) - A list of device string IDs. For example,['device0', 'device12']
. If empty, this field is ignored. Maximum IDs: 10,000:deviceNumIds
(type:list(String.t)
) - A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.:fieldMask
(type:String.t
) - The fields of theDevice
resource to be returned in the response. The fieldsid
andnum_id
are always returned, along with any other fields specified.:"gatewayListOptions.associationsDeviceId"
(type: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"
(type: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"
(type:String.t
) - IfGATEWAY
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
(type: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-emptynext_page_token
in the response indicates that more data is available.:pageToken
(type:String.t
) - The value returned by the lastListDevicesResponse
; indicates that this is a continuation of a priorListDevices
call and the system should return the next page of data.
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_groups_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.groups_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudIot.V1.Model.GetIamPolicyRequest.t
) -
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_groups_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.groups_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudIot.V1.Model.SetIamPolicyRequest.t
) -
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_groups_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.groups_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudIot.V1.Model.TestIamPermissionsRequest.t
) -
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.ListDeviceRegistriesResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists device registries.
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. The project and cloud region path. For example,projects/example-project/locations/us-central1
.locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:pageSize
(type: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-emptynext_page_token
in the response indicates that more data is available.:pageToken
(type:String.t
) - The value returned by the lastListDeviceRegistriesResponse
; indicates that this is a continuation of a priorListDeviceRegistries
call and the system should return the next page of data.
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.DeviceRegistry.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates a device registry configuration.
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofdeviceRegistry.name
. The resource path name. For example,projects/example-project/locations/us-central1/registries/my-registry
.locations_id
(type:String.t
) - Part ofdeviceRegistry.name
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofdeviceRegistry.name
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:updateMask
(type:String.t
) - Required. Only updates thedevice_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
, andstate_notification_config
.:body
(type:GoogleApi.CloudIot.V1.Model.DeviceRegistry.t
) -
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudIot.V1.Model.SetIamPolicyRequest.t
) -
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudIot.V1.Model.TestIamPermissionsRequest.t
) -
opts
(type:keyword()
) - Call options
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 Sourcecloudiot_projects_locations_registries_unbind_device_from_gateway( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIot.V1.Model.UnbindDeviceFromGatewayResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes the association between the device and the gateway.
Parameters
connection
(type:GoogleApi.CloudIot.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. The name of the registry. For example,projects/example-project/locations/us-central1/registries/my-registry
.locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.registries_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type: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
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type: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
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.CloudIot.V1.Model.UnbindDeviceFromGatewayRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.CloudIot.V1.Model.UnbindDeviceFromGatewayResponse{}}
on success{:error, info}
on failure