Class Space (0.15.0) 

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 > Space

Implements

SpaceOrBuilder

Static Fields

ACCESS_SETTINGS_FIELD_NUMBER

public static final int ACCESS_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

ADMIN_INSTALLED_FIELD_NUMBER

public static final int ADMIN_INSTALLED_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EXTERNAL_USER_ALLOWED_FIELD_NUMBER

public static final int EXTERNAL_USER_ALLOWED_FIELD_NUMBER
Field Value
Type Description
int

IMPORT_MODE_FIELD_NUMBER

public static final int IMPORT_MODE_FIELD_NUMBER
Field Value
Type Description
int

LAST_ACTIVE_TIME_FIELD_NUMBER

public static final int LAST_ACTIVE_TIME_FIELD_NUMBER
Field Value
Type Description
int

MEMBERSHIP_COUNT_FIELD_NUMBER

public static final int MEMBERSHIP_COUNT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SINGLE_USER_BOT_DM_FIELD_NUMBER

public static final int SINGLE_USER_BOT_DM_FIELD_NUMBER
Field Value
Type Description
int

SPACE_DETAILS_FIELD_NUMBER

public static final int SPACE_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

SPACE_HISTORY_STATE_FIELD_NUMBER

public static final int SPACE_HISTORY_STATE_FIELD_NUMBER
Field Value
Type Description
int

SPACE_THREADING_STATE_FIELD_NUMBER

public static final int SPACE_THREADING_STATE_FIELD_NUMBER
Field Value
Type Description
int

SPACE_TYPE_FIELD_NUMBER

public static final int SPACE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SPACE_URI_FIELD_NUMBER

public static final int SPACE_URI_FIELD_NUMBER
Field Value
Type Description
int

THREADED_FIELD_NUMBER

public static final int THREADED_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Space getDefaultInstance()
Returns
Type Description
Space

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Space.Builder newBuilder()
Returns
Type Description
Space.Builder

newBuilder(Space prototype)

public static Space.Builder newBuilder(Space prototype)
Parameter
Name Description
prototype Space
Returns
Type Description
Space.Builder

parseDelimitedFrom(InputStream input)

public static Space parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Space
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Space parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Space
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Space parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Space
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Space parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Space
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Space parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Space
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Space parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Space
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Space parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Space
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Space parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Space
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Space parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Space
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Space parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Space
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Space parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Space
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Space parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Space
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Space> parser()
Returns
Type Description
Parser<Space>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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];

Returns
Type Description
Space.AccessSettings

The accessSettings.

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];

Returns
Type Description
Space.AccessSettingsOrBuilder

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];

Returns
Type Description
boolean

The adminInstalled.

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];

Returns
Type Description
Timestamp

The createTime.

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];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Space getDefaultInstanceForType()
Returns
Type Description
Space

getDisplayName()

public String getDisplayName()

The space's display name. Required when creating a 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;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The space's display name. Required when creating a 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;

Returns
Type Description
ByteString

The bytes for displayName.

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 consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user.

  • The space is used to import data to Google Chat because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the Google Workspace Developer Preview Program, import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces.

    For existing spaces, this field is output only.

bool external_user_allowed = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

The externalUserAllowed.

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.

bool import_mode = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The importMode.

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];

Returns
Type Description
Timestamp

The lastActiveTime.

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];

Returns
Type Description
TimestampOrBuilder

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];

Returns
Type Description
Space.MembershipCount

The membershipCount.

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];

Returns
Type Description
Space.MembershipCountOrBuilder

getName()

public String getName()

Resource name of the space.

Format: spaces/{space}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Resource name of the space.

Format: spaces/{space}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Space> getParserForType()
Returns
Type Description
Parser<Space>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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];

Returns
Type Description
boolean

The singleUserBotDm.

getSpaceDetails()

public Space.SpaceDetails getSpaceDetails()

Details about the space including description and rules.

.google.chat.v1.Space.SpaceDetails space_details = 11;

Returns
Type Description
Space.SpaceDetails

The spaceDetails.

getSpaceDetailsOrBuilder()

public Space.SpaceDetailsOrBuilder getSpaceDetailsOrBuilder()

Details about the space including description and rules.

.google.chat.v1.Space.SpaceDetails space_details = 11;

Returns
Type Description
Space.SpaceDetailsOrBuilder

getSpaceHistoryState()

public HistoryState getSpaceHistoryState()

The message history state for messages and threads in this space.

.google.chat.v1.HistoryState space_history_state = 13;

Returns
Type Description
HistoryState

The spaceHistoryState.

getSpaceHistoryStateValue()

public int getSpaceHistoryStateValue()

The message history state for messages and threads in this space.

.google.chat.v1.HistoryState space_history_state = 13;

Returns
Type Description
int

The enum numeric value on the wire for spaceHistoryState.

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];

Returns
Type Description
Space.SpaceThreadingState

The spaceThreadingState.

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];

Returns
Type Description
int

The enum numeric value on the wire for spaceThreadingState.

getSpaceType()

public Space.SpaceType getSpaceType()

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;

Returns
Type Description
Space.SpaceType

The spaceType.

getSpaceTypeValue()

public int getSpaceTypeValue()

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;

Returns
Type Description
int

The enum numeric value on the wire for spaceType.

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];

Returns
Type Description
String

The spaceUri.

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];

Returns
Type Description
ByteString

The bytes for spaceUri.

getThreaded() (deprecated)

public boolean getThreaded()

Deprecated. google.chat.v1.Space.threaded is deprecated. See google/chat/v1/space.proto;l=167

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 Space.Type getType()

Deprecated. google.chat.v1.Space.type is deprecated. See google/chat/v1/space.proto;l=155

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 int getTypeValue()

Deprecated. google.chat.v1.Space.type is deprecated. See google/chat/v1/space.proto;l=155

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 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 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.

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];

Returns
Type Description
boolean

Whether the lastActiveTime field is set.

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];

Returns
Type Description
boolean

Whether the membershipCount field is set.

hasSpaceDetails()

public boolean hasSpaceDetails()

Details about the space including description and rules.

.google.chat.v1.Space.SpaceDetails space_details = 11;

Returns
Type Description
boolean

Whether the spaceDetails field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Space.Builder newBuilderForType()
Returns
Type Description
Space.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Space.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Space.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Space.Builder toBuilder()
Returns
Type Description
Space.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException