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
Static Fields
ASSOCIATIONS_DEVICE_ID_FIELD_NUMBER
public static final int ASSOCIATIONS_DEVICE_ID_FIELD_NUMBER
Field Value
ASSOCIATIONS_GATEWAY_ID_FIELD_NUMBER
public static final int ASSOCIATIONS_GATEWAY_ID_FIELD_NUMBER
Field Value
GATEWAY_TYPE_FIELD_NUMBER
public static final int GATEWAY_TYPE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static GatewayListOptions getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static GatewayListOptions.Builder newBuilder()
Returns
newBuilder(GatewayListOptions prototype)
public static GatewayListOptions.Builder newBuilder(GatewayListOptions prototype)
Parameter
Returns
public static GatewayListOptions parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static GatewayListOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static GatewayListOptions parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GatewayListOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static GatewayListOptions parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GatewayListOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static GatewayListOptions parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static GatewayListOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static GatewayListOptions parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static GatewayListOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static GatewayListOptions parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GatewayListOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<GatewayListOptions> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
getFilterCase()
public GatewayListOptions.FilterCase getFilterCase()
Returns
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
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
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public GatewayListOptions.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GatewayListOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public GatewayListOptions.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions