Class GatewayListOptions.Builder (2.29.0)

Version 2.29.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.6
• 2.2.1
• 2.1.7

public static final class GatewayListOptions.Builder extends GeneratedMessageV3.Builder<GatewayListOptions.Builder> implements GatewayListOptionsOrBuilder

Options for limiting the list based on gateway type and associations.

Protobuf type google.cloud.iot.v1.GatewayListOptions

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GatewayListOptions.Builder

Implements

GatewayListOptionsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GatewayListOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
GatewayListOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public GatewayListOptions build()

Returns
Type	Description
GatewayListOptions

buildPartial()

public GatewayListOptions buildPartial()

Returns
Type	Description
GatewayListOptions

clear()

public GatewayListOptions.Builder clear()

Returns
Type	Description
GatewayListOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAssociationsDeviceId()

public GatewayListOptions.Builder clearAssociationsDeviceId()

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.

string associations_device_id = 3;

Returns
Type	Description
GatewayListOptions.Builder	This builder for chaining.

clearAssociationsGatewayId()

public GatewayListOptions.Builder clearAssociationsGatewayId()

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.

string associations_gateway_id = 2;

Returns
Type	Description
GatewayListOptions.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public GatewayListOptions.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
GatewayListOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public GatewayListOptions.Builder clearFilter()

Returns
Type	Description
GatewayListOptions.Builder

clearGatewayType()

public GatewayListOptions.Builder clearGatewayType()

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.

.google.cloud.iot.v1.GatewayType gateway_type = 1;

Returns
Type	Description
GatewayListOptions.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GatewayListOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
GatewayListOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public GatewayListOptions.Builder clone()

Returns
Type	Description
GatewayListOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAssociationsDeviceId()

public String getAssociationsDeviceId()

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.

string associations_device_id = 3;

Returns
Type	Description
String	The associationsDeviceId.

getAssociationsDeviceIdBytes()

public ByteString getAssociationsDeviceIdBytes()

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.

string associations_device_id = 3;

Returns
Type	Description
ByteString	The bytes for associationsDeviceId.

getAssociationsGatewayId()

public String getAssociationsGatewayId()

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.

string associations_gateway_id = 2;

Returns
Type	Description
String	The associationsGatewayId.

getAssociationsGatewayIdBytes()

public ByteString getAssociationsGatewayIdBytes()

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.

string associations_gateway_id = 2;

Returns
Type	Description
ByteString	The bytes for associationsGatewayId.

getDefaultInstanceForType()

public GatewayListOptions getDefaultInstanceForType()

Returns
Type	Description
GatewayListOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilterCase()

public GatewayListOptions.FilterCase getFilterCase()

Returns
Type	Description
GatewayListOptions.FilterCase

getGatewayType()

public GatewayType getGatewayType()

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.

.google.cloud.iot.v1.GatewayType gateway_type = 1;

Returns
Type	Description
GatewayType	The gatewayType.

getGatewayTypeValue()

public int getGatewayTypeValue()

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.

.google.cloud.iot.v1.GatewayType gateway_type = 1;

Returns
Type	Description
int	The enum numeric value on the wire for gatewayType.

hasAssociationsDeviceId()

public boolean hasAssociationsDeviceId()

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.

string associations_device_id = 3;

Returns
Type	Description
boolean	Whether the associationsDeviceId field is set.

hasAssociationsGatewayId()

public boolean hasAssociationsGatewayId()

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.

string associations_gateway_id = 2;

Returns
Type	Description
boolean	Whether the associationsGatewayId field is set.

hasGatewayType()

public boolean hasGatewayType()

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.

.google.cloud.iot.v1.GatewayType gateway_type = 1;

Returns
Type	Description
boolean	Whether the gatewayType field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(GatewayListOptions other)

public GatewayListOptions.Builder mergeFrom(GatewayListOptions other)

Parameter
Name	Description
other	GatewayListOptions

Returns
Type	Description
GatewayListOptions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GatewayListOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GatewayListOptions.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public GatewayListOptions.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
GatewayListOptions.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GatewayListOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
GatewayListOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAssociationsDeviceId(String value)

public GatewayListOptions.Builder setAssociationsDeviceId(String value)

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.

string associations_device_id = 3;

Parameter
Name	Description
value	String The associationsDeviceId to set.

Returns
Type	Description
GatewayListOptions.Builder	This builder for chaining.

setAssociationsDeviceIdBytes(ByteString value)

public GatewayListOptions.Builder setAssociationsDeviceIdBytes(ByteString value)

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.

string associations_device_id = 3;

Parameter
Name	Description
value	ByteString The bytes for associationsDeviceId to set.

Returns
Type	Description
GatewayListOptions.Builder	This builder for chaining.

setAssociationsGatewayId(String value)

public GatewayListOptions.Builder setAssociationsGatewayId(String value)

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.

string associations_gateway_id = 2;

Parameter
Name	Description
value	String The associationsGatewayId to set.

Returns
Type	Description
GatewayListOptions.Builder	This builder for chaining.

setAssociationsGatewayIdBytes(ByteString value)

public GatewayListOptions.Builder setAssociationsGatewayIdBytes(ByteString value)

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.

string associations_gateway_id = 2;

Parameter
Name	Description
value	ByteString The bytes for associationsGatewayId to set.

Returns
Type	Description
GatewayListOptions.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public GatewayListOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
GatewayListOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setGatewayType(GatewayType value)

public GatewayListOptions.Builder setGatewayType(GatewayType value)

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.

.google.cloud.iot.v1.GatewayType gateway_type = 1;

Parameter
Name	Description
value	GatewayType The gatewayType to set.

Returns
Type	Description
GatewayListOptions.Builder	This builder for chaining.

setGatewayTypeValue(int value)

public GatewayListOptions.Builder setGatewayTypeValue(int value)

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.

.google.cloud.iot.v1.GatewayType gateway_type = 1;

Parameter
Name	Description
value	int The enum numeric value on the wire for gatewayType to set.

Returns
Type	Description
GatewayListOptions.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GatewayListOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
GatewayListOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final GatewayListOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
GatewayListOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)