Class GatewayListOptions (2.21.0) 

public final class GatewayListOptions extends GeneratedMessageV3 implements GatewayListOptionsOrBuilder

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

Protobuf type google.cloud.iot.v1.GatewayListOptions

Inheritance

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

Static Fields

ASSOCIATIONS_DEVICE_ID_FIELD_NUMBER

public static final int ASSOCIATIONS_DEVICE_ID_FIELD_NUMBER
Field Value
Type Description
int

ASSOCIATIONS_GATEWAY_ID_FIELD_NUMBER

public static final int ASSOCIATIONS_GATEWAY_ID_FIELD_NUMBER
Field Value
Type Description
int

GATEWAY_TYPE_FIELD_NUMBER

public static final int GATEWAY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GatewayListOptions getDefaultInstance()
Returns
Type Description
GatewayListOptions

getDescriptor()

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

newBuilder()

public static GatewayListOptions.Builder newBuilder()
Returns
Type Description
GatewayListOptions.Builder

newBuilder(GatewayListOptions prototype)

public static GatewayListOptions.Builder newBuilder(GatewayListOptions prototype)
Parameter
Name Description
prototype GatewayListOptions
Returns
Type Description
GatewayListOptions.Builder

parseDelimitedFrom(InputStream input)

public static GatewayListOptions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GatewayListOptions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GatewayListOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GatewayListOptions
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GatewayListOptions parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GatewayListOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GatewayListOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GatewayListOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GatewayListOptions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GatewayListOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GatewayListOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GatewayListOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GatewayListOptions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GatewayListOptions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GatewayListOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GatewayListOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GatewayListOptions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GatewayListOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GatewayListOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GatewayListOptions
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GatewayListOptions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GatewayListOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GatewayListOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GatewayListOptions
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GatewayListOptions> parser()
Returns
Type Description
Parser<GatewayListOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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.

getParserForType()

public Parser<GatewayListOptions> getParserForType()
Returns
Type Description
Parser<GatewayListOptions>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GatewayListOptions.Builder newBuilderForType()
Returns
Type Description
GatewayListOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GatewayListOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GatewayListOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GatewayListOptions.Builder toBuilder()
Returns
Type Description
GatewayListOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException