Class Space.Builder (0.18.0) 

public static final class Space.Builder extends GeneratedMessageV3.Builder<Space.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Space.Builder

Implements

SpaceOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Space.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Space.Builder
Overrides

build()

public Space build()
Returns
Type Description
Space

buildPartial()

public Space buildPartial()
Returns
Type Description
Space

clear()

public Space.Builder clear()
Returns
Type Description
Space.Builder
Overrides

clearAccessSettings()

public Space.Builder clearAccessSettings()

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

clearAdminInstalled()

public Space.Builder clearAdminInstalled()

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

This builder for chaining.

clearCreateTime()

public Space.Builder clearCreateTime()

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

clearDisplayName()

public Space.Builder clearDisplayName()

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;

Returns
Type Description
Space.Builder

This builder for chaining.

clearExternalUserAllowed()

public Space.Builder clearExternalUserAllowed()

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

Returns
Type Description
Space.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Space.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Space.Builder
Overrides

clearImportMode()

public Space.Builder clearImportMode()

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

This builder for chaining.

clearLastActiveTime()

public Space.Builder clearLastActiveTime()

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

clearMembershipCount()

public Space.Builder clearMembershipCount()

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

clearName()

public Space.Builder clearName()

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;

Returns
Type Description
Space.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Space.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Space.Builder
Overrides

clearPermissionSettings()

public Space.Builder clearPermissionSettings()

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

clearPredefinedPermissionSettings()

public Space.Builder clearPredefinedPermissionSettings()

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

This builder for chaining.

clearSingleUserBotDm()

public Space.Builder clearSingleUserBotDm()

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

This builder for chaining.

clearSpaceDetails()

public Space.Builder clearSpaceDetails()

Details about the space including description and rules.

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

Returns
Type Description
Space.Builder

clearSpaceHistoryState()

public Space.Builder clearSpaceHistoryState()

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

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

Returns
Type Description
Space.Builder

This builder for chaining.

clearSpacePermissionSettings()

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

clearSpaceThreadingState()

public Space.Builder clearSpaceThreadingState()

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

This builder for chaining.

clearSpaceType()

public Space.Builder clearSpaceType()

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

This builder for chaining.

clearSpaceUri()

public Space.Builder clearSpaceUri()

Output only. The URI for a user to access the space.

string space_uri = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Space.Builder

This builder for chaining.

clearThreaded() (deprecated)

public Space.Builder clearThreaded()

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

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

This builder for chaining.

clearType() (deprecated)

public Space.Builder clearType()

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

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

This builder for chaining.

clone()

public Space.Builder clone()
Returns
Type Description
Space.Builder
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.

getAccessSettingsBuilder()

public Space.AccessSettings.Builder getAccessSettingsBuilder()

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

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

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;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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;

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.

    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.

getLastActiveTimeBuilder()

public Timestamp.Builder getLastActiveTimeBuilder()

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
Builder

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.

getMembershipCountBuilder()

public Space.MembershipCount.Builder getMembershipCountBuilder()

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

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}

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;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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;

Returns
Type Description
ByteString

The bytes for name.

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

Returns
Type Description
Space.PermissionSettings

The permissionSettings.

getPermissionSettingsBuilder()

public Space.PermissionSettings.Builder getPermissionSettingsBuilder()

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

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

Returns
Type Description
Space.PermissionSettingsOrBuilder

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

Returns
Type Description
Space.PredefinedPermissionSettings

The predefinedPermissionSettings.

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

Returns
Type Description
int

The enum numeric value on the wire for predefinedPermissionSettings.

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.

getSpaceDetailsBuilder()

public Space.SpaceDetails.Builder getSpaceDetailsBuilder()

Details about the space including description and rules.

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

Returns
Type Description
Space.SpaceDetails.Builder

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.

getSpacePermissionSettingsCase()

public Space.SpacePermissionSettingsCase getSpacePermissionSettingsCase()
Returns
Type Description
Space.SpacePermissionSettingsCase

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=241

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=229

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=229

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.

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

Returns
Type Description
boolean

Whether the permissionSettings field is set.

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

Returns
Type Description
boolean

Whether the predefinedPermissionSettings 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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAccessSettings(Space.AccessSettings value)

public Space.Builder mergeAccessSettings(Space.AccessSettings value)

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

Parameter
Name Description
value Space.AccessSettings
Returns
Type Description
Space.Builder

mergeCreateTime(Timestamp value)

public Space.Builder mergeCreateTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Space.Builder

mergeFrom(Space other)

public Space.Builder mergeFrom(Space other)
Parameter
Name Description
other Space
Returns
Type Description
Space.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Space.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Space.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Space.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Space.Builder
Overrides

mergeLastActiveTime(Timestamp value)

public Space.Builder mergeLastActiveTime(Timestamp value)

Output only. Timestamp of the last message in the space.

.google.protobuf.Timestamp last_active_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Space.Builder

mergeMembershipCount(Space.MembershipCount value)

public Space.Builder mergeMembershipCount(Space.MembershipCount value)

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

Parameter
Name Description
value Space.MembershipCount
Returns
Type Description
Space.Builder

mergePermissionSettings(Space.PermissionSettings value)

public Space.Builder mergePermissionSettings(Space.PermissionSettings value)

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

Parameter
Name Description
value Space.PermissionSettings
Returns
Type Description
Space.Builder

mergeSpaceDetails(Space.SpaceDetails value)

public Space.Builder mergeSpaceDetails(Space.SpaceDetails value)

Details about the space including description and rules.

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

Parameter
Name Description
value Space.SpaceDetails
Returns
Type Description
Space.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Space.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Space.Builder
Overrides

setAccessSettings(Space.AccessSettings value)

public Space.Builder setAccessSettings(Space.AccessSettings value)

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

Parameter
Name Description
value Space.AccessSettings
Returns
Type Description
Space.Builder

setAccessSettings(Space.AccessSettings.Builder builderForValue)

public Space.Builder setAccessSettings(Space.AccessSettings.Builder builderForValue)

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

Parameter
Name Description
builderForValue Space.AccessSettings.Builder
Returns
Type Description
Space.Builder

setAdminInstalled(boolean value)

public Space.Builder setAdminInstalled(boolean value)

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

Parameter
Name Description
value boolean

The adminInstalled to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Space.Builder setCreateTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Space.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Space.Builder setCreateTime(Timestamp.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Space.Builder

setDisplayName(String value)

public Space.Builder setDisplayName(String value)

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;

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Space.Builder setDisplayNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setExternalUserAllowed(boolean value)

public Space.Builder setExternalUserAllowed(boolean value)

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

Parameter
Name Description
value boolean

The externalUserAllowed to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Space.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Space.Builder
Overrides

setImportMode(boolean value)

public Space.Builder setImportMode(boolean value)

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

Parameter
Name Description
value boolean

The importMode to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setLastActiveTime(Timestamp value)

public Space.Builder setLastActiveTime(Timestamp value)

Output only. Timestamp of the last message in the space.

.google.protobuf.Timestamp last_active_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Space.Builder

setLastActiveTime(Timestamp.Builder builderForValue)

public Space.Builder setLastActiveTime(Timestamp.Builder builderForValue)

Output only. Timestamp of the last message in the space.

.google.protobuf.Timestamp last_active_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Space.Builder

setMembershipCount(Space.MembershipCount value)

public Space.Builder setMembershipCount(Space.MembershipCount value)

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

Parameter
Name Description
value Space.MembershipCount
Returns
Type Description
Space.Builder

setMembershipCount(Space.MembershipCount.Builder builderForValue)

public Space.Builder setMembershipCount(Space.MembershipCount.Builder builderForValue)

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

Parameter
Name Description
builderForValue Space.MembershipCount.Builder
Returns
Type Description
Space.Builder

setName(String value)

public Space.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Space.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setPermissionSettings(Space.PermissionSettings value)

public Space.Builder setPermissionSettings(Space.PermissionSettings value)

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

Parameter
Name Description
value Space.PermissionSettings
Returns
Type Description
Space.Builder

setPermissionSettings(Space.PermissionSettings.Builder builderForValue)

public Space.Builder setPermissionSettings(Space.PermissionSettings.Builder builderForValue)

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

Parameter
Name Description
builderForValue Space.PermissionSettings.Builder
Returns
Type Description
Space.Builder

setPredefinedPermissionSettings(Space.PredefinedPermissionSettings value)

public Space.Builder setPredefinedPermissionSettings(Space.PredefinedPermissionSettings value)

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

Parameter
Name Description
value Space.PredefinedPermissionSettings

The predefinedPermissionSettings to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setPredefinedPermissionSettingsValue(int value)

public Space.Builder setPredefinedPermissionSettingsValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for predefinedPermissionSettings to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Space.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Space.Builder
Overrides

setSingleUserBotDm(boolean value)

public Space.Builder setSingleUserBotDm(boolean value)

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

Parameter
Name Description
value boolean

The singleUserBotDm to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setSpaceDetails(Space.SpaceDetails value)

public Space.Builder setSpaceDetails(Space.SpaceDetails value)

Details about the space including description and rules.

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

Parameter
Name Description
value Space.SpaceDetails
Returns
Type Description
Space.Builder

setSpaceDetails(Space.SpaceDetails.Builder builderForValue)

public Space.Builder setSpaceDetails(Space.SpaceDetails.Builder builderForValue)

Details about the space including description and rules.

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

Parameter
Name Description
builderForValue Space.SpaceDetails.Builder
Returns
Type Description
Space.Builder

setSpaceHistoryState(HistoryState value)

public Space.Builder setSpaceHistoryState(HistoryState value)

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

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

Parameter
Name Description
value HistoryState

The spaceHistoryState to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setSpaceHistoryStateValue(int value)

public Space.Builder setSpaceHistoryStateValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for spaceHistoryState to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setSpaceThreadingState(Space.SpaceThreadingState value)

public Space.Builder setSpaceThreadingState(Space.SpaceThreadingState value)

Output only. The threading state in the Chat space.

.google.chat.v1.Space.SpaceThreadingState space_threading_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Space.SpaceThreadingState

The spaceThreadingState to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setSpaceThreadingStateValue(int value)

public Space.Builder setSpaceThreadingStateValue(int value)

Output only. The threading state in the Chat space.

.google.chat.v1.Space.SpaceThreadingState space_threading_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for spaceThreadingState to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setSpaceType(Space.SpaceType value)

public Space.Builder setSpaceType(Space.SpaceType value)

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;

Parameter
Name Description
value Space.SpaceType

The spaceType to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setSpaceTypeValue(int value)

public Space.Builder setSpaceTypeValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for spaceType to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setSpaceUri(String value)

public Space.Builder setSpaceUri(String value)

Output only. The URI for a user to access the space.

string space_uri = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The spaceUri to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setSpaceUriBytes(ByteString value)

public Space.Builder setSpaceUriBytes(ByteString value)

Output only. The URI for a user to access the space.

string space_uri = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for spaceUri to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setThreaded(boolean value) (deprecated)

public Space.Builder setThreaded(boolean value)

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

Output only. Deprecated: Use spaceThreadingState instead. Whether messages are threaded in this space.

bool threaded = 5 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The threaded to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setType(Space.Type value) (deprecated)

public Space.Builder setType(Space.Type value)

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

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

Parameter
Name Description
value Space.Type

The type to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setTypeValue(int value) (deprecated)

public Space.Builder setTypeValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.
Returns
Type Description
Space.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Space.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Space.Builder
Overrides