public interface UpdateSpaceRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getSpace()
public abstract Space getSpace()
Required. Space with fields to be updated. Space.name
must be
populated in the form of spaces/{space}
. Only fields
specified by update_mask
are updated.
.google.chat.v1.Space space = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Space |
The space. |
getSpaceOrBuilder()
public abstract SpaceOrBuilder getSpaceOrBuilder()
Required. Space with fields to be updated. Space.name
must be
populated in the form of spaces/{space}
. Only fields
specified by update_mask
are updated.
.google.chat.v1.Space space = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
SpaceOrBuilder |
getUpdateMask()
public abstract FieldMask getUpdateMask()
Required. The updated field paths, comma separated if there are multiple.
You can update the following fields for a space:
space_details
: Updates the space's description. Supports up to 150
characters.
display_name
: Only supports updating the display name for spaces where
spaceType
field is SPACE
.
If you receive the error message ALREADY_EXISTS
, try a different
value. An existing space within the
Google Workspace organization might already use this display name.
space_type
: Only supports changing a GROUP_CHAT
space type to
SPACE
. Include display_name
together
with space_type
in the update mask and ensure that the specified space
has a non-empty display name and the SPACE
space type. Including the
space_type
mask and the SPACE
type in the specified space when updating
the display name is optional if the existing space already has the SPACE
type. Trying to update the space type in other ways results in an invalid
argument error.
space_type
is not supported with useAdminAccess
.
space_history_state
: Updates space history
settings by turning
history on or off for the space. Only supported if history settings are
enabled for the Google Workspace organization. To update the
space history state, you must omit all other field masks in your request.
space_history_state
is not supported with useAdminAccess
.
access_settings.audience
: Updates the access
setting of who can
discover the space, join the space, and preview the messages in named space
where spaceType
field is SPACE
. If the existing space has a
target audience, you can remove the audience and restrict space access by
omitting a value for this field mask. To update access settings for a
space, the authenticating user must be a space manager and omit all other
field masks in your request. You can't update this field if the space is in
import
mode.
To learn more, see Make a space discoverable to specific
users.
access_settings.audience
is not supported with useAdminAccess
.
permission_settings
: Supports changing the
permission settings
of a space.
When updating permission settings, you can only specify
permissionSettings
field masks; you cannot update other field masks
at the same time. permissionSettings
is not supported with
useAdminAccess
.
The supported field masks include:
permission_settings.manageMembersAndGroups
permission_settings.modifySpaceDetails
permission_settings.toggleHistory
permission_settings.useAtMentionAll
permission_settings.manageApps
permission_settings.manageWebhooks
permission_settings.replyMessages
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
FieldMask |
The updateMask. |
getUpdateMaskOrBuilder()
public abstract FieldMaskOrBuilder getUpdateMaskOrBuilder()
Required. The updated field paths, comma separated if there are multiple.
You can update the following fields for a space:
space_details
: Updates the space's description. Supports up to 150
characters.
display_name
: Only supports updating the display name for spaces where
spaceType
field is SPACE
.
If you receive the error message ALREADY_EXISTS
, try a different
value. An existing space within the
Google Workspace organization might already use this display name.
space_type
: Only supports changing a GROUP_CHAT
space type to
SPACE
. Include display_name
together
with space_type
in the update mask and ensure that the specified space
has a non-empty display name and the SPACE
space type. Including the
space_type
mask and the SPACE
type in the specified space when updating
the display name is optional if the existing space already has the SPACE
type. Trying to update the space type in other ways results in an invalid
argument error.
space_type
is not supported with useAdminAccess
.
space_history_state
: Updates space history
settings by turning
history on or off for the space. Only supported if history settings are
enabled for the Google Workspace organization. To update the
space history state, you must omit all other field masks in your request.
space_history_state
is not supported with useAdminAccess
.
access_settings.audience
: Updates the access
setting of who can
discover the space, join the space, and preview the messages in named space
where spaceType
field is SPACE
. If the existing space has a
target audience, you can remove the audience and restrict space access by
omitting a value for this field mask. To update access settings for a
space, the authenticating user must be a space manager and omit all other
field masks in your request. You can't update this field if the space is in
import
mode.
To learn more, see Make a space discoverable to specific
users.
access_settings.audience
is not supported with useAdminAccess
.
permission_settings
: Supports changing the
permission settings
of a space.
When updating permission settings, you can only specify
permissionSettings
field masks; you cannot update other field masks
at the same time. permissionSettings
is not supported with
useAdminAccess
.
The supported field masks include:
permission_settings.manageMembersAndGroups
permission_settings.modifySpaceDetails
permission_settings.toggleHistory
permission_settings.useAtMentionAll
permission_settings.manageApps
permission_settings.manageWebhooks
permission_settings.replyMessages
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
FieldMaskOrBuilder |
getUseAdminAccess()
public abstract boolean getUseAdminAccess()
Optional. When true
, the method runs using the user's Google Workspace
administrator privileges.
The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.
Requires the chat.admin.spaces
OAuth 2.0
scope.
Some FieldMask
values are not supported using admin access. For details,
see the description of update_mask
.
bool use_admin_access = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
The useAdminAccess. |
hasSpace()
public abstract boolean hasSpace()
Required. Space with fields to be updated. Space.name
must be
populated in the form of spaces/{space}
. Only fields
specified by update_mask
are updated.
.google.chat.v1.Space space = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
boolean |
Whether the space field is set. |
hasUpdateMask()
public abstract boolean hasUpdateMask()
Required. The updated field paths, comma separated if there are multiple.
You can update the following fields for a space:
space_details
: Updates the space's description. Supports up to 150
characters.
display_name
: Only supports updating the display name for spaces where
spaceType
field is SPACE
.
If you receive the error message ALREADY_EXISTS
, try a different
value. An existing space within the
Google Workspace organization might already use this display name.
space_type
: Only supports changing a GROUP_CHAT
space type to
SPACE
. Include display_name
together
with space_type
in the update mask and ensure that the specified space
has a non-empty display name and the SPACE
space type. Including the
space_type
mask and the SPACE
type in the specified space when updating
the display name is optional if the existing space already has the SPACE
type. Trying to update the space type in other ways results in an invalid
argument error.
space_type
is not supported with useAdminAccess
.
space_history_state
: Updates space history
settings by turning
history on or off for the space. Only supported if history settings are
enabled for the Google Workspace organization. To update the
space history state, you must omit all other field masks in your request.
space_history_state
is not supported with useAdminAccess
.
access_settings.audience
: Updates the access
setting of who can
discover the space, join the space, and preview the messages in named space
where spaceType
field is SPACE
. If the existing space has a
target audience, you can remove the audience and restrict space access by
omitting a value for this field mask. To update access settings for a
space, the authenticating user must be a space manager and omit all other
field masks in your request. You can't update this field if the space is in
import
mode.
To learn more, see Make a space discoverable to specific
users.
access_settings.audience
is not supported with useAdminAccess
.
permission_settings
: Supports changing the
permission settings
of a space.
When updating permission settings, you can only specify
permissionSettings
field masks; you cannot update other field masks
at the same time. permissionSettings
is not supported with
useAdminAccess
.
The supported field masks include:
permission_settings.manageMembersAndGroups
permission_settings.modifySpaceDetails
permission_settings.toggleHistory
permission_settings.useAtMentionAll
permission_settings.manageApps
permission_settings.manageWebhooks
permission_settings.replyMessages
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
boolean |
Whether the updateMask field is set. |