public interface SpaceOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAccessSettings()
public abstract Space.AccessSettings getAccessSettings() Optional. Specifies the access
setting of the space.
Only populated when the space_type is SPACE.
.google.chat.v1.Space.AccessSettings access_settings = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Space.AccessSettings |
The accessSettings. |
getAccessSettingsOrBuilder()
public abstract Space.AccessSettingsOrBuilder getAccessSettingsOrBuilder() Optional. Specifies the access
setting of the space.
Only populated when the space_type is SPACE.
.google.chat.v1.Space.AccessSettings access_settings = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Space.AccessSettingsOrBuilder |
|
getAdminInstalled()
public abstract 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.
bool admin_installed = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The adminInstalled. |
getCreateTime()
public abstract Timestamp 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.
.google.protobuf.Timestamp create_time = 17 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()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.
.google.protobuf.Timestamp create_time = 17 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDisplayName()
public abstract String getDisplayName() Optional. The space's display name. Required when creating a
space
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.
string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes() Optional. The space's display name. Required when creating a
space
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.
string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getExternalUserAllowed()
public abstract 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.
bool external_user_allowed = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The externalUserAllowed. |
getImportMode()
public abstract 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 Moderequires user
authentication.
bool import_mode = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The importMode. |
getImportModeExpireTime()
public abstract Timestamp 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.
.google.protobuf.Timestamp import_mode_expire_time = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The importModeExpireTime. |
getImportModeExpireTimeOrBuilder()
public abstract TimestampOrBuilder getImportModeExpireTimeOrBuilder()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.
.google.protobuf.Timestamp import_mode_expire_time = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getLastActiveTime()
public abstract Timestamp getLastActiveTime()Output only. Timestamp of the last message in the space.
.google.protobuf.Timestamp last_active_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The lastActiveTime. |
getLastActiveTimeOrBuilder()
public abstract TimestampOrBuilder getLastActiveTimeOrBuilder()Output only. Timestamp of the last message in the space.
.google.protobuf.Timestamp last_active_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getMembershipCount()
public abstract Space.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.
.google.chat.v1.Space.MembershipCount membership_count = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Space.MembershipCount |
The membershipCount. |
getMembershipCountOrBuilder()
public abstract Space.MembershipCountOrBuilder getMembershipCountOrBuilder() Output only. The count of joined memberships grouped by member type.
Populated when the space_type is SPACE, DIRECT_MESSAGE or
GROUP_CHAT.
.google.chat.v1.Space.MembershipCount membership_count = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Space.MembershipCountOrBuilder |
|
getName()
public abstract 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()
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.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes()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()
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.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getPermissionSettings()
public abstract Space.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.
.google.chat.v1.Space.PermissionSettings permission_settings = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Space.PermissionSettings |
The permissionSettings. |
getPermissionSettingsOrBuilder()
public abstract Space.PermissionSettingsOrBuilder getPermissionSettingsOrBuilder()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.
.google.chat.v1.Space.PermissionSettings permission_settings = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Space.PermissionSettingsOrBuilder |
|
getPredefinedPermissionSettings()
public abstract Space.PredefinedPermissionSettings 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.
.google.chat.v1.Space.PredefinedPermissionSettings predefined_permission_settings = 26 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Space.PredefinedPermissionSettings |
The predefinedPermissionSettings. |
getPredefinedPermissionSettingsValue()
public abstract int getPredefinedPermissionSettingsValue() 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.
.google.chat.v1.Space.PredefinedPermissionSettings predefined_permission_settings = 26 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for predefinedPermissionSettings. |
getSingleUserBotDm()
public abstract boolean getSingleUserBotDm()Optional. Whether the space is a DM between a Chat app and a single human.
bool single_user_bot_dm = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The singleUserBotDm. |
getSpaceDetails()
public abstract Space.SpaceDetails getSpaceDetails()Optional. Details about the space including description and rules.
.google.chat.v1.Space.SpaceDetails space_details = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Space.SpaceDetails |
The spaceDetails. |
getSpaceDetailsOrBuilder()
public abstract Space.SpaceDetailsOrBuilder getSpaceDetailsOrBuilder()Optional. Details about the space including description and rules.
.google.chat.v1.Space.SpaceDetails space_details = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Space.SpaceDetailsOrBuilder |
|
getSpaceHistoryState()
public abstract HistoryState getSpaceHistoryState()Optional. The message history state for messages and threads in this space.
.google.chat.v1.HistoryState space_history_state = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
HistoryState |
The spaceHistoryState. |
getSpaceHistoryStateValue()
public abstract int getSpaceHistoryStateValue()Optional. The message history state for messages and threads in this space.
.google.chat.v1.HistoryState space_history_state = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for spaceHistoryState. |
getSpacePermissionSettingsCase()
public abstract Space.SpacePermissionSettingsCase getSpacePermissionSettingsCase()| Returns | |
|---|---|
| Type | Description |
Space.SpacePermissionSettingsCase |
|
getSpaceThreadingState()
public abstract Space.SpaceThreadingState getSpaceThreadingState()Output only. The threading state in the Chat space.
.google.chat.v1.Space.SpaceThreadingState space_threading_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Space.SpaceThreadingState |
The spaceThreadingState. |
getSpaceThreadingStateValue()
public abstract int getSpaceThreadingStateValue()Output only. The threading state in the Chat space.
.google.chat.v1.Space.SpaceThreadingState space_threading_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for spaceThreadingState. |
getSpaceType()
public abstract Space.SpaceType getSpaceType()Optional. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.
.google.chat.v1.Space.SpaceType space_type = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Space.SpaceType |
The spaceType. |
getSpaceTypeValue()
public abstract int getSpaceTypeValue()Optional. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.
.google.chat.v1.Space.SpaceType space_type = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for spaceType. |
getSpaceUri()
public abstract String getSpaceUri()Output only. The URI for a user to access the space.
string space_uri = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The spaceUri. |
getSpaceUriBytes()
public abstract ByteString getSpaceUriBytes()Output only. The URI for a user to access the space.
string space_uri = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for spaceUri. |
getThreaded() (deprecated)
public abstract boolean getThreaded()Deprecated. google.chat.v1.Space.threaded is deprecated. See google/chat/v1/space.proto;l=268
Output only. Deprecated: Use spaceThreadingState instead.
Whether messages are threaded in this space.
bool threaded = 5 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The threaded. |
getType() (deprecated)
public abstract Space.Type getType()Deprecated. google.chat.v1.Space.type is deprecated. See google/chat/v1/space.proto;l=256
Output only. Deprecated: Use space_type instead.
The type of a space.
.google.chat.v1.Space.Type type = 2 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Space.Type |
The type. |
getTypeValue() (deprecated)
public abstract int getTypeValue()Deprecated. google.chat.v1.Space.type is deprecated. See google/chat/v1/space.proto;l=256
Output only. Deprecated: Use space_type instead.
The type of a space.
.google.chat.v1.Space.Type type = 2 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for type. |
hasAccessSettings()
public abstract boolean hasAccessSettings() Optional. Specifies the access
setting of the space.
Only populated when the space_type is SPACE.
.google.chat.v1.Space.AccessSettings access_settings = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the accessSettings field is set. |
hasCreateTime()
public abstract boolean hasCreateTime()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.
.google.protobuf.Timestamp create_time = 17 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasImportModeExpireTime()
public abstract boolean hasImportModeExpireTime()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.
.google.protobuf.Timestamp import_mode_expire_time = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the importModeExpireTime field is set. |
hasLastActiveTime()
public abstract boolean hasLastActiveTime()Output only. Timestamp of the last message in the space.
.google.protobuf.Timestamp last_active_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the lastActiveTime field is set. |
hasMembershipCount()
public abstract boolean hasMembershipCount() Output only. The count of joined memberships grouped by member type.
Populated when the space_type is SPACE, DIRECT_MESSAGE or
GROUP_CHAT.
.google.chat.v1.Space.MembershipCount membership_count = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the membershipCount field is set. |
hasPermissionSettings()
public abstract boolean hasPermissionSettings()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.
.google.chat.v1.Space.PermissionSettings permission_settings = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the permissionSettings field is set. |
hasPredefinedPermissionSettings()
public abstract boolean hasPredefinedPermissionSettings() 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.
.google.chat.v1.Space.PredefinedPermissionSettings predefined_permission_settings = 26 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the predefinedPermissionSettings field is set. |
hasSpaceDetails()
public abstract boolean hasSpaceDetails()Optional. Details about the space including description and rules.
.google.chat.v1.Space.SpaceDetails space_details = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the spaceDetails field is set. |