CloudIot.Projects.Locations.Registries.Groups.Devices.List (Cloud IoT API v1-rev20210323-1.31.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.cloudiot.v1.CloudIotRequest<ListDevicesResponse>
        
        com.google.api.services.cloudiot.v1.CloudIot.Projects.Locations.Registries.Groups.Devices.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudIot.Projects.Locations.Registries.Groups.Devices
```
public class CloudIot.Projects.Locations.Registries.Groups.Devices.List
extends CloudIotRequest<ListDevicesResponse>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(String parent)
List devices in a device registry.

Constructors
Modifier	Constructor and Description
`protected`	`List(String parent)` List devices in a device registry.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`List<String>`	`getDeviceIds()` A list of device string IDs.
`List<BigInteger>`	`getDeviceNumIds()` A list of device numeric IDs.
`String`	`getFieldMask()` The fields of the `Device` resource to be returned in the response.
`String`	`getGatewayListOptionsAssociationsDeviceId()` If set, returns only the gateways with which the specified device is associated.
`String`	`getGatewayListOptionsAssociationsGatewayId()` If set, only devices associated with the specified gateway are returned.
`String`	`getGatewayListOptionsGatewayType()` If `GATEWAY` is specified, only gateways are returned.
`Integer`	`getPageSize()` The maximum number of devices to return in the response.
`String`	`getPageToken()` The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call and the system should return the next page of data.
`String`	`getParent()` Required.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`set(String parameterName, Object value)`
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setAccessToken(String accessToken)` OAuth access token.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setAlt(String alt)` Data format for response.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setCallback(String callback)` JSONP
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setDeviceIds(List<String> deviceIds)` A list of device string IDs.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setDeviceNumIds(List<BigInteger> deviceNumIds)` A list of device numeric IDs.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setFieldMask(String fieldMask)` The fields of the `Device` resource to be returned in the response.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setGatewayListOptionsAssociationsDeviceId(String gatewayListOptionsAssociationsDeviceId)` If set, returns only the gateways with which the specified device is associated.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setGatewayListOptionsAssociationsGatewayId(String gatewayListOptionsAssociationsGatewayId)` If set, only devices associated with the specified gateway are returned.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setGatewayListOptionsGatewayType(String gatewayListOptionsGatewayType)` If `GATEWAY` is specified, only gateways are returned.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setKey(String key)` API key.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setPageSize(Integer pageSize)` The maximum number of devices to return in the response.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setPageToken(String pageToken)` The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call and the system should return the next page of data.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setParent(String parent)` Required.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`CloudIot.Projects.Locations.Registries.Groups.Devices.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.cloudiot.v1.CloudIotRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - List
```
protected List(String parent)
```
    List devices in a device registry. Create a request for the method "devices.list". This request holds the parameters needed by the the cloudiot server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    CloudIot.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    parent - Required. The device registry path. Required. For example, `projects/my-project/locations/us- central1/registries/my-registry`.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<ListDevicesResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListDevicesResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List set$Xgafv(String $Xgafv)
```
    Description copied from class: CloudIotRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class CloudIotRequest<ListDevicesResponse>
  - setAccessToken
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setAccessToken(String accessToken)
```
    Description copied from class: CloudIotRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class CloudIotRequest<ListDevicesResponse>
  - setAlt
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setAlt(String alt)
```
    Description copied from class: CloudIotRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class CloudIotRequest<ListDevicesResponse>
  - setCallback
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setCallback(String callback)
```
    Description copied from class: CloudIotRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class CloudIotRequest<ListDevicesResponse>
  - setFields
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setFields(String fields)
```
    Description copied from class: CloudIotRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class CloudIotRequest<ListDevicesResponse>
  - setKey
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setKey(String key)
```
    Description copied from class: CloudIotRequest
    
    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.
    
    Overrides:
    
    setKey in class CloudIotRequest<ListDevicesResponse>
  - setOauthToken
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setOauthToken(String oauthToken)
```
    Description copied from class: CloudIotRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CloudIotRequest<ListDevicesResponse>
  - setPrettyPrint
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: CloudIotRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CloudIotRequest<ListDevicesResponse>
  - setQuotaUser
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setQuotaUser(String quotaUser)
```
    Description copied from class: CloudIotRequest
    
    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.
    
    Overrides:
    
    setQuotaUser in class CloudIotRequest<ListDevicesResponse>
  - setUploadType
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setUploadType(String uploadType)
```
    Description copied from class: CloudIotRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class CloudIotRequest<ListDevicesResponse>
  - setUploadProtocol
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: CloudIotRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class CloudIotRequest<ListDevicesResponse>
  - getParent
```
public String getParent()
```
    Required. The device registry path. Required. For example, `projects/my-project/locations/us- central1/registries/my-registry`.
  - setParent
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setParent(String parent)
```
    Required. The device registry path. Required. For example, `projects/my- project/locations/us-central1/registries/my-registry`.
  - getDeviceIds
```
public List<String> getDeviceIds()
```
    A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
  - setDeviceIds
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setDeviceIds(List<String> deviceIds)
```
    A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
  - getDeviceNumIds
```
public List<BigInteger> getDeviceNumIds()
```
    A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
  - setDeviceNumIds
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setDeviceNumIds(List<BigInteger> deviceNumIds)
```
    A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
  - getFieldMask
```
public String getFieldMask()
```
    The fields of the `Device` resource to be returned in the response. The fields `id` and `num_id` are always returned, along with any other fields specified in snake_case format, for example: `last_heartbeat_time`.
  - setFieldMask
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setFieldMask(String fieldMask)
```
    The fields of the `Device` resource to be returned in the response. The fields `id` and `num_id` are always returned, along with any other fields specified in snake_case format, for example: `last_heartbeat_time`.
  - getGatewayListOptionsAssociationsDeviceId
```
public String getGatewayListOptionsAssociationsDeviceId()
```
    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, if `456` is specified, returns only the gateways to which the device with `num_id` 456 is bound.
  - setGatewayListOptionsAssociationsDeviceId
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setGatewayListOptionsAssociationsDeviceId(String gatewayListOptionsAssociationsDeviceId)
```
    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, if `456` is specified, returns only the gateways to which the device with `num_id` 456 is bound.
  - getGatewayListOptionsAssociationsGatewayId
```
public String getGatewayListOptionsAssociationsGatewayId()
```
    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, if `123` is specified, only devices bound to the gateway with `num_id` 123 are returned.
  - setGatewayListOptionsAssociationsGatewayId
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setGatewayListOptionsAssociationsGatewayId(String gatewayListOptionsAssociationsGatewayId)
```
    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, if `123` is specified, only devices bound to the gateway with `num_id` 123 are returned.
  - getGatewayListOptionsGatewayType
```
public String getGatewayListOptionsGatewayType()
```
    If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` is specified, only non- gateway devices are returned. If `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned.
  - setGatewayListOptionsGatewayType
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setGatewayListOptionsGatewayType(String gatewayListOptionsGatewayType)
```
    If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` is specified, only non-gateway devices are returned. If `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned.
  - getPageSize
```
public Integer getPageSize()
```
    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.
  - setPageSize
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setPageSize(Integer pageSize)
```
    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.
  - getPageToken
```
public String getPageToken()
```
    The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call and the system should return the next page of data.
  - setPageToken
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List setPageToken(String pageToken)
```
    The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call and the system should return the next page of data.
  - set
```
public CloudIot.Projects.Locations.Registries.Groups.Devices.List set(String parameterName,
                                                                      Object value)
```
    Overrides:
    
    set in class CloudIotRequest<ListDevicesResponse>

Class CloudIot.Projects.Locations.Registries.Groups.Devices.List

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.cloudiot.v1.CloudIotRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getParent

setParent

getDeviceIds

setDeviceIds

getDeviceNumIds

setDeviceNumIds

getFieldMask

setFieldMask

getGatewayListOptionsAssociationsDeviceId

setGatewayListOptionsAssociationsDeviceId

getGatewayListOptionsAssociationsGatewayId

setGatewayListOptionsAssociationsGatewayId

getGatewayListOptionsGatewayType

setGatewayListOptionsGatewayType

getPageSize

setPageSize

getPageToken

setPageToken

set