Struct google_healthcare1_beta1::ProjectLocationDatasetHl7V2StoreMessageListCall

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

Lists all the messages in the given HL7v2 store with support for filtering.

A builder for the locations.datasets.hl7V2Stores.messages.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_datasets_hl7_v2_stores_messages_list("parent")
             .page_token("sit")
             .page_size(-26)
             .order_by("diam")
             .filter("rebum.")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

Name of the HL7v2 store to retrieve messages from.

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
) -> ProjectLocationDatasetHl7V2StoreMessageListCall<'a, C, A>

The next_page_token value returned from the previous List request, if any.

Sets the page token query property to the given value.

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

Limit on the number of messages to return in a single response. If zero the default page size of 100 is used.

Sets the page size query property to the given value.

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

Orders messages returned by the specified order_by clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order

Fields available for ordering are:

• send_time

Sets the order by query property to the given value.

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

Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings

Fields/functions available for filtering are:

• message_type, from the MSH-9 segment; for example NOT message_type = "ADT"
• send_date or sendDate, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment; for example send_date < "2017-01-02"
• send_time, the timestamp of when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment; for example send_time < "2017-01-02T00:00:00-05:00"
• send_facility, the care center that the message came from, from the MSH-4 segment; for example send_facility = "ABC"
• HL7RegExp(expr), which does regular expression matching of expr against the message payload using re2 (http://code.google.com/p/re2/) syntax; for example HL7RegExp("^.*\|.*\|EMERG")
• PatientId(value, type), which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments; for example PatientId("123456", "MRN")
• labels.x, a string value of the label with key x as set using the Message.labels map, for example labels."priority"="high". The operator :* can be used to assert the existence of a label, for example labels."priority":*.

Limitations on conjunctions:

• Negation on the patient ID function or the labels field is not supported, for example these queries are invalid: NOT PatientId("123456", "MRN"), NOT labels."tag1":*, NOT labels."tag2"="val2".
• Conjunction of multiple patient ID functions is not supported, for example this query is invalid: PatientId("123456", "MRN") AND PatientId("456789", "MRN").
• Conjunction of multiple labels fields is also not supported, for example this query is invalid: labels."tag1":* AND labels."tag2"="val2".
• Conjunction of one patient ID function, one labels field and conditions on other fields is supported, for example this query is valid: PatientId("123456", "MRN") AND labels."tag1":* AND message_type = "ADT".

Sets the filter query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> ProjectLocationDatasetHl7V2StoreMessageListCall<'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
) -> ProjectLocationDatasetHl7V2StoreMessageListCall<'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
) -> ProjectLocationDatasetHl7V2StoreMessageListCall<'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 ProjectLocationDatasetHl7V2StoreMessageListCall<'a, C, A>