Space (Google Chat API v1-rev20240220-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.chat.v1.model.Space

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Space
extends com.google.api.client.json.GenericJson
```
A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Chat API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors
Constructor and Description

Space()

Constructors
Constructor and Description
`Space()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Space`	`clone()`
`Boolean`	`getAdminInstalled()` Output only.
`String`	`getCreateTime()` Optional.
`String`	`getDisplayName()` The space's display name.
`Boolean`	`getExternalUserAllowed()` Immutable.
`Boolean`	`getImportMode()` Optional.
`String`	`getName()` Resource name of the space.
`Boolean`	`getSingleUserBotDm()` Optional.
`SpaceDetails`	`getSpaceDetails()` Details about the space including description and rules.
`String`	`getSpaceHistoryState()` The message history state for messages and threads in this space.
`String`	`getSpaceThreadingState()` Output only.
`String`	`getSpaceType()` The type of space.
`Boolean`	`getThreaded()` Output only.
`String`	`getType()` Output only.
`Space`	`set(String fieldName, Object value)`
`Space`	`setAdminInstalled(Boolean adminInstalled)` Output only.
`Space`	`setCreateTime(String createTime)` Optional.
`Space`	`setDisplayName(String displayName)` The space's display name.
`Space`	`setExternalUserAllowed(Boolean externalUserAllowed)` Immutable.
`Space`	`setImportMode(Boolean importMode)` Optional.
`Space`	`setName(String name)` Resource name of the space.
`Space`	`setSingleUserBotDm(Boolean singleUserBotDm)` Optional.
`Space`	`setSpaceDetails(SpaceDetails spaceDetails)` Details about the space including description and rules.
`Space`	`setSpaceHistoryState(String spaceHistoryState)` The message history state for messages and threads in this space.
`Space`	`setSpaceThreadingState(String spaceThreadingState)` Output only.
`Space`	`setSpaceType(String spaceType)` The type of space.
`Space`	`setThreaded(Boolean threaded)` Output only.
`Space`	`setType(String type)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

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

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
  - Space
```
public Space()
```
- Method Detail
  - getAdminInstalled
```
public Boolean getAdminInstalled()
```
    Output only. Whether the Chat app was installed by a Google Workspace administrator. Administrators can install a Chat app for their domain, organizational unit, or a group of users. Administrators can only install Chat apps for direct messaging between users and the app. To support admin install, your app must feature direct messaging.
    
    Returns:
    
    value or null for none
  - setAdminInstalled
```
public Space setAdminInstalled(Boolean adminInstalled)
```
    Output only. Whether the Chat app was installed by a Google Workspace administrator. Administrators can install a Chat app for their domain, organizational unit, or a group of users. Administrators can only install Chat apps for direct messaging between users and the app. To support admin install, your app must feature direct messaging.
    
    Parameters:
    
    adminInstalled - adminInstalled or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Space setCreateTime(String createTime)
```
    Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDisplayName
```
public String getDisplayName()
```
    The space's display name. Required when [creating a space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public Space setDisplayName(String displayName)
```
    The space's display name. Required when [creating a space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
    
    Parameters:
    
    displayName - displayName or null for none
  - getExternalUserAllowed
```
public Boolean getExternalUserAllowed()
```
    Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a Google Account. By default, the space permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview). Import mode spaces must only permit members from the same Google Workspace organization. For existing spaces, this field is output only.
    
    Returns:
    
    value or null for none
  - setExternalUserAllowed
```
public Space setExternalUserAllowed(Boolean externalUserAllowed)
```
    Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a Google Account. By default, the space permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview). Import mode spaces must only permit members from the same Google Workspace organization. For existing spaces, this field is output only.
    
    Parameters:
    
    externalUserAllowed - externalUserAllowed or null for none
  - getImportMode
```
public Boolean getImportMode()
```
    Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete.
    
    Returns:
    
    value or null for none
  - setImportMode
```
public Space setImportMode(Boolean importMode)
```
    Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete.
    
    Parameters:
    
    importMode - importMode or null for none
  - getName
```
public String getName()
```
    Resource name of the space. Format: `spaces/{space}`
    
    Returns:
    
    value or null for none
  - setName
```
public Space setName(String name)
```
    Resource name of the space. Format: `spaces/{space}`
    
    Parameters:
    
    name - name or null for none
  - getSingleUserBotDm
```
public Boolean getSingleUserBotDm()
```
    Optional. Whether the space is a DM between a Chat app and a single human.
    
    Returns:
    
    value or null for none
  - setSingleUserBotDm
```
public Space setSingleUserBotDm(Boolean singleUserBotDm)
```
    Optional. Whether the space is a DM between a Chat app and a single human.
    
    Parameters:
    
    singleUserBotDm - singleUserBotDm or null for none
  - getSpaceDetails
```
public SpaceDetails getSpaceDetails()
```
    Details about the space including description and rules.
    
    Returns:
    
    value or null for none
  - setSpaceDetails
```
public Space setSpaceDetails(SpaceDetails spaceDetails)
```
    Details about the space including description and rules.
    
    Parameters:
    
    spaceDetails - spaceDetails or null for none
  - getSpaceHistoryState
```
public String getSpaceHistoryState()
```
    The message history state for messages and threads in this space.
    
    Returns:
    
    value or null for none
  - setSpaceHistoryState
```
public Space setSpaceHistoryState(String spaceHistoryState)
```
    The message history state for messages and threads in this space.
    
    Parameters:
    
    spaceHistoryState - spaceHistoryState or null for none
  - getSpaceThreadingState
```
public String getSpaceThreadingState()
```
    Output only. The threading state in the Chat space.
    
    Returns:
    
    value or null for none
  - setSpaceThreadingState
```
public Space setSpaceThreadingState(String spaceThreadingState)
```
    Output only. The threading state in the Chat space.
    
    Parameters:
    
    spaceThreadingState - spaceThreadingState or null for none
  - getSpaceType
```
public String getSpaceType()
```
    The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.
    
    Returns:
    
    value or null for none
  - setSpaceType
```
public Space setSpaceType(String spaceType)
```
    The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.
    
    Parameters:
    
    spaceType - spaceType or null for none
  - getThreaded
```
public Boolean getThreaded()
```
    Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space.
    
    Returns:
    
    value or null for none
  - setThreaded
```
public Space setThreaded(Boolean threaded)
```
    Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space.
    
    Parameters:
    
    threaded - threaded or null for none
  - getType
```
public String getType()
```
    Output only. Deprecated: Use `space_type` instead. The type of a space.
    
    Returns:
    
    value or null for none
  - setType
```
public Space setType(String type)
```
    Output only. Deprecated: Use `space_type` instead. The type of a space.
    
    Parameters:
    
    type - type or null for none
  - set
```
public Space set(String fieldName,
                 Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Space clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Space

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

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

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

Space

Method Detail

getAdminInstalled

setAdminInstalled

getCreateTime

setCreateTime

getDisplayName

setDisplayName

getExternalUserAllowed

setExternalUserAllowed

getImportMode

setImportMode

getName

setName

getSingleUserBotDm

setSingleUserBotDm

getSpaceDetails

setSpaceDetails

getSpaceHistoryState

setSpaceHistoryState

getSpaceThreadingState

setSpaceThreadingState

getSpaceType

setSpaceType

getThreaded

setThreaded

getType

setType

set

clone