com.google.api.services.cloudiot.v1

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

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<ListDeviceStatesResponse>

com.google.api.services.cloudiot.v1.CloudIot.Projects.Locations.Registries.Devices.States.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudIot.Projects.Locations.Registries.Devices.States

public class CloudIot.Projects.Locations.Registries.Devices.States.List
extends CloudIotRequest<ListDeviceStatesResponse>

Nested Class Summary

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

com.google.api.client.util.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 name) Lists the last few versions of the device state in descending order (i.e.: newest first).

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getName() Required.
Integer	getNumStates() The number of states to list.
CloudIot.Projects.Locations.Registries.Devices.States.List	set(String parameterName, Object value)
CloudIot.Projects.Locations.Registries.Devices.States.List	set$Xgafv(String $Xgafv) V1 error format.
CloudIot.Projects.Locations.Registries.Devices.States.List	setAccessToken(String accessToken) OAuth access token.
CloudIot.Projects.Locations.Registries.Devices.States.List	setAlt(String alt) Data format for response.
CloudIot.Projects.Locations.Registries.Devices.States.List	setCallback(String callback) JSONP
CloudIot.Projects.Locations.Registries.Devices.States.List	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudIot.Projects.Locations.Registries.Devices.States.List	setKey(String key) API key.
CloudIot.Projects.Locations.Registries.Devices.States.List	setName(String name) Required.
CloudIot.Projects.Locations.Registries.Devices.States.List	setNumStates(Integer numStates) The number of states to list.
CloudIot.Projects.Locations.Registries.Devices.States.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudIot.Projects.Locations.Registries.Devices.States.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudIot.Projects.Locations.Registries.Devices.States.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudIot.Projects.Locations.Registries.Devices.States.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudIot.Projects.Locations.Registries.Devices.States.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.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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 name)

Lists the last few versions of the device state in descending order (i.e.: newest first). Create a request for the method "states.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:

name - Required. The name of the device. For example, `projects/p0/locations/us- central1/registries/registry0/devices/device0` or `projects/p0/locations/us- central1/registries/registry0/devices/{num_id}`.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListDeviceStatesResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListDeviceStatesResponse>

Throws:

IOException

set$Xgafv

public CloudIot.Projects.Locations.Registries.Devices.States.List set$Xgafv(String $Xgafv)

Description copied from class: CloudIotRequest

V1 error format.

Overrides:

set$Xgafv in class CloudIotRequest<ListDeviceStatesResponse>

setAccessToken

public CloudIot.Projects.Locations.Registries.Devices.States.List setAccessToken(String accessToken)

Description copied from class: CloudIotRequest

OAuth access token.

Overrides:

setAccessToken in class CloudIotRequest<ListDeviceStatesResponse>

setAlt

public CloudIot.Projects.Locations.Registries.Devices.States.List setAlt(String alt)

Description copied from class: CloudIotRequest

Data format for response.

Overrides:

setAlt in class CloudIotRequest<ListDeviceStatesResponse>

setCallback

public CloudIot.Projects.Locations.Registries.Devices.States.List setCallback(String callback)

Description copied from class: CloudIotRequest

JSONP

Overrides:

setCallback in class CloudIotRequest<ListDeviceStatesResponse>

setFields

public CloudIot.Projects.Locations.Registries.Devices.States.List setFields(String fields)

Description copied from class: CloudIotRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudIotRequest<ListDeviceStatesResponse>

setKey

public CloudIot.Projects.Locations.Registries.Devices.States.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<ListDeviceStatesResponse>

setOauthToken

public CloudIot.Projects.Locations.Registries.Devices.States.List setOauthToken(String oauthToken)

Description copied from class: CloudIotRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudIotRequest<ListDeviceStatesResponse>

setPrettyPrint

public CloudIot.Projects.Locations.Registries.Devices.States.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudIotRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudIotRequest<ListDeviceStatesResponse>

setQuotaUser

public CloudIot.Projects.Locations.Registries.Devices.States.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<ListDeviceStatesResponse>

setUploadType

public CloudIot.Projects.Locations.Registries.Devices.States.List setUploadType(String uploadType)

Description copied from class: CloudIotRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class CloudIotRequest<ListDeviceStatesResponse>

setUploadProtocol

public CloudIot.Projects.Locations.Registries.Devices.States.List setUploadProtocol(String uploadProtocol)

Description copied from class: CloudIotRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class CloudIotRequest<ListDeviceStatesResponse>

getName

public String getName()

Required. The name of the device. For example, `projects/p0/locations/us- central1/registries/registry0/devices/device0` or `projects/p0/locations/us- central1/registries/registry0/devices/{num_id}`.

setName

public CloudIot.Projects.Locations.Registries.Devices.States.List setName(String name)

Required. The name of the device. For example, `projects/p0/locations/us- central1/registries/registry0/devices/device0` or `projects/p0/locations/us- central1/registries/registry0/devices/{num_id}`.

getNumStates

public Integer getNumStates()

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.

setNumStates

public CloudIot.Projects.Locations.Registries.Devices.States.List setNumStates(Integer numStates)

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.

set

public CloudIot.Projects.Locations.Registries.Devices.States.List set(String parameterName,
                                                                      Object value)

Overrides:

set in class CloudIotRequest<ListDeviceStatesResponse>