Class GatewayListOptions

  • All Implemented Interfaces:
    GatewayListOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class GatewayListOptions
    extends com.google.protobuf.GeneratedMessageV3
    implements GatewayListOptionsOrBuilder
     Options for limiting the list based on gateway type and associations.
     
    Protobuf type google.cloud.iot.v1.GatewayListOptions
    See Also:
    Serialized Form
    • Field Detail

      • GATEWAY_TYPE_FIELD_NUMBER

        public static final int GATEWAY_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ASSOCIATIONS_GATEWAY_ID_FIELD_NUMBER

        public static final int ASSOCIATIONS_GATEWAY_ID_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ASSOCIATIONS_DEVICE_ID_FIELD_NUMBER

        public static final int ASSOCIATIONS_DEVICE_ID_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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;
        Specified by:
        hasGatewayType in interface GatewayListOptionsOrBuilder
        Returns:
        Whether the gatewayType field is set.
      • 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;
        Specified by:
        getGatewayTypeValue in interface GatewayListOptionsOrBuilder
        Returns:
        The enum numeric value on the wire for gatewayType.
      • 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;
        Specified by:
        getGatewayType in interface GatewayListOptionsOrBuilder
        Returns:
        The gatewayType.
      • 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;
        Specified by:
        hasAssociationsGatewayId in interface GatewayListOptionsOrBuilder
        Returns:
        Whether the associationsGatewayId field is set.
      • 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;
        Specified by:
        getAssociationsGatewayId in interface GatewayListOptionsOrBuilder
        Returns:
        The associationsGatewayId.
      • getAssociationsGatewayIdBytes

        public com.google.protobuf.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;
        Specified by:
        getAssociationsGatewayIdBytes in interface GatewayListOptionsOrBuilder
        Returns:
        The bytes for associationsGatewayId.
      • 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;
        Specified by:
        hasAssociationsDeviceId in interface GatewayListOptionsOrBuilder
        Returns:
        Whether the associationsDeviceId field is set.
      • 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;
        Specified by:
        getAssociationsDeviceId in interface GatewayListOptionsOrBuilder
        Returns:
        The associationsDeviceId.
      • getAssociationsDeviceIdBytes

        public com.google.protobuf.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;
        Specified by:
        getAssociationsDeviceIdBytes in interface GatewayListOptionsOrBuilder
        Returns:
        The bytes for associationsDeviceId.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static GatewayListOptions parseFrom​(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static GatewayListOptions parseFrom​(ByteBuffer data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static GatewayListOptions parseFrom​(com.google.protobuf.ByteString data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static GatewayListOptions parseFrom​(com.google.protobuf.ByteString data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static GatewayListOptions parseFrom​(byte[] data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static GatewayListOptions parseFrom​(byte[] data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static GatewayListOptions parseFrom​(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException
        Throws:
        IOException
      • newBuilderForType

        public GatewayListOptions.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public GatewayListOptions.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected GatewayListOptions.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<GatewayListOptions> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public GatewayListOptions getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder