com.mulesoft.connectors.internal.operation

Class GmailusersmessagesgetOperation

java.lang.Object

com.mulesoft.connectivity.rest.commons.api.operation.BaseRestOperation

com.mulesoft.connectors.internal.operation.GmailusersmessagesgetOperation

public class GmailusersmessagesgetOperation
extends com.mulesoft.connectivity.rest.commons.api.operation.BaseRestOperation

Constructor Summary

Constructors

Constructor and Description
GmailusersmessagesgetOperation()

Method Summary

Modifier and Type

Method and Description

void

gmailusersmessagesget(com.mulesoft.connectivity.rest.commons.api.configuration.RestConfiguration config, com.mulesoft.connectivity.rest.commons.api.connection.RestConnection connection, String userIdUriParam, String idUriParam, FormatQueryParamEnum formatQueryParam, List<String> metadataHeadersQueryParams, 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) Gets the specified message.

Methods inherited from class com.mulesoft.connectivity.rest.commons.api.operation.BaseRestOperation

addParameterToBindingContext, doRequest, doVoidRequest, getDefaultResponseMediaType, getExpressionLanguage, getRequestBindings, getRequestBodyDataType, getRequestBuilderWithBindings, getResponseBindings, resolveDefaultResponseMediaType, withMultipart

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GmailusersmessagesgetOperation

public GmailusersmessagesgetOperation()

Method Detail

gmailusersmessagesget

@Throws(value=com.mulesoft.connectivity.rest.commons.api.error.RequestErrorTypeProvider.class)
 @DisplayName(value="Get Message")
 @Summary(value="Gets the specified message.")
 @MediaType(value="application/json")
 @OutputResolver(output=GmailusersmessagesgetOutputMetadataResolver.class)
public void gmailusersmessagesget(@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,
                                                                                                                                                                                                                                                                                                                                    @DisplayName(value="Message Id") @Summary(value="The ID of the message to retrieve. This ID is usually retrieved using `messages.list`. The ID is also contained in the result when a message is inserted (`messages.insert`) or imported (`messages.import`).")
                                                                                                                                                                                                                                                                                                                                    String idUriParam,
                                                                                                                                                                                                                                                                                                                                    @Optional @DisplayName(value="format") @Summary(value="The format to return the message in.")
                                                                                                                                                                                                                                                                                                                                    FormatQueryParamEnum formatQueryParam,
                                                                                                                                                                                                                                                                                                                                    @Optional @NullSafe @DisplayName(value="Metadata Headers") @Summary(value="When given and format is `METADATA`, only include headers specified.")
                                                                                                                                                                                                                                                                                                                                    List<String> metadataHeadersQueryParams,
                                                                                                                                                                                                                                                                                                                                    @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)

Gets the specified message.

This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/messages/{id} endpoint

Parameters:

config - the configuration to use

connection - the connection to use

userIdUriParam - The user's email address. The special value `me` can be used to indicate the authenticated user.

idUriParam - The ID of the message to retrieve. This ID is usually retrieved using `messages.list`. The ID is also contained in the result when a message is inserted (`messages.insert`) or imported (`messages.import`).

formatQueryParam - The format to return the message in.

metadataHeadersQueryParams - When given and format is `METADATA`, only include headers specified.

parameters - the NonEntityRequestParameters

overrides - the ConfigurationOverrides

streamingHelper - the StreamingHelper

callback - the operation's CompletionCallback