Struct google_cloudiot1::ProjectLocationRegistryGroupDeviceListCall

pub struct ProjectLocationRegistryGroupDeviceListCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

List devices in a device registry.

A builder for the locations.registries.groups.devices.list method supported by a project resource. It is not used directly, but through a ProjectMethods instance.

Example

Instantiate a resource method builder

 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().locations_registries_groups_devices_list("parent")
             .page_token("Lorem")
             .page_size(-21)
             .gateway_list_options_gateway_type("duo")
             .gateway_list_options_associations_gateway_id("aliquyam")
             .gateway_list_options_associations_device_id("sea")
             .field_mask("Lorem")
             .add_device_num_ids("eos")
             .add_device_ids("erat")
             .doit();

Methods

impl<'a, C, A> ProjectLocationRegistryGroupDeviceListCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken, 

pub fn doit(self) -> Result<(Response, ListDevicesResponse)>

Perform the operation you have build so far.

pub fn parent(
    self,
    new_value: &str
) -> ProjectLocationRegistryGroupDeviceListCall<'a, C, A>

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

Sets the parent path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn page_token(
    self,
    new_value: &str
) -> ProjectLocationRegistryGroupDeviceListCall<'a, C, A>

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.

Sets the page token query property to the given value.

pub fn page_size(
    self,
    new_value: i32
) -> ProjectLocationRegistryGroupDeviceListCall<'a, C, A>

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.

Sets the page size query property to the given value.

pub fn gateway_list_options_gateway_type(
    self,
    new_value: &str
) -> ProjectLocationRegistryGroupDeviceListCall<'a, C, A>

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.

Sets the gateway list options.gateway type query property to the given value.

pub fn gateway_list_options_associations_gateway_id(
    self,
    new_value: &str
) -> ProjectLocationRegistryGroupDeviceListCall<'a, C, A>

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.

Sets the gateway list options.associations gateway id query property to the given value.

pub fn gateway_list_options_associations_device_id(
    self,
    new_value: &str
) -> ProjectLocationRegistryGroupDeviceListCall<'a, C, A>

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.

Sets the gateway list options.associations device id query property to the given value.

pub fn field_mask(
    self,
    new_value: &str
) -> ProjectLocationRegistryGroupDeviceListCall<'a, C, A>

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.

Sets the field mask query property to the given value.

pub fn add_device_num_ids(
    self,
    new_value: &str
) -> ProjectLocationRegistryGroupDeviceListCall<'a, C, A>

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

Append the given value to the device num ids query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

pub fn add_device_ids(
    self,
    new_value: &str
) -> ProjectLocationRegistryGroupDeviceListCall<'a, C, A>

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

Append the given value to the device ids query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> ProjectLocationRegistryGroupDeviceListCall<'a, C, A>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

pub fn param<T>(
    self,
    name: T,
    value: T
) -> ProjectLocationRegistryGroupDeviceListCall<'a, C, A> where
    T: AsRef<str>, 

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• access_token (query-string) - OAuth access token.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
• callback (query-string) - JSONP
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
• alt (query-string) - Data format for response.
• $.xgafv (query-string) - V1 error format.

pub fn add_scope<T, S>(
    self,
    scope: T
) -> ProjectLocationRegistryGroupDeviceListCall<'a, C, A> where
    T: Into<Option<S>>,
    S: AsRef<str>, 

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::CloudPlatform.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

Trait Implementations

impl<'a, C, A> CallBuilder for ProjectLocationRegistryGroupDeviceListCall<'a, C, A>