public class GmailusershistorylistOperation
extends com.mulesoft.connectivity.rest.commons.api.operation.BaseRestOperation
| Constructor and Description |
|---|
GmailusershistorylistOperation() |
| Modifier and Type | Method and Description |
|---|---|
void |
gmailusershistorylist(com.mulesoft.connectivity.rest.commons.api.configuration.RestConfiguration config,
com.mulesoft.connectivity.rest.commons.api.connection.RestConnection connection,
String userIdUriParam,
Integer maxResultsQueryParam,
String pageTokenQueryParam,
String startHistoryIdQueryParam,
String labelIdQueryParam,
List<HistoryTypesQueryParamsEnum> historyTypesQueryParams,
com.mulesoft.connectivity.rest.commons.api.operation.NonEntityRequestParameters parameters,
com.mulesoft.connectivity.rest.commons.api.operation.ConfigurationOverrides overrides,
org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper,
org.mule.runtime.extension.api.runtime.process.CompletionCallback<InputStream,com.mulesoft.connectivity.rest.commons.api.operation.HttpResponseAttributes> callback)
Lists the history of all changes to the given mailbox.
|
addParameterToBindingContext, doRequest, doVoidRequest, getDefaultResponseMediaType, getExpressionLanguage, getRequestBindings, getRequestBodyDataType, getRequestBuilderWithBindings, getResponseBindings, resolveDefaultResponseMediaType, withMultipart@Throws(value=com.mulesoft.connectivity.rest.commons.api.error.RequestErrorTypeProvider.class) @DisplayName(value="List History") @Summary(value="Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing `historyId`).") @MediaType(value="application/json") @OutputResolver(output=GmailusershistorylistOutputMetadataResolver.class) public void gmailusershistorylist(@Config com.mulesoft.connectivity.rest.commons.api.configuration.RestConfiguration config, @Connection com.mulesoft.connectivity.rest.commons.api.connection.RestConnection connection, @DisplayName(value="User Id") @Summary(value="The user\'s email address. The special value `me` can be used to indicate the authenticated user.") String userIdUriParam, @Optional @DisplayName(value="Max Results") @Summary(value="The maximum number of history records to return.") Integer maxResultsQueryParam, @Optional @DisplayName(value="Page Token") @Summary(value="Page token to retrieve a specific page of results in the list.") String pageTokenQueryParam, @Optional @DisplayName(value="Start History Id") @Summary(value="Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of a message, thread, or previous `list` response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs.") String startHistoryIdQueryParam, @Optional @DisplayName(value="Label Id") @Summary(value="Only return messages with a label matching the ID.") String labelIdQueryParam, @Optional @NullSafe @DisplayName(value="History Types") @Summary(value="History types to be returned by the function") List<HistoryTypesQueryParamsEnum> historyTypesQueryParams, @ParameterGroup(name="Request Parameters") com.mulesoft.connectivity.rest.commons.api.operation.NonEntityRequestParameters parameters, @ParameterGroup(name="Connector Overrides") com.mulesoft.connectivity.rest.commons.api.operation.ConfigurationOverrides overrides, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper, org.mule.runtime.extension.api.runtime.process.CompletionCallback<InputStream,com.mulesoft.connectivity.rest.commons.api.operation.HttpResponseAttributes> callback)
This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/history endpoint
config - the configuration to useconnection - the connection to useuserIdUriParam - The user's email address. The special value `me` can be used to indicate
the authenticated user.maxResultsQueryParam - The maximum number of history records to return.pageTokenQueryParam - Page token to retrieve a specific page of results in the list.startHistoryIdQueryParam - Required. Returns history records after the specified
`startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of
a message, thread, or previous `list` response. History IDs increase chronologically but
are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of
date `startHistoryId` typically returns an `HTTP 404` error code. A `historyId` is
typically valid for at least a week, but in some rare circumstances may be valid for only a
few hours. If you receive an `HTTP 404` error response, your application should perform a
full sync. If you receive no `nextPageToken` in the response, there are no updates to
retrieve and you can store the returned `historyId` for a future request.labelIdQueryParam - Only return messages with a label matching the ID.historyTypesQueryParams - History types to be returned by the functionparameters - the NonEntityRequestParametersoverrides - the ConfigurationOverridesstreamingHelper - the StreamingHelpercallback - the operation's CompletionCallbackCopyright © 2023 MuleSoft, Inc.. All rights reserved.