public static final class UpdateSpaceRequest.Builder extends GeneratedMessageV3.Builder<UpdateSpaceRequest.Builder> implements UpdateSpaceRequestOrBuilderA request to update a single space.
Protobuf type google.chat.v1.UpdateSpaceRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UpdateSpaceRequest.BuilderImplements
UpdateSpaceRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public UpdateSpaceRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
build()
public UpdateSpaceRequest build()| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest |
|
buildPartial()
public UpdateSpaceRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest |
|
clear()
public UpdateSpaceRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public UpdateSpaceRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public UpdateSpaceRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
clearSpace()
public UpdateSpaceRequest.Builder clearSpace() 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 |
UpdateSpaceRequest.Builder |
|
clearUpdateMask()
public UpdateSpaceRequest.Builder clearUpdateMask()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.manageMembersAndGroupspermission_settings.modifySpaceDetailspermission_settings.toggleHistorypermission_settings.useAtMentionAllpermission_settings.manageAppspermission_settings.manageWebhookspermission_settings.replyMessages
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
clearUseAdminAccess()
public UpdateSpaceRequest.Builder clearUseAdminAccess() 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 |
UpdateSpaceRequest.Builder |
This builder for chaining. |
clone()
public UpdateSpaceRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
getDefaultInstanceForType()
public UpdateSpaceRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getSpace()
public 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. |
getSpaceBuilder()
public Space.Builder getSpaceBuilder() 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.Builder |
|
getSpaceOrBuilder()
public 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 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.manageMembersAndGroupspermission_settings.modifySpaceDetailspermission_settings.toggleHistorypermission_settings.useAtMentionAllpermission_settings.manageAppspermission_settings.manageWebhookspermission_settings.replyMessages
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
FieldMask |
The updateMask. |
getUpdateMaskBuilder()
public FieldMask.Builder getUpdateMaskBuilder()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.manageMembersAndGroupspermission_settings.modifySpaceDetailspermission_settings.toggleHistorypermission_settings.useAtMentionAllpermission_settings.manageAppspermission_settings.manageWebhookspermission_settings.replyMessages
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getUpdateMaskOrBuilder()
public 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.manageMembersAndGroupspermission_settings.modifySpaceDetailspermission_settings.toggleHistorypermission_settings.useAtMentionAllpermission_settings.manageAppspermission_settings.manageWebhookspermission_settings.replyMessages
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
FieldMaskOrBuilder |
|
getUseAdminAccess()
public 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 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 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.manageMembersAndGroupspermission_settings.modifySpaceDetailspermission_settings.toggleHistorypermission_settings.useAtMentionAllpermission_settings.manageAppspermission_settings.manageWebhookspermission_settings.replyMessages
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateMask field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(UpdateSpaceRequest other)
public UpdateSpaceRequest.Builder mergeFrom(UpdateSpaceRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
UpdateSpaceRequest |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public UpdateSpaceRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public UpdateSpaceRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
mergeSpace(Space value)
public UpdateSpaceRequest.Builder mergeSpace(Space value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
Space |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final UpdateSpaceRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
mergeUpdateMask(FieldMask value)
public UpdateSpaceRequest.Builder mergeUpdateMask(FieldMask value)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.manageMembersAndGroupspermission_settings.modifySpaceDetailspermission_settings.toggleHistorypermission_settings.useAtMentionAllpermission_settings.manageAppspermission_settings.manageWebhookspermission_settings.replyMessages
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
FieldMask |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public UpdateSpaceRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public UpdateSpaceRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
setSpace(Space value)
public UpdateSpaceRequest.Builder setSpace(Space value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
Space |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
setSpace(Space.Builder builderForValue)
public UpdateSpaceRequest.Builder setSpace(Space.Builder builderForValue) 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Space.Builder |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final UpdateSpaceRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
setUpdateMask(FieldMask value)
public UpdateSpaceRequest.Builder setUpdateMask(FieldMask value)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.manageMembersAndGroupspermission_settings.modifySpaceDetailspermission_settings.toggleHistorypermission_settings.useAtMentionAllpermission_settings.manageAppspermission_settings.manageWebhookspermission_settings.replyMessages
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
FieldMask |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
setUpdateMask(FieldMask.Builder builderForValue)
public UpdateSpaceRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)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.manageMembersAndGroupspermission_settings.modifySpaceDetailspermission_settings.toggleHistorypermission_settings.useAtMentionAllpermission_settings.manageAppspermission_settings.manageWebhookspermission_settings.replyMessages
.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
|
setUseAdminAccess(boolean value)
public UpdateSpaceRequest.Builder setUseAdminAccess(boolean value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe useAdminAccess to set. |
| Returns | |
|---|---|
| Type | Description |
UpdateSpaceRequest.Builder |
This builder for chaining. |