Class ProjectsResource.LocationsResource.RegistriesResource.DevicesResource.ListRequest

List devices in a device registry.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListDevicesResponse>
CloudIotBaseServiceRequest<ListDevicesResponse>
ProjectsResource.LocationsResource.RegistriesResource.DevicesResource.ListRequest
Implements
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudIot.v1
Assembly: Google.Apis.CloudIot.v1.dll
Syntax
public class ProjectsResource.LocationsResource.RegistriesResource.DevicesResource.ListRequest : CloudIotBaseServiceRequest<ListDevicesResponse>, IClientServiceRequest<ListDevicesResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

DeviceIds

A list of device string IDs. For example, [&apos;device0&apos;, &apos;device12&apos;]. If empty, this field is ignored. Maximum IDs: 10,000

Declaration
[RequestParameter("deviceIds", RequestParameterType.Query)]
public virtual Repeatable<string> DeviceIds { get; set; }
Property Value
Type Description
Repeatable<string>

DeviceNumIds

A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.

Declaration
[RequestParameter("deviceNumIds", RequestParameterType.Query)]
public virtual Repeatable<string> DeviceNumIds { get; set; }
Property Value
Type Description
Repeatable<string>

FieldMask

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.

Declaration
[RequestParameter("fieldMask", RequestParameterType.Query)]
public virtual object FieldMask { get; set; }
Property Value
Type Description
object

GatewayListOptionsAssociationsDeviceId

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.

Declaration
[RequestParameter("gatewayListOptions.associationsDeviceId", RequestParameterType.Query)]
public virtual string GatewayListOptionsAssociationsDeviceId { get; set; }
Property Value
Type Description
string

GatewayListOptionsAssociationsGatewayId

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.

Declaration
[RequestParameter("gatewayListOptions.associationsGatewayId", RequestParameterType.Query)]
public virtual string GatewayListOptionsAssociationsGatewayId { get; set; }
Property Value
Type Description
string

GatewayListOptionsGatewayType

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.

Declaration
[RequestParameter("gatewayListOptions.gatewayType", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.RegistriesResource.DevicesResource.ListRequest.GatewayListOptionsGatewayTypeEnum? GatewayListOptionsGatewayType { get; set; }
Property Value
Type Description
ProjectsResource.LocationsResource.RegistriesResource.DevicesResource.ListRequest.GatewayListOptionsGatewayTypeEnum?

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudIot.v1.Data.ListDevicesResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudIot.v1.Data.ListDevicesResponse>.MethodName

PageSize

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.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

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.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

Required. The device registry path. Required. For example, projects/my-project/locations/us-central1/registries/my-registry.

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudIot.v1.Data.ListDevicesResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.CloudIot.v1.CloudIotBaseServiceRequest<Google.Apis.CloudIot.v1.Data.ListDevicesResponse>.InitParameters()

Implements