HangoutsChat.Spaces.Messages.List (Google Chat API v1-rev20231102-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.chat.v1.HangoutsChatRequest<ListMessagesResponse>
        
        com.google.api.services.chat.v1.HangoutsChat.Spaces.Messages.List

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: HangoutsChat.Spaces.Messages

public class HangoutsChat.Spaces.Messages.List
extends HangoutsChatRequest<ListMessagesResponse>

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`List(String parent)` Lists messages in a space that the caller is a member of, including messages from blocked members and spaces.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`String`	`getFilter()` A query filter.
`String`	`getOrderBy()` Optional, if resuming from a previous query.
`Integer`	`getPageSize()` The maximum number of messages returned.
`String`	`getPageToken()` Optional, if resuming from a previous query.
`String`	`getParent()` Required.
`Boolean`	`getShowDeleted()` Whether to include deleted messages.
`HangoutsChat.Spaces.Messages.List`	`set(String parameterName, Object value)`
`HangoutsChat.Spaces.Messages.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`HangoutsChat.Spaces.Messages.List`	`setAccessToken(String accessToken)` OAuth access token.
`HangoutsChat.Spaces.Messages.List`	`setAlt(String alt)` Data format for response.
`HangoutsChat.Spaces.Messages.List`	`setCallback(String callback)` JSONP
`HangoutsChat.Spaces.Messages.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`HangoutsChat.Spaces.Messages.List`	`setFilter(String filter)` A query filter.
`HangoutsChat.Spaces.Messages.List`	`setKey(String key)` API key.
`HangoutsChat.Spaces.Messages.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`HangoutsChat.Spaces.Messages.List`	`setOrderBy(String orderBy)` Optional, if resuming from a previous query.
`HangoutsChat.Spaces.Messages.List`	`setPageSize(Integer pageSize)` The maximum number of messages returned.
`HangoutsChat.Spaces.Messages.List`	`setPageToken(String pageToken)` Optional, if resuming from a previous query.
`HangoutsChat.Spaces.Messages.List`	`setParent(String parent)` Required.
`HangoutsChat.Spaces.Messages.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`HangoutsChat.Spaces.Messages.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`HangoutsChat.Spaces.Messages.List`	`setShowDeleted(Boolean showDeleted)` Whether to include deleted messages.
`HangoutsChat.Spaces.Messages.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`HangoutsChat.Spaces.Messages.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.chat.v1.HangoutsChatRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - List
```
protected List(String parent)
```
    Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. For an example, see [List messages](/chat/api/guides/v1/messages/list). Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). Create a request for the method "messages.list". This request holds the parameters needed by the the chat server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    HangoutsChat.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    parent - Required. The resource name of the space to list messages from. Format: `spaces/{space}`
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListMessagesResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListMessagesResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public HangoutsChat.Spaces.Messages.List set$Xgafv(String $Xgafv)
```
    Description copied from class: HangoutsChatRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class HangoutsChatRequest<ListMessagesResponse>
  - setAccessToken
```
public HangoutsChat.Spaces.Messages.List setAccessToken(String accessToken)
```
    Description copied from class: HangoutsChatRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class HangoutsChatRequest<ListMessagesResponse>
  - setAlt
```
public HangoutsChat.Spaces.Messages.List setAlt(String alt)
```
    Description copied from class: HangoutsChatRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class HangoutsChatRequest<ListMessagesResponse>
  - setCallback
```
public HangoutsChat.Spaces.Messages.List setCallback(String callback)
```
    Description copied from class: HangoutsChatRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class HangoutsChatRequest<ListMessagesResponse>
  - setFields
```
public HangoutsChat.Spaces.Messages.List setFields(String fields)
```
    Description copied from class: HangoutsChatRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class HangoutsChatRequest<ListMessagesResponse>
  - setKey
```
public HangoutsChat.Spaces.Messages.List setKey(String key)
```
    Description copied from class: HangoutsChatRequest
    
    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.
    
    Overrides:
    
    setKey in class HangoutsChatRequest<ListMessagesResponse>
  - setOauthToken
```
public HangoutsChat.Spaces.Messages.List setOauthToken(String oauthToken)
```
    Description copied from class: HangoutsChatRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class HangoutsChatRequest<ListMessagesResponse>
  - setPrettyPrint
```
public HangoutsChat.Spaces.Messages.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: HangoutsChatRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class HangoutsChatRequest<ListMessagesResponse>
  - setQuotaUser
```
public HangoutsChat.Spaces.Messages.List setQuotaUser(String quotaUser)
```
    Description copied from class: HangoutsChatRequest
    
    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.
    
    Overrides:
    
    setQuotaUser in class HangoutsChatRequest<ListMessagesResponse>
  - setUploadType
```
public HangoutsChat.Spaces.Messages.List setUploadType(String uploadType)
```
    Description copied from class: HangoutsChatRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class HangoutsChatRequest<ListMessagesResponse>
  - setUploadProtocol
```
public HangoutsChat.Spaces.Messages.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: HangoutsChatRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class HangoutsChatRequest<ListMessagesResponse>
  - getParent
```
public String getParent()
```
    Required. The resource name of the space to list messages from. Format: `spaces/{space}`
  - setParent
```
public HangoutsChat.Spaces.Messages.List setParent(String parent)
```
    Required. The resource name of the space to list messages from. Format: `spaces/{space}`
  - getFilter
```
public String getFilter()
```
    A query filter. You can filter messages by date (`create_time`) and thread (`thread.name`). To filter messages by the date they were created, specify the `create_time` with a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and double quotation marks. For example, `"2023-04-21T11:30:00-04:00"`. You can use the greater than operator `>` to list messages that were created after a timestamp, or the less than operator `<` to list messages that were created before a timestamp. To filter messages within a time interval, use the `AND` operator between two timestamps. To filter by thread, specify the `thread.name`, formatted as `spaces/{space}/threads/{thread}`. You can only specify one `thread.name` per query. To filter by both thread and date, use the `AND` operator in your query. For example, the following queries are valid: ``` create_time > "2012-04-21T11:30:00-04:00" create_time > "2012-04-21T11:30:00-04:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > "2012-04-21T11:30:00+00:00" AND create_time < "2013-01-01T00:00:00+00:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123 ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.
  - setFilter
```
public HangoutsChat.Spaces.Messages.List setFilter(String filter)
```
    A query filter. You can filter messages by date (`create_time`) and thread (`thread.name`). To filter messages by the date they were created, specify the `create_time` with a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and double quotation marks. For example, `"2023-04-21T11:30:00-04:00"`. You can use the greater than operator `>` to list messages that were created after a timestamp, or the less than operator `<` to list messages that were created before a timestamp. To filter messages within a time interval, use the `AND` operator between two timestamps. To filter by thread, specify the `thread.name`, formatted as `spaces/{space}/threads/{thread}`. You can only specify one `thread.name` per query. To filter by both thread and date, use the `AND` operator in your query. For example, the following queries are valid: ``` create_time > "2012-04-21T11:30:00-04:00" create_time > "2012-04-21T11:30:00-04:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > "2012-04-21T11:30:00+00:00" AND create_time < "2013-01-01T00:00:00+00:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123 ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.
  - getOrderBy
```
public String getOrderBy()
```
    Optional, if resuming from a previous query. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows: - `ASC` for ascending. - `DESC` for descending. The default ordering is `create_time ASC`.
  - setOrderBy
```
public HangoutsChat.Spaces.Messages.List setOrderBy(String orderBy)
```
    Optional, if resuming from a previous query. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows: - `ASC` for ascending. - `DESC` for descending. The default ordering is `create_time ASC`.
  - getPageSize
```
public Integer getPageSize()
```
    The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.
  - setPageSize
```
public HangoutsChat.Spaces.Messages.List setPageSize(Integer pageSize)
```
    The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. Negative values return an `INVALID_ARGUMENT` error.
  - getPageToken
```
public String getPageToken()
```
    Optional, if resuming from a previous query. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
  - setPageToken
```
public HangoutsChat.Spaces.Messages.List setPageToken(String pageToken)
```
    Optional, if resuming from a previous query. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
  - getShowDeleted
```
public Boolean getShowDeleted()
```
    Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.
  - setShowDeleted
```
public HangoutsChat.Spaces.Messages.List setShowDeleted(Boolean showDeleted)
```
    Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.
  - set
```
public HangoutsChat.Spaces.Messages.List set(String parameterName,
                                             Object value)
```
    Overrides:
    
    set in class HangoutsChatRequest<ListMessagesResponse>

Class HangoutsChat.Spaces.Messages.List

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.chat.v1.HangoutsChatRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getParent

setParent

getFilter

setFilter

getOrderBy

setOrderBy

getPageSize

setPageSize

getPageToken

setPageToken

getShowDeleted

setShowDeleted

set