Package com.google.cloud.iot.v1

Class ListDevicesRequest

  • All Implemented Interfaces:
    ListDevicesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListDevicesRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListDevicesRequestOrBuilder
     Request for `ListDevices`.
    Protobuf type google.cloud.iot.v1.ListDevicesRequest
    See Also:
    Serialized Form

    • 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

      • getParent

        public String getParent()
         Required. The device registry path. Required. For example,
 `projects/my-project/locations/us-central1/registries/my-registry`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListDevicesRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The device registry path. Required. For example,
 `projects/my-project/locations/us-central1/registries/my-registry`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListDevicesRequestOrBuilder
        Returns:
        The bytes for parent.

      • getDeviceNumIdsList

        public List<Long> getDeviceNumIdsList()
         A list of device numeric IDs. If empty, this field is ignored. Maximum
 IDs: 10,000.
        repeated uint64 device_num_ids = 2;
        Specified by:
        getDeviceNumIdsList in interface ListDevicesRequestOrBuilder
        Returns:
        A list containing the deviceNumIds.

      • getDeviceNumIdsCount

        public int getDeviceNumIdsCount()
         A list of device numeric IDs. If empty, this field is ignored. Maximum
 IDs: 10,000.
        repeated uint64 device_num_ids = 2;
        Specified by:
        getDeviceNumIdsCount in interface ListDevicesRequestOrBuilder
        Returns:
        The count of deviceNumIds.

      • getDeviceNumIds

        public long getDeviceNumIds​(int index)
         A list of device numeric IDs. If empty, this field is ignored. Maximum
 IDs: 10,000.
        repeated uint64 device_num_ids = 2;
        Specified by:
        getDeviceNumIds in interface ListDevicesRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The deviceNumIds at the given index.

      • getDeviceIdsList

        public com.google.protobuf.ProtocolStringList getDeviceIdsList()
         A list of device string IDs. For example, `['device0', 'device12']`.
 If empty, this field is ignored. Maximum IDs: 10,000
        repeated string device_ids = 3;
        Specified by:
        getDeviceIdsList in interface ListDevicesRequestOrBuilder
        Returns:
        A list containing the deviceIds.

      • getDeviceIdsCount

        public int getDeviceIdsCount()
         A list of device string IDs. For example, `['device0', 'device12']`.
 If empty, this field is ignored. Maximum IDs: 10,000
        repeated string device_ids = 3;
        Specified by:
        getDeviceIdsCount in interface ListDevicesRequestOrBuilder
        Returns:
        The count of deviceIds.

      • getDeviceIds

        public String getDeviceIds​(int index)
         A list of device string IDs. For example, `['device0', 'device12']`.
 If empty, this field is ignored. Maximum IDs: 10,000
        repeated string device_ids = 3;
        Specified by:
        getDeviceIds in interface ListDevicesRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The deviceIds at the given index.

      • getDeviceIdsBytes

        public com.google.protobuf.ByteString getDeviceIdsBytes​(int index)
         A list of device string IDs. For example, `['device0', 'device12']`.
 If empty, this field is ignored. Maximum IDs: 10,000
        repeated string device_ids = 3;
        Specified by:
        getDeviceIdsBytes in interface ListDevicesRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the deviceIds at the given index.

      • hasFieldMask

        public boolean hasFieldMask()
         The fields of the `Device` resource to be returned in the response. The
 fields `id` and `num_id` are always returned, along with any
 other fields specified in snake_case format, for example:
 `last_heartbeat_time`.
        .google.protobuf.FieldMask field_mask = 4;
        Specified by:
        hasFieldMask in interface ListDevicesRequestOrBuilder
        Returns:
        Whether the fieldMask field is set.

      • getFieldMask

        public com.google.protobuf.FieldMask getFieldMask()
         The fields of the `Device` resource to be returned in the response. The
 fields `id` and `num_id` are always returned, along with any
 other fields specified in snake_case format, for example:
 `last_heartbeat_time`.
        .google.protobuf.FieldMask field_mask = 4;
        Specified by:
        getFieldMask in interface ListDevicesRequestOrBuilder
        Returns:
        The fieldMask.

      • getFieldMaskOrBuilder

        public com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()
         The fields of the `Device` resource to be returned in the response. The
 fields `id` and `num_id` are always returned, along with any
 other fields specified in snake_case format, for example:
 `last_heartbeat_time`.
        .google.protobuf.FieldMask field_mask = 4;
        Specified by:
        getFieldMaskOrBuilder in interface ListDevicesRequestOrBuilder

      • hasGatewayListOptions

        public boolean hasGatewayListOptions()
         Options related to gateways.
        .google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;
        Specified by:
        hasGatewayListOptions in interface ListDevicesRequestOrBuilder
        Returns:
        Whether the gatewayListOptions field is set.

      • getPageSize

        public int getPageSize()
         The maximum number of devices to return in the response. If this value
 is zero, the service will select a default size. A call may return fewer
 objects than requested. A non-empty `next_page_token` in the response
 indicates that more data is available.
        int32 page_size = 100;
        Specified by:
        getPageSize in interface ListDevicesRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public String getPageToken()
         The value returned by the last `ListDevicesResponse`; indicates
 that this is a continuation of a prior `ListDevices` call and
 the system should return the next page of data.
        string page_token = 101;
        Specified by:
        getPageToken in interface ListDevicesRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         The value returned by the last `ListDevicesResponse`; indicates
 that this is a continuation of a prior `ListDevices` call and
 the system should return the next page of data.
        string page_token = 101;
        Specified by:
        getPageTokenBytes in interface ListDevicesRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • 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 ListDevicesRequest parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<ListDevicesRequest> 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 ListDevicesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder