Class ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.ListRequest

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

Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay between the time a message is created and when it can be found through a filter.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<ListMessagesResponse>
CloudHealthcareBaseServiceRequest<ListMessagesResponse>
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.ListRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.CloudHealthcare.v1
Assembly: Google.Apis.CloudHealthcare.v1.dll
Syntax
public class ListRequest : CloudHealthcareBaseServiceRequest<ListMessagesResponse>, IClientServiceRequest<ListMessagesResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, String)

Constructs a new List request.

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

Properties

Filter

Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
System.String

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudHealthcare.v1.Data.ListMessagesResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudHealthcare.v1.Data.ListMessagesResponse>.MethodName

OrderBy

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
Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type Description
System.String

PageSize

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

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

PageToken

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

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

Parent

Name of the HL7v2 store to retrieve messages from.

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

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudHealthcare.v1.Data.ListMessagesResponse>.RestPath

View

Specifies the parts of the Message to return in the response. When unspecified, equivalent to BASIC. Setting this to anything other than BASIC with a page_size larger than the default can generate a large response, which impacts the performance of this method.

Declaration
[RequestParameter("view", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.ListRequest.ViewEnum? View { get; set; }
Property Value
Type Description
System.Nullable<ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.ListRequest.ViewEnum>

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.CloudHealthcare.v1.CloudHealthcareBaseServiceRequest<Google.Apis.CloudHealthcare.v1.Data.ListMessagesResponse>.InitParameters()

Implements