public static final class ListDevicesRequest.Builder extends GeneratedMessageV3.Builder<ListDevicesRequest.Builder> implements ListDevicesRequestOrBuilder
Request for `ListDevices`.Protobuf type
google.cloud.iot.v1.ListDevicesRequest| Modifier and Type | Method and Description |
|---|---|
ListDevicesRequest.Builder |
addAllDeviceIds(Iterable<String> values)
A list of device string IDs.
|
ListDevicesRequest.Builder |
addAllDeviceNumIds(Iterable<? extends Long> values)
A list of device numeric IDs.
|
ListDevicesRequest.Builder |
addDeviceIds(String value)
A list of device string IDs.
|
ListDevicesRequest.Builder |
addDeviceIdsBytes(ByteString value)
A list of device string IDs.
|
ListDevicesRequest.Builder |
addDeviceNumIds(long value)
A list of device numeric IDs.
|
ListDevicesRequest.Builder |
addRepeatedField(Descriptors.FieldDescriptor field,
Object value) |
ListDevicesRequest |
build() |
ListDevicesRequest |
buildPartial() |
ListDevicesRequest.Builder |
clear() |
ListDevicesRequest.Builder |
clearDeviceIds()
A list of device string IDs.
|
ListDevicesRequest.Builder |
clearDeviceNumIds()
A list of device numeric IDs.
|
ListDevicesRequest.Builder |
clearField(Descriptors.FieldDescriptor field) |
ListDevicesRequest.Builder |
clearFieldMask()
The fields of the `Device` resource to be returned in the response.
|
ListDevicesRequest.Builder |
clearGatewayListOptions()
Options related to gateways.
|
ListDevicesRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof) |
ListDevicesRequest.Builder |
clearPageSize()
The maximum number of devices to return in the response.
|
ListDevicesRequest.Builder |
clearPageToken()
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.
|
ListDevicesRequest.Builder |
clearParent()
Required.
|
ListDevicesRequest.Builder |
clone() |
ListDevicesRequest |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
Descriptors.Descriptor |
getDescriptorForType() |
String |
getDeviceIds(int index)
A list of device string IDs.
|
ByteString |
getDeviceIdsBytes(int index)
A list of device string IDs.
|
int |
getDeviceIdsCount()
A list of device string IDs.
|
ProtocolStringList |
getDeviceIdsList()
A list of device string IDs.
|
long |
getDeviceNumIds(int index)
A list of device numeric IDs.
|
int |
getDeviceNumIdsCount()
A list of device numeric IDs.
|
List<Long> |
getDeviceNumIdsList()
A list of device numeric IDs.
|
FieldMask |
getFieldMask()
The fields of the `Device` resource to be returned in the response.
|
FieldMask.Builder |
getFieldMaskBuilder()
The fields of the `Device` resource to be returned in the response.
|
FieldMaskOrBuilder |
getFieldMaskOrBuilder()
The fields of the `Device` resource to be returned in the response.
|
GatewayListOptions |
getGatewayListOptions()
Options related to gateways.
|
GatewayListOptions.Builder |
getGatewayListOptionsBuilder()
Options related to gateways.
|
GatewayListOptionsOrBuilder |
getGatewayListOptionsOrBuilder()
Options related to gateways.
|
int |
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.
|
ByteString |
getPageTokenBytes()
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.
|
ByteString |
getParentBytes()
Required.
|
boolean |
hasFieldMask()
The fields of the `Device` resource to be returned in the response.
|
boolean |
hasGatewayListOptions()
Options related to gateways.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
ListDevicesRequest.Builder |
mergeFieldMask(FieldMask value)
The fields of the `Device` resource to be returned in the response.
|
ListDevicesRequest.Builder |
mergeFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
ListDevicesRequest.Builder |
mergeFrom(ListDevicesRequest other) |
ListDevicesRequest.Builder |
mergeFrom(Message other) |
ListDevicesRequest.Builder |
mergeGatewayListOptions(GatewayListOptions value)
Options related to gateways.
|
ListDevicesRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields) |
ListDevicesRequest.Builder |
setDeviceIds(int index,
String value)
A list of device string IDs.
|
ListDevicesRequest.Builder |
setDeviceNumIds(int index,
long value)
A list of device numeric IDs.
|
ListDevicesRequest.Builder |
setField(Descriptors.FieldDescriptor field,
Object value) |
ListDevicesRequest.Builder |
setFieldMask(FieldMask.Builder builderForValue)
The fields of the `Device` resource to be returned in the response.
|
ListDevicesRequest.Builder |
setFieldMask(FieldMask value)
The fields of the `Device` resource to be returned in the response.
|
ListDevicesRequest.Builder |
setGatewayListOptions(GatewayListOptions.Builder builderForValue)
Options related to gateways.
|
ListDevicesRequest.Builder |
setGatewayListOptions(GatewayListOptions value)
Options related to gateways.
|
ListDevicesRequest.Builder |
setPageSize(int value)
The maximum number of devices to return in the response.
|
ListDevicesRequest.Builder |
setPageToken(String value)
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.
|
ListDevicesRequest.Builder |
setPageTokenBytes(ByteString value)
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.
|
ListDevicesRequest.Builder |
setParent(String value)
Required.
|
ListDevicesRequest.Builder |
setParentBytes(ByteString value)
Required.
|
ListDevicesRequest.Builder |
setRepeatedField(Descriptors.FieldDescriptor field,
int index,
Object value) |
ListDevicesRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofmergeDelimitedFrom, mergeDelimitedFrommergeFrompublic static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<ListDevicesRequest.Builder>public ListDevicesRequest.Builder clear()
clear in interface Message.Builderclear in interface MessageLite.Builderclear in class GeneratedMessageV3.Builder<ListDevicesRequest.Builder>public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface Message.BuildergetDescriptorForType in interface MessageOrBuildergetDescriptorForType in class GeneratedMessageV3.Builder<ListDevicesRequest.Builder>public ListDevicesRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderpublic ListDevicesRequest build()
build in interface Message.Builderbuild in interface MessageLite.Builderpublic ListDevicesRequest buildPartial()
buildPartial in interface Message.BuilderbuildPartial in interface MessageLite.Builderpublic ListDevicesRequest.Builder clone()
clone in interface Message.Builderclone in interface MessageLite.Builderclone in class GeneratedMessageV3.Builder<ListDevicesRequest.Builder>public ListDevicesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
setField in interface Message.BuildersetField in class GeneratedMessageV3.Builder<ListDevicesRequest.Builder>public ListDevicesRequest.Builder clearField(Descriptors.FieldDescriptor field)
clearField in interface Message.BuilderclearField in class GeneratedMessageV3.Builder<ListDevicesRequest.Builder>public ListDevicesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof in interface Message.BuilderclearOneof in class GeneratedMessageV3.Builder<ListDevicesRequest.Builder>public ListDevicesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface Message.BuildersetRepeatedField in class GeneratedMessageV3.Builder<ListDevicesRequest.Builder>public ListDevicesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface Message.BuilderaddRepeatedField in class GeneratedMessageV3.Builder<ListDevicesRequest.Builder>public ListDevicesRequest.Builder mergeFrom(Message other)
mergeFrom in interface Message.BuildermergeFrom in class AbstractMessage.Builder<ListDevicesRequest.Builder>public ListDevicesRequest.Builder mergeFrom(ListDevicesRequest other)
public final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3.Builder<ListDevicesRequest.Builder>public ListDevicesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessage.Builder<ListDevicesRequest.Builder>IOExceptionpublic String getParent()
Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParent in interface ListDevicesRequestOrBuilderpublic ByteString getParentBytes()
Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParentBytes in interface ListDevicesRequestOrBuilderpublic ListDevicesRequest.Builder setParent(String value)
Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
value - The parent to set.public ListDevicesRequest.Builder clearParent()
Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
public ListDevicesRequest.Builder setParentBytes(ByteString value)
Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
value - The bytes for parent to set.public List<Long> getDeviceNumIdsList()
A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
repeated uint64 device_num_ids = 2;getDeviceNumIdsList in interface ListDevicesRequestOrBuilderpublic int getDeviceNumIdsCount()
A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
repeated uint64 device_num_ids = 2;getDeviceNumIdsCount in interface ListDevicesRequestOrBuilderpublic long getDeviceNumIds(int index)
A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
repeated uint64 device_num_ids = 2;getDeviceNumIds in interface ListDevicesRequestOrBuilderindex - The index of the element to return.public ListDevicesRequest.Builder setDeviceNumIds(int index, long value)
A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
repeated uint64 device_num_ids = 2;index - The index to set the value at.value - The deviceNumIds to set.public ListDevicesRequest.Builder addDeviceNumIds(long value)
A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
repeated uint64 device_num_ids = 2;value - The deviceNumIds to add.public ListDevicesRequest.Builder addAllDeviceNumIds(Iterable<? extends Long> values)
A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
repeated uint64 device_num_ids = 2;values - The deviceNumIds to add.public ListDevicesRequest.Builder clearDeviceNumIds()
A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
repeated uint64 device_num_ids = 2;public ProtocolStringList getDeviceIdsList()
A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
repeated string device_ids = 3;getDeviceIdsList in interface ListDevicesRequestOrBuilderpublic int getDeviceIdsCount()
A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
repeated string device_ids = 3;getDeviceIdsCount in interface ListDevicesRequestOrBuilderpublic String getDeviceIds(int index)
A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
repeated string device_ids = 3;getDeviceIds in interface ListDevicesRequestOrBuilderindex - The index of the element to return.public ByteString getDeviceIdsBytes(int index)
A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
repeated string device_ids = 3;getDeviceIdsBytes in interface ListDevicesRequestOrBuilderindex - The index of the value to return.public ListDevicesRequest.Builder setDeviceIds(int index, String value)
A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
repeated string device_ids = 3;index - The index to set the value at.value - The deviceIds to set.public ListDevicesRequest.Builder addDeviceIds(String value)
A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
repeated string device_ids = 3;value - The deviceIds to add.public ListDevicesRequest.Builder addAllDeviceIds(Iterable<String> values)
A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
repeated string device_ids = 3;values - The deviceIds to add.public ListDevicesRequest.Builder clearDeviceIds()
A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
repeated string device_ids = 3;public ListDevicesRequest.Builder addDeviceIdsBytes(ByteString value)
A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
repeated string device_ids = 3;value - The bytes of the deviceIds to add.public boolean hasFieldMask()
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`.
.google.protobuf.FieldMask field_mask = 4;hasFieldMask in interface ListDevicesRequestOrBuilderpublic FieldMask 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`.
.google.protobuf.FieldMask field_mask = 4;getFieldMask in interface ListDevicesRequestOrBuilderpublic ListDevicesRequest.Builder setFieldMask(FieldMask value)
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`.
.google.protobuf.FieldMask field_mask = 4;public ListDevicesRequest.Builder setFieldMask(FieldMask.Builder builderForValue)
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`.
.google.protobuf.FieldMask field_mask = 4;public ListDevicesRequest.Builder mergeFieldMask(FieldMask value)
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`.
.google.protobuf.FieldMask field_mask = 4;public ListDevicesRequest.Builder clearFieldMask()
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`.
.google.protobuf.FieldMask field_mask = 4;public FieldMask.Builder getFieldMaskBuilder()
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`.
.google.protobuf.FieldMask field_mask = 4;public FieldMaskOrBuilder getFieldMaskOrBuilder()
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`.
.google.protobuf.FieldMask field_mask = 4;getFieldMaskOrBuilder in interface ListDevicesRequestOrBuilderpublic boolean hasGatewayListOptions()
Options related to gateways.
.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;hasGatewayListOptions in interface ListDevicesRequestOrBuilderpublic GatewayListOptions getGatewayListOptions()
Options related to gateways.
.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;getGatewayListOptions in interface ListDevicesRequestOrBuilderpublic ListDevicesRequest.Builder setGatewayListOptions(GatewayListOptions value)
Options related to gateways.
.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;public ListDevicesRequest.Builder setGatewayListOptions(GatewayListOptions.Builder builderForValue)
Options related to gateways.
.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;public ListDevicesRequest.Builder mergeGatewayListOptions(GatewayListOptions value)
Options related to gateways.
.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;public ListDevicesRequest.Builder clearGatewayListOptions()
Options related to gateways.
.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;public GatewayListOptions.Builder getGatewayListOptionsBuilder()
Options related to gateways.
.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;public GatewayListOptionsOrBuilder getGatewayListOptionsOrBuilder()
Options related to gateways.
.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;getGatewayListOptionsOrBuilder in interface ListDevicesRequestOrBuilderpublic int 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.
int32 page_size = 100;getPageSize in interface ListDevicesRequestOrBuilderpublic ListDevicesRequest.Builder setPageSize(int value)
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.
int32 page_size = 100;value - The pageSize to set.public ListDevicesRequest.Builder clearPageSize()
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.
int32 page_size = 100;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.
string page_token = 101;getPageToken in interface ListDevicesRequestOrBuilderpublic ByteString getPageTokenBytes()
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 page_token = 101;getPageTokenBytes in interface ListDevicesRequestOrBuilderpublic ListDevicesRequest.Builder setPageToken(String value)
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 page_token = 101;value - The pageToken to set.public ListDevicesRequest.Builder clearPageToken()
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 page_token = 101;public ListDevicesRequest.Builder setPageTokenBytes(ByteString value)
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 page_token = 101;value - The bytes for pageToken to set.public final ListDevicesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields in interface Message.BuildersetUnknownFields in class GeneratedMessageV3.Builder<ListDevicesRequest.Builder>public final ListDevicesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields in interface Message.BuildermergeUnknownFields in class GeneratedMessageV3.Builder<ListDevicesRequest.Builder>Copyright © 2022 Google LLC. All rights reserved.