Class ListDeviceStatesRequest.Builder (2.83.0)

public static final class ListDeviceStatesRequest.Builder extends GeneratedMessage.Builder<ListDeviceStatesRequest.Builder> implements ListDeviceStatesRequestOrBuilder

Request for ListDeviceStates.

Protobuf type google.cloud.iot.v1.ListDeviceStatesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ListDeviceStatesRequest build()
Returns
Type Description
ListDeviceStatesRequest

buildPartial()

public ListDeviceStatesRequest buildPartial()
Returns
Type Description
ListDeviceStatesRequest

clear()

public ListDeviceStatesRequest.Builder clear()
Returns
Type Description
ListDeviceStatesRequest.Builder
Overrides

clearName()

public ListDeviceStatesRequest.Builder clearName()

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}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListDeviceStatesRequest.Builder

This builder for chaining.

clearNumStates()

public ListDeviceStatesRequest.Builder clearNumStates()

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.

int32 num_states = 2;

Returns
Type Description
ListDeviceStatesRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListDeviceStatesRequest getDefaultInstanceForType()
Returns
Type Description
ListDeviceStatesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getNumStates()

public int 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.

int32 num_states = 2;

Returns
Type Description
int

The numStates.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListDeviceStatesRequest other)

public ListDeviceStatesRequest.Builder mergeFrom(ListDeviceStatesRequest other)
Parameter
Name Description
other ListDeviceStatesRequest
Returns
Type Description
ListDeviceStatesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListDeviceStatesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDeviceStatesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListDeviceStatesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListDeviceStatesRequest.Builder
Overrides

setName(String value)

public ListDeviceStatesRequest.Builder setName(String value)

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}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ListDeviceStatesRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ListDeviceStatesRequest.Builder setNameBytes(ByteString value)

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}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ListDeviceStatesRequest.Builder

This builder for chaining.

setNumStates(int value)

public ListDeviceStatesRequest.Builder setNumStates(int value)

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.

int32 num_states = 2;

Parameter
Name Description
value int

The numStates to set.

Returns
Type Description
ListDeviceStatesRequest.Builder

This builder for chaining.