Package com.google.cloud.iot.v1

Class ListDevicesRequest.Builder

    • Method Detail

      • 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.Builder<ListDevicesRequest.Builder>

      • clear

        public ListDevicesRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListDevicesRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListDevicesRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public ListDevicesRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListDevicesRequest.Builder>

      • setField

        public ListDevicesRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListDevicesRequest.Builder>

      • clearField

        public ListDevicesRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListDevicesRequest.Builder>

      • clearOneof

        public ListDevicesRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListDevicesRequest.Builder>

      • setRepeatedField

        public ListDevicesRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   int index,
                                                   Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListDevicesRequest.Builder>

      • addRepeatedField

        public ListDevicesRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListDevicesRequest.Builder>

      • mergeFrom

        public ListDevicesRequest.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListDevicesRequest.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListDevicesRequest.Builder>

      • mergeFrom

        public ListDevicesRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListDevicesRequest.Builder>
        Throws:
        IOException

      • 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.

      • setParent

        public ListDevicesRequest.Builder setParent​(String value)
         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) = { ... }
        Parameters:
        value - The parent to set.
        Returns:
        This builder for chaining.

      • clearParent

        public ListDevicesRequest.Builder clearParent()
         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) = { ... }
        Returns:
        This builder for chaining.

      • setParentBytes

        public ListDevicesRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for parent to set.
        Returns:
        This builder for chaining.

      • 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.

      • setDeviceNumIds

        public ListDevicesRequest.Builder setDeviceNumIds​(int index,
                                                  long value)
         A list of device numeric IDs. If empty, this field is ignored. Maximum
 IDs: 10,000.
        repeated uint64 device_num_ids = 2;
        Parameters:
        index - The index to set the value at.
        value - The deviceNumIds to set.
        Returns:
        This builder for chaining.

      • addDeviceNumIds

        public ListDevicesRequest.Builder addDeviceNumIds​(long value)
         A list of device numeric IDs. If empty, this field is ignored. Maximum
 IDs: 10,000.
        repeated uint64 device_num_ids = 2;
        Parameters:
        value - The deviceNumIds to add.
        Returns:
        This builder for chaining.

      • addAllDeviceNumIds

        public ListDevicesRequest.Builder addAllDeviceNumIds​(Iterable<? extends Long> values)
         A list of device numeric IDs. If empty, this field is ignored. Maximum
 IDs: 10,000.
        repeated uint64 device_num_ids = 2;
        Parameters:
        values - The deviceNumIds to add.
        Returns:
        This builder for chaining.

      • clearDeviceNumIds

        public ListDevicesRequest.Builder clearDeviceNumIds()
         A list of device numeric IDs. If empty, this field is ignored. Maximum
 IDs: 10,000.
        repeated uint64 device_num_ids = 2;
        Returns:
        This builder for chaining.

      • 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.

      • setDeviceIds

        public ListDevicesRequest.Builder setDeviceIds​(int index,
                                               String value)
         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;
        Parameters:
        index - The index to set the value at.
        value - The deviceIds to set.
        Returns:
        This builder for chaining.

      • addDeviceIds

        public ListDevicesRequest.Builder addDeviceIds​(String value)
         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;
        Parameters:
        value - The deviceIds to add.
        Returns:
        This builder for chaining.

      • addAllDeviceIds

        public ListDevicesRequest.Builder addAllDeviceIds​(Iterable<String> values)
         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;
        Parameters:
        values - The deviceIds to add.
        Returns:
        This builder for chaining.

      • clearDeviceIds

        public ListDevicesRequest.Builder clearDeviceIds()
         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;
        Returns:
        This builder for chaining.

      • addDeviceIdsBytes

        public ListDevicesRequest.Builder addDeviceIdsBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes of the deviceIds to add.
        Returns:
        This builder for chaining.

      • 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.

      • setFieldMask

        public ListDevicesRequest.Builder setFieldMask​(com.google.protobuf.FieldMask value)
         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;

      • setFieldMask

        public ListDevicesRequest.Builder setFieldMask​(com.google.protobuf.FieldMask.Builder builderForValue)
         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;

      • mergeFieldMask

        public ListDevicesRequest.Builder mergeFieldMask​(com.google.protobuf.FieldMask value)
         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;

      • clearFieldMask

        public ListDevicesRequest.Builder clearFieldMask()
         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;

      • getFieldMaskBuilder

        public com.google.protobuf.FieldMask.Builder getFieldMaskBuilder()
         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;

      • 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.

      • clearGatewayListOptions

        public ListDevicesRequest.Builder clearGatewayListOptions()
         Options related to gateways.
        .google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;

      • getGatewayListOptionsBuilder

        public GatewayListOptions.Builder getGatewayListOptionsBuilder()
         Options related to gateways.
        .google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;

      • 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.

      • setPageSize

        public ListDevicesRequest.Builder setPageSize​(int value)
         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;
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.

      • clearPageSize

        public ListDevicesRequest.Builder clearPageSize()
         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;
        Returns:
        This builder for chaining.

      • 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.

      • setPageToken

        public ListDevicesRequest.Builder setPageToken​(String value)
         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;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public ListDevicesRequest.Builder clearPageToken()
         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;
        Returns:
        This builder for chaining.

      • setPageTokenBytes

        public ListDevicesRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final ListDevicesRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListDevicesRequest.Builder>

      • mergeUnknownFields

        public final ListDevicesRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListDevicesRequest.Builder>