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.
Currently supported field paths:
display_name
(Only supports changing the display name of a space with
the SPACE
type, or when also including the space_type
mask to change a
GROUP_CHAT
space type to SPACE
. Trying to update the display name of a
GROUP_CHAT
or a DIRECT_MESSAGE
space results in an invalid argument
error. If you receive the error message ALREADY_EXISTS
when updating the
displayName
, try a different displayName
. 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 admin access.
space_details
space_history_state
(Supports turning history on or off for the
space if the organization
allows users to change their history
setting.
Warning: mutually exclusive with all other field paths.)
space_history_state
is not supported with admin access.
access_settings.audience
(Supports changing the access
setting of who can
discover the space, join the space, and preview the messages in space. If
no audience is specified in the access setting, the space's access setting
is updated to private. Warning: mutually exclusive with all other field
paths.)
access_settings.audience
is not supported with admin access.
Developer Preview: Supports changing the permission
settings of a space,
supported field paths
include: permission_settings.manage_members_and_groups
,
permission_settings.modify_space_details
,
permission_settings.toggle_history
,
permission_settings.use_at_mention_all
,
permission_settings.manage_apps
, permission_settings.manage_webhooks
,
permission_settings.reply_messages
(Warning: mutually exclusive with all other non-permission settings field
paths). permission_settings
is not supported with admin access.
.google.protobuf.FieldMask update_mask = 2;
Returns |
Type |
Description |
FieldMask |
The updateMask.
|
getUpdateMaskOrBuilder()
public FieldMaskOrBuilder getUpdateMaskOrBuilder()
Required. The updated field paths, comma separated if there are
multiple.
Currently supported field paths:
display_name
(Only supports changing the display name of a space with
the SPACE
type, or when also including the space_type
mask to change a
GROUP_CHAT
space type to SPACE
. Trying to update the display name of a
GROUP_CHAT
or a DIRECT_MESSAGE
space results in an invalid argument
error. If you receive the error message ALREADY_EXISTS
when updating the
displayName
, try a different displayName
. 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 admin access.
space_details
space_history_state
(Supports turning history on or off for the
space if the organization
allows users to change their history
setting.
Warning: mutually exclusive with all other field paths.)
space_history_state
is not supported with admin access.
access_settings.audience
(Supports changing the access
setting of who can
discover the space, join the space, and preview the messages in space. If
no audience is specified in the access setting, the space's access setting
is updated to private. Warning: mutually exclusive with all other field
paths.)
access_settings.audience
is not supported with admin access.
Developer Preview: Supports changing the permission
settings of a space,
supported field paths
include: permission_settings.manage_members_and_groups
,
permission_settings.modify_space_details
,
permission_settings.toggle_history
,
permission_settings.use_at_mention_all
,
permission_settings.manage_apps
, permission_settings.manage_webhooks
,
permission_settings.reply_messages
(Warning: mutually exclusive with all other non-permission settings field
paths). permission_settings
is not supported with admin access.
.google.protobuf.FieldMask update_mask = 2;
getUseAdminAccess()
public boolean getUseAdminAccess()
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;
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.
Currently supported field paths:
display_name
(Only supports changing the display name of a space with
the SPACE
type, or when also including the space_type
mask to change a
GROUP_CHAT
space type to SPACE
. Trying to update the display name of a
GROUP_CHAT
or a DIRECT_MESSAGE
space results in an invalid argument
error. If you receive the error message ALREADY_EXISTS
when updating the
displayName
, try a different displayName
. 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 admin access.
space_details
space_history_state
(Supports turning history on or off for the
space if the organization
allows users to change their history
setting.
Warning: mutually exclusive with all other field paths.)
space_history_state
is not supported with admin access.
access_settings.audience
(Supports changing the access
setting of who can
discover the space, join the space, and preview the messages in space. If
no audience is specified in the access setting, the space's access setting
is updated to private. Warning: mutually exclusive with all other field
paths.)
access_settings.audience
is not supported with admin access.
Developer Preview: Supports changing the permission
settings of a space,
supported field paths
include: permission_settings.manage_members_and_groups
,
permission_settings.modify_space_details
,
permission_settings.toggle_history
,
permission_settings.use_at_mention_all
,
permission_settings.manage_apps
, permission_settings.manage_webhooks
,
permission_settings.reply_messages
(Warning: mutually exclusive with all other non-permission settings field
paths). permission_settings
is not supported with admin access.
.google.protobuf.FieldMask update_mask = 2;
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