Space (Google Chat API v1-rev20251118-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()`
`AccessSettings`	`getAccessSettings()` Optional.
`Boolean`	`getAdminInstalled()` Output only.
`String`	`getCreateTime()` Optional.
`String`	`getCustomer()` Optional.
`String`	`getDisplayName()` Optional.
`Boolean`	`getExternalUserAllowed()` Optional.
`Boolean`	`getImportMode()` Optional.
`String`	`getImportModeExpireTime()` Output only.
`String`	`getLastActiveTime()` Output only.
`MembershipCount`	`getMembershipCount()` Output only.
`String`	`getName()` Identifier.
`PermissionSettings`	`getPermissionSettings()` Optional.
`String`	`getPredefinedPermissionSettings()` Optional.
`Boolean`	`getSingleUserBotDm()` Optional.
`SpaceDetails`	`getSpaceDetails()` Optional.
`String`	`getSpaceHistoryState()` Optional.
`String`	`getSpaceThreadingState()` Output only.
`String`	`getSpaceType()` Optional.
`String`	`getSpaceUri()` Output only.
`Boolean`	`getThreaded()` Output only.
`String`	`getType()` Output only.
`Space`	`set(String fieldName, Object value)`
`Space`	`setAccessSettings(AccessSettings accessSettings)` Optional.
`Space`	`setAdminInstalled(Boolean adminInstalled)` Output only.
`Space`	`setCreateTime(String createTime)` Optional.
`Space`	`setCustomer(String customer)` Optional.
`Space`	`setDisplayName(String displayName)` Optional.
`Space`	`setExternalUserAllowed(Boolean externalUserAllowed)` Optional.
`Space`	`setImportMode(Boolean importMode)` Optional.
`Space`	`setImportModeExpireTime(String importModeExpireTime)` Output only.
`Space`	`setLastActiveTime(String lastActiveTime)` Output only.
`Space`	`setMembershipCount(MembershipCount membershipCount)` Output only.
`Space`	`setName(String name)` Identifier.
`Space`	`setPermissionSettings(PermissionSettings permissionSettings)` Optional.
`Space`	`setPredefinedPermissionSettings(String predefinedPermissionSettings)` Optional.
`Space`	`setSingleUserBotDm(Boolean singleUserBotDm)` Optional.
`Space`	`setSpaceDetails(SpaceDetails spaceDetails)` Optional.
`Space`	`setSpaceHistoryState(String spaceHistoryState)` Optional.
`Space`	`setSpaceThreadingState(String spaceThreadingState)` Output only.
`Space`	`setSpaceType(String spaceType)` Optional.
`Space`	`setSpaceUri(String spaceUri)` Output only.
`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
  - getAccessSettings
```
public AccessSettings getAccessSettings()
```
    Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`.
    
    Returns:
    
    value or null for none
  - setAccessSettings
```
public Space setAccessSettings(AccessSettings accessSettings)
```
    Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`.
    
    Parameters:
    
    accessSettings - accessSettings or null for none
  - getAdminInstalled
```
public Boolean getAdminInstalled()
```
    Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
    
    Returns:
    
    value or null for none
  - setAdminInstalled
```
public Space setAdminInstalled(Boolean adminInstalled)
```
    Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat 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
  - getCustomer
```
public String getCustomer()
```
    Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate- authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users.
    
    Returns:
    
    value or null for none
  - setCustomer
```
public Space setCustomer(String customer)
```
    Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate- authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users.
    
    Parameters:
    
    customer - customer or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. 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)
```
    Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. 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()
```
    Optional. 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 consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
    
    Returns:
    
    value or null for none
  - setExternalUserAllowed
```
public Space setExternalUserAllowed(Boolean externalUserAllowed)
```
    Optional. 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 consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. 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. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
    
    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. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
    
    Parameters:
    
    importMode - importMode or null for none
  - getImportModeExpireTime
```
public String getImportModeExpireTime()
```
    Output only. The time when the space will be automatically deleted by the system if it remains in import mode. Each space created in import mode must exit this mode before this expire time using `spaces.completeImport`. This field is only populated for spaces that were created with import mode.
    
    Returns:
    
    value or null for none
  - setImportModeExpireTime
```
public Space setImportModeExpireTime(String importModeExpireTime)
```
    Output only. The time when the space will be automatically deleted by the system if it remains in import mode. Each space created in import mode must exit this mode before this expire time using `spaces.completeImport`. This field is only populated for spaces that were created with import mode.
    
    Parameters:
    
    importModeExpireTime - importModeExpireTime or null for none
  - getLastActiveTime
```
public String getLastActiveTime()
```
    Output only. Timestamp of the last message in the space.
    
    Returns:
    
    value or null for none
  - setLastActiveTime
```
public Space setLastActiveTime(String lastActiveTime)
```
    Output only. Timestamp of the last message in the space.
    
    Parameters:
    
    lastActiveTime - lastActiveTime or null for none
  - getMembershipCount
```
public MembershipCount getMembershipCount()
```
    Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`.
    
    Returns:
    
    value or null for none
  - setMembershipCount
```
public Space setMembershipCount(MembershipCount membershipCount)
```
    Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`.
    
    Parameters:
    
    membershipCount - membershipCount or null for none
  - getName
```
public String getName()
```
    Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`]( https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`.
    
    Returns:
    
    value or null for none
  - setName
```
public Space setName(String name)
```
    Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`]( https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`.
    
    Parameters:
    
    name - name or null for none
  - getPermissionSettings
```
public PermissionSettings getPermissionSettings()
```
    Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat- user)
    
    Returns:
    
    value or null for none
  - setPermissionSettings
```
public Space setPermissionSettings(PermissionSettings permissionSettings)
```
    Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat- user)
    
    Parameters:
    
    permissionSettings - permissionSettings or null for none
  - getPredefinedPermissionSettings
```
public String getPredefinedPermissionSettings()
```
    Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate- authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
    
    Returns:
    
    value or null for none
  - setPredefinedPermissionSettings
```
public Space setPredefinedPermissionSettings(String predefinedPermissionSettings)
```
    Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate- authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
    
    Parameters:
    
    predefinedPermissionSettings - predefinedPermissionSettings 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()
```
    Optional. Details about the space including description and rules.
    
    Returns:
    
    value or null for none
  - setSpaceDetails
```
public Space setSpaceDetails(SpaceDetails spaceDetails)
```
    Optional. Details about the space including description and rules.
    
    Parameters:
    
    spaceDetails - spaceDetails or null for none
  - getSpaceHistoryState
```
public String getSpaceHistoryState()
```
    Optional. The message history state for messages and threads in this space.
    
    Returns:
    
    value or null for none
  - setSpaceHistoryState
```
public Space setSpaceHistoryState(String spaceHistoryState)
```
    Optional. 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()
```
    Optional. 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)
```
    Optional. 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
  - getSpaceUri
```
public String getSpaceUri()
```
    Output only. The URI for a user to access the space.
    
    Returns:
    
    value or null for none
  - setSpaceUri
```
public Space setSpaceUri(String spaceUri)
```
    Output only. The URI for a user to access the space.
    
    Parameters:
    
    spaceUri - spaceUri 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

getAccessSettings

setAccessSettings

getAdminInstalled

setAdminInstalled

getCreateTime

setCreateTime

getCustomer

setCustomer

getDisplayName

setDisplayName

getExternalUserAllowed

setExternalUserAllowed

getImportMode

setImportMode

getImportModeExpireTime

setImportModeExpireTime

getLastActiveTime

setLastActiveTime

getMembershipCount

setMembershipCount

getName

setName

getPermissionSettings

setPermissionSettings

getPredefinedPermissionSettings

setPredefinedPermissionSettings

getSingleUserBotDm

setSingleUserBotDm

getSpaceDetails

setSpaceDetails

getSpaceHistoryState

setSpaceHistoryState

getSpaceThreadingState

setSpaceThreadingState

getSpaceType

setSpaceType

getSpaceUri

setSpaceUri

getThreaded

setThreaded

getType

setType

set

clone