public
final
class
Space
extends
GeneratedMessageV3
implements
SpaceOrBuilder
A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.
Protobuf type google.chat.v1.Space
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SpaceImplements
SpaceOrBuilderStatic Fields
ACCESS_SETTINGS_FIELD_NUMBER
public
static
final
int
ACCESS_SETTINGS_FIELD_NUMBER
ADMIN_INSTALLED_FIELD_NUMBER
public
static
final
int
ADMIN_INSTALLED_FIELD_NUMBER
CREATE_TIME_FIELD_NUMBER
public
static
final
int
CREATE_TIME_FIELD_NUMBER
DISPLAY_NAME_FIELD_NUMBER
public
static
final
int
DISPLAY_NAME_FIELD_NUMBER
EXTERNAL_USER_ALLOWED_FIELD_NUMBER
public
static
final
int
EXTERNAL_USER_ALLOWED_FIELD_NUMBER
IMPORT_MODE_EXPIRE_TIME_FIELD_NUMBER
public
static
final
int
IMPORT_MODE_EXPIRE_TIME_FIELD_NUMBER
IMPORT_MODE_FIELD_NUMBER
public
static
final
int
IMPORT_MODE_FIELD_NUMBER
LAST_ACTIVE_TIME_FIELD_NUMBER
public
static
final
int
LAST_ACTIVE_TIME_FIELD_NUMBER
MEMBERSHIP_COUNT_FIELD_NUMBER
public
static
final
int
MEMBERSHIP_COUNT_FIELD_NUMBER
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
PERMISSION_SETTINGS_FIELD_NUMBER
public
static
final
int
PERMISSION_SETTINGS_FIELD_NUMBER
PREDEFINED_PERMISSION_SETTINGS_FIELD_NUMBER
public
static
final
int
PREDEFINED_PERMISSION_SETTINGS_FIELD_NUMBER
SINGLE_USER_BOT_DM_FIELD_NUMBER
public
static
final
int
SINGLE_USER_BOT_DM_FIELD_NUMBER
SPACE_DETAILS_FIELD_NUMBER
public
static
final
int
SPACE_DETAILS_FIELD_NUMBER
SPACE_HISTORY_STATE_FIELD_NUMBER
public
static
final
int
SPACE_HISTORY_STATE_FIELD_NUMBER
SPACE_THREADING_STATE_FIELD_NUMBER
public
static
final
int
SPACE_THREADING_STATE_FIELD_NUMBER
SPACE_TYPE_FIELD_NUMBER
public
static
final
int
SPACE_TYPE_FIELD_NUMBER
SPACE_URI_FIELD_NUMBER
public
static
final
int
SPACE_URI_FIELD_NUMBER
THREADED_FIELD_NUMBER
public
static
final
int
THREADED_FIELD_NUMBER
TYPE_FIELD_NUMBER
public
static
final
int
TYPE_FIELD_NUMBER
Static Methods
getDefaultInstance()
public
static
Space
getDefaultInstance
()
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
newBuilder()
public
static
Space
.
Builder
newBuilder
()
newBuilder(Space prototype)
public
static
Space
.
Builder
newBuilder
(
Space
prototype
)
parseDelimitedFrom(InputStream input)
public
static
Space
parseDelimitedFrom
(
InputStream
input
)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Space
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(byte[] data)
public
static
Space
parseFrom
(
byte
[]
data
)
data
byte
[]
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Space
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteString data)
public
static
Space
parseFrom
(
ByteString
data
)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Space
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(CodedInputStream input)
public
static
Space
parseFrom
(
CodedInputStream
input
)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Space
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(InputStream input)
public
static
Space
parseFrom
(
InputStream
input
)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Space
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteBuffer data)
public
static
Space
parseFrom
(
ByteBuffer
data
)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Space
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
parser()
public
static
Parser<Space>
parser
()
Methods
equals(Object obj)
public
boolean
equals
(
Object
obj
)
getAccessSettings()
public
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];
getAccessSettingsOrBuilder()
public
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];
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.
bool admin_installed = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime()
public
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];
getCreateTimeOrBuilder()
public
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];
getDefaultInstanceForType()
public
Space
getDefaultInstanceForType
()
getDisplayName()
public
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];
getDisplayNameBytes()
public
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];
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.
bool external_user_allowed = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
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
.
bool import_mode = 16 [(.google.api.field_behavior) = OPTIONAL];
getImportModeExpireTime()
public
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];
getImportModeExpireTimeOrBuilder()
public
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];
getLastActiveTime()
public
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];
getLastActiveTimeOrBuilder()
public
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];
getMembershipCount()
public
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];
getMembershipCountOrBuilder()
public
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];
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()
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];
getNameBytes()
public
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];
getParserForType()
public
Parser<Space>
getParserForType
()
getPermissionSettings()
public
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];
getPermissionSettingsOrBuilder()
public
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];
getPredefinedPermissionSettings()
public
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];
getPredefinedPermissionSettingsValue()
public
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];
getSerializedSize()
public
int
getSerializedSize
()
getSingleUserBotDm()
public
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];
getSpaceDetails()
public
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];
getSpaceDetailsOrBuilder()
public
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];
getSpaceHistoryState()
public
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];
getSpaceHistoryStateValue()
public
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];
getSpacePermissionSettingsCase()
public
Space
.
SpacePermissionSettingsCase
getSpacePermissionSettingsCase
()
getSpaceThreadingState()
public
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];
getSpaceThreadingStateValue()
public
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];
getSpaceType()
public
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];
getSpaceTypeValue()
public
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];
getSpaceUri()
public
String
getSpaceUri
()
Output only. The URI for a user to access the space.
string space_uri = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSpaceUriBytes()
public
ByteString
getSpaceUriBytes
()
Output only. The URI for a user to access the space.
string space_uri = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
getThreaded() (deprecated)
public
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];
getType() (deprecated)
public
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];
getTypeValue() (deprecated)
public
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];
hasAccessSettings()
public
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];
hasCreateTime()
public
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];
hasImportModeExpireTime()
public
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];
hasLastActiveTime()
public
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];
hasMembershipCount()
public
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];
hasPermissionSettings()
public
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];
hasPredefinedPermissionSettings()
public
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];
hasSpaceDetails()
public
boolean
hasSpaceDetails
()
Optional. Details about the space including description and rules.
.google.chat.v1.Space.SpaceDetails space_details = 11 [(.google.api.field_behavior) = OPTIONAL];
hashCode()
public
int
hashCode
()
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
isInitialized()
public
final
boolean
isInitialized
()
newBuilderForType()
public
Space
.
Builder
newBuilderForType
()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Space
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
toBuilder()
public
Space
.
Builder
toBuilder
()
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
