public final class UpdateSpaceRequest extends GeneratedMessageV3 implements UpdateSpaceRequestOrBuilder
A request to update a single space.
Protobuf type google.chat.v1.UpdateSpaceRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
SPACE_FIELD_NUMBER
public static final int SPACE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_MASK_FIELD_NUMBER
public static final int UPDATE_MASK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USE_ADMIN_ACCESS_FIELD_NUMBER
public static final int USE_ADMIN_ACCESS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static UpdateSpaceRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static UpdateSpaceRequest.Builder newBuilder()
newBuilder(UpdateSpaceRequest prototype)
public static UpdateSpaceRequest.Builder newBuilder(UpdateSpaceRequest prototype)
public static UpdateSpaceRequest parseDelimitedFrom(InputStream input)
public static UpdateSpaceRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static UpdateSpaceRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UpdateSpaceRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static UpdateSpaceRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateSpaceRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateSpaceRequest parseFrom(CodedInputStream input)
public static UpdateSpaceRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static UpdateSpaceRequest parseFrom(InputStream input)
public static UpdateSpaceRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static UpdateSpaceRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UpdateSpaceRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<UpdateSpaceRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public UpdateSpaceRequest getDefaultInstanceForType()
getParserForType()
public Parser<UpdateSpaceRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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 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];
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.
|
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];
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public UpdateSpaceRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UpdateSpaceRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public UpdateSpaceRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
