Class GatewayListOptions.Builder (2.45.0)

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

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

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

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

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

clone()

public GatewayListOptions.Builder clone()
Returns
Type Description
GatewayListOptions.Builder
Overrides

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

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GatewayListOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GatewayListOptions.Builder
Overrides

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final GatewayListOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GatewayListOptions.Builder
Overrides